{ "openapi": "3.0.4", "info": { "title": "X-ERP API", "description": "Reference for the existing X-ERP API, including administrative and application-specific operations. Authenticate with POST /api/WebApiUser/WebApiLogin and retain the X-ERPAppAuthCookie cookie. Availability depends on the deployment, account and company. The document identifier v1 is not a URL version or a compatibility guarantee. Actions without an explicit HTTP method and vendor/browser protocols are inventoried separately in Endpoint-Reference.md and coverage.json.", "version": "v1" }, "servers": [ { "url": "/", "description": "Deployment root; use the actual HTTPS application base URL, including any virtual directory." } ], "paths": { "/api/AdminApiAuthType": { "get": { "tags": [ "AdminApiAuthType" ], "summary": "AdminApiAuthType: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminApiAuthType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminApiAuthType_GetAll_0A3AD48F49AD", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminApiAuthType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminApiAuthType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminApiAuthType" } } } } } }, "post": { "tags": [ "AdminApiAuthType" ], "summary": "AdminApiAuthType: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminApiAuthType-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminApiAuthType_Post_B723B906C069", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminApiAuthType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminApiAuthType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminApiAuthType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminApiAuthType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminApiAuthType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminApiAuthType" } } } } } }, "put": { "tags": [ "AdminApiAuthType" ], "summary": "AdminApiAuthType: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminApiAuthType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminApiAuthType_Put_55358544F6FE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminApiAuthType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminApiAuthType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminApiAuthType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminApiAuthType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminApiAuthType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminApiAuthType" } } } } } } }, "/api/AdminApiAuthType/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "AdminApiAuthType" ], "summary": "AdminApiAuthType: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminApiAuthType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminApiAuthType_GetPageByValue_CA8481A91774", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AdminApiAuthType/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "AdminApiAuthType" ], "summary": "AdminApiAuthType: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminApiAuthType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminApiAuthType_GetPageByValue2_15EB46074AD0", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AdminApiAuthType/DeleteByFilter": { "post": { "tags": [ "AdminApiAuthType" ], "summary": "AdminApiAuthType: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminApiAuthType-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminApiAuthType_DeleteByFilter_B71BA7E29891", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/AdminApiAuthType/GetAllByValue": { "post": { "tags": [ "AdminApiAuthType" ], "summary": "AdminApiAuthType: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminApiAuthType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminApiAuthType_GetAllByValue_57430E160C70", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminApiAuthType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminApiAuthType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminApiAuthType" } } } } } } }, "/api/AdminApiAuthType/GetAllGraphByValue": { "post": { "tags": [ "AdminApiAuthType" ], "summary": "AdminApiAuthType: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminApiAuthType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminApiAuthType_GetAllGraphByValue_95AF801CF93B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminApiAuthType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminApiAuthType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminApiAuthType" } } } } } } }, "/api/AdminApiAuthType/GetByValue": { "post": { "tags": [ "AdminApiAuthType" ], "summary": "AdminApiAuthType: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminApiAuthType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminApiAuthType_GetByValue_0AB3E4619AB2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminApiAuthType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminApiAuthType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminApiAuthType" } } } } } } }, "/api/AdminApiAuthType/GetLookup": { "post": { "tags": [ "AdminApiAuthType" ], "summary": "AdminApiAuthType: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminApiAuthType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminApiAuthType_GetLookup_7753690F7DBB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/AdminApiAuthType/GetLookupByValue": { "post": { "tags": [ "AdminApiAuthType" ], "summary": "AdminApiAuthType: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminApiAuthType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminApiAuthType_GetLookupByValue_3FEAB6B2EF83", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/AdminApiAuthType/Page": { "get": { "tags": [ "AdminApiAuthType" ], "summary": "AdminApiAuthType: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminApiAuthType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminApiAuthType_GetPage_9CD482C8C1DE", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AdminApiAuthType/PageAsc": { "get": { "tags": [ "AdminApiAuthType" ], "summary": "AdminApiAuthType: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminApiAuthType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminApiAuthType_GetPageAsc_EE53AF8C02DE", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AdminApiAuthType/SearchByValue": { "post": { "tags": [ "AdminApiAuthType" ], "summary": "AdminApiAuthType: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminApiAuthType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminApiAuthType_SearchByValue_D77FE71CA24F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AdminApiAuthType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AdminApiAuthType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AdminApiAuthType" } } } } } } }, "/api/AdminApiAuthType/TryGetByValue": { "post": { "tags": [ "AdminApiAuthType" ], "summary": "AdminApiAuthType: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminApiAuthType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminApiAuthType_TryGetByValue_136BC1BF3C3C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminApiAuthType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminApiAuthType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminApiAuthType" } } } } } } }, "/api/AdminApiAuthType/UpsertGraph": { "put": { "tags": [ "AdminApiAuthType" ], "summary": "AdminApiAuthType: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminApiAuthType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminApiAuthType_UpsertGraph_51F8D22D6211", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminApiAuthType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminApiAuthType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminApiAuthType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminApiAuthType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminApiAuthType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminApiAuthType" } } } } } } }, "/api/AdminApiAuthType/UpsertGraphWithExtraFields": { "put": { "tags": [ "AdminApiAuthType" ], "summary": "AdminApiAuthType: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminApiAuthType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminApiAuthType_UpsertGraphWithExtraFields_0923D50F2744", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminApiAuthType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminApiAuthType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminApiAuthType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminApiAuthType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminApiAuthType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminApiAuthType" } } } } } } }, "/api/AdminBank": { "get": { "tags": [ "AdminBank" ], "summary": "AdminBank: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminBank-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminBank_GetAll_2B41FAE7CE08", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminBank" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminBank" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminBank" } } } } } }, "post": { "tags": [ "AdminBank" ], "summary": "AdminBank: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminBank-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminBank_Post_107B65FCD205", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminBank" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminBank" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminBank" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminBank" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminBank" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminBank" } } } } } }, "put": { "tags": [ "AdminBank" ], "summary": "AdminBank: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminBank-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminBank_Put_DACD6AB9AA83", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminBank" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminBank" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminBank" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminBank" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminBank" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminBank" } } } } } } }, "/api/AdminBank/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "AdminBank" ], "summary": "AdminBank: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminBank-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminBank_GetPageByValue_363F3F4F0347", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AdminBank/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "AdminBank" ], "summary": "AdminBank: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminBank-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminBank_GetPageByValue2_7B99913C9EF0", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AdminBank/DeleteByFilter": { "post": { "tags": [ "AdminBank" ], "summary": "AdminBank: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminBank-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminBank_DeleteByFilter_BF53F05702F7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/AdminBank/GetAllByValue": { "post": { "tags": [ "AdminBank" ], "summary": "AdminBank: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminBank-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminBank_GetAllByValue_C8998B08F50F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminBank" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminBank" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminBank" } } } } } } }, "/api/AdminBank/GetAllGraphByValue": { "post": { "tags": [ "AdminBank" ], "summary": "AdminBank: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminBank-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminBank_GetAllGraphByValue_43009BB46C39", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminBank" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminBank" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminBank" } } } } } } }, "/api/AdminBank/GetByValue": { "post": { "tags": [ "AdminBank" ], "summary": "AdminBank: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminBank-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminBank_GetByValue_BC3A7B000915", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminBank" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminBank" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminBank" } } } } } } }, "/api/AdminBank/GetLookup": { "post": { "tags": [ "AdminBank" ], "summary": "AdminBank: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminBank-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminBank_GetLookup_14EE0C041C05", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/AdminBank/GetLookupByValue": { "post": { "tags": [ "AdminBank" ], "summary": "AdminBank: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminBank-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminBank_GetLookupByValue_4874E5A04919", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/AdminBank/Page": { "get": { "tags": [ "AdminBank" ], "summary": "AdminBank: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminBank-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminBank_GetPage_0E914128EDB0", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AdminBank/PageAsc": { "get": { "tags": [ "AdminBank" ], "summary": "AdminBank: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminBank-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminBank_GetPageAsc_74F92ACF9748", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AdminBank/SearchByValue": { "post": { "tags": [ "AdminBank" ], "summary": "AdminBank: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminBank-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminBank_SearchByValue_59202CA9ADAD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AdminBank" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AdminBank" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AdminBank" } } } } } } }, "/api/AdminBank/TryGetByValue": { "post": { "tags": [ "AdminBank" ], "summary": "AdminBank: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminBank-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminBank_TryGetByValue_A796ED488105", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminBank" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminBank" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminBank" } } } } } } }, "/api/AdminBank/UpsertGraph": { "put": { "tags": [ "AdminBank" ], "summary": "AdminBank: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminBank-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminBank_UpsertGraph_BED1C4B6A0F0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminBank" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminBank" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminBank" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminBank" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminBank" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminBank" } } } } } } }, "/api/AdminBank/UpsertGraphWithExtraFields": { "put": { "tags": [ "AdminBank" ], "summary": "AdminBank: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminBank-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminBank_UpsertGraphWithExtraFields_70739DC24240", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminBank" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminBank" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminBank" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminBank" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminBank" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminBank" } } } } } } }, "/api/AdminBankAccountEBankingType": { "get": { "tags": [ "AdminBankAccountEBankingType" ], "summary": "AdminBankAccountEBankingType: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminBankAccountEBankingType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminBankAccountEBankingType_GetAll_C5A464AEA980", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminBankAccountEBankingType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminBankAccountEBankingType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminBankAccountEBankingType" } } } } } }, "post": { "tags": [ "AdminBankAccountEBankingType" ], "summary": "AdminBankAccountEBankingType: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminBankAccountEBankingType-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminBankAccountEBankingType_Post_5F5B1F6AEA1F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminBankAccountEBankingType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminBankAccountEBankingType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminBankAccountEBankingType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminBankAccountEBankingType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminBankAccountEBankingType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminBankAccountEBankingType" } } } } } }, "put": { "tags": [ "AdminBankAccountEBankingType" ], "summary": "AdminBankAccountEBankingType: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminBankAccountEBankingType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminBankAccountEBankingType_Put_0163FBF03862", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminBankAccountEBankingType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminBankAccountEBankingType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminBankAccountEBankingType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminBankAccountEBankingType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminBankAccountEBankingType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminBankAccountEBankingType" } } } } } } }, "/api/AdminBankAccountEBankingType/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "AdminBankAccountEBankingType" ], "summary": "AdminBankAccountEBankingType: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminBankAccountEBankingType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminBankAccountEBankingType_GetPageByValue_AF8E3B00B8AC", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AdminBankAccountEBankingType/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "AdminBankAccountEBankingType" ], "summary": "AdminBankAccountEBankingType: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminBankAccountEBankingType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminBankAccountEBankingType_GetPageByValue2_241B0225A1E9", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AdminBankAccountEBankingType/DeleteByFilter": { "post": { "tags": [ "AdminBankAccountEBankingType" ], "summary": "AdminBankAccountEBankingType: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminBankAccountEBankingType-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminBankAccountEBankingType_DeleteByFilter_863D1135FB33", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/AdminBankAccountEBankingType/GetAllByValue": { "post": { "tags": [ "AdminBankAccountEBankingType" ], "summary": "AdminBankAccountEBankingType: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminBankAccountEBankingType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminBankAccountEBankingType_GetAllByValue_147F55DC8BCE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminBankAccountEBankingType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminBankAccountEBankingType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminBankAccountEBankingType" } } } } } } }, "/api/AdminBankAccountEBankingType/GetAllGraphByValue": { "post": { "tags": [ "AdminBankAccountEBankingType" ], "summary": "AdminBankAccountEBankingType: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminBankAccountEBankingType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminBankAccountEBankingType_GetAllGraphByValue_7F164D6D5AE7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminBankAccountEBankingType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminBankAccountEBankingType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminBankAccountEBankingType" } } } } } } }, "/api/AdminBankAccountEBankingType/GetByValue": { "post": { "tags": [ "AdminBankAccountEBankingType" ], "summary": "AdminBankAccountEBankingType: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminBankAccountEBankingType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminBankAccountEBankingType_GetByValue_E35A971F816F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminBankAccountEBankingType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminBankAccountEBankingType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminBankAccountEBankingType" } } } } } } }, "/api/AdminBankAccountEBankingType/GetLookup": { "post": { "tags": [ "AdminBankAccountEBankingType" ], "summary": "AdminBankAccountEBankingType: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminBankAccountEBankingType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminBankAccountEBankingType_GetLookup_7E4EBD3C230A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/AdminBankAccountEBankingType/GetLookupByValue": { "post": { "tags": [ "AdminBankAccountEBankingType" ], "summary": "AdminBankAccountEBankingType: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminBankAccountEBankingType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminBankAccountEBankingType_GetLookupByValue_DDA2151A277D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/AdminBankAccountEBankingType/Page": { "get": { "tags": [ "AdminBankAccountEBankingType" ], "summary": "AdminBankAccountEBankingType: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminBankAccountEBankingType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminBankAccountEBankingType_GetPage_F797BCC33928", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AdminBankAccountEBankingType/PageAsc": { "get": { "tags": [ "AdminBankAccountEBankingType" ], "summary": "AdminBankAccountEBankingType: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminBankAccountEBankingType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminBankAccountEBankingType_GetPageAsc_799EABE93BF5", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AdminBankAccountEBankingType/SearchByValue": { "post": { "tags": [ "AdminBankAccountEBankingType" ], "summary": "AdminBankAccountEBankingType: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminBankAccountEBankingType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminBankAccountEBankingType_SearchByValue_2054E435ABB8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AdminBankAccountEBankingType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AdminBankAccountEBankingType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AdminBankAccountEBankingType" } } } } } } }, "/api/AdminBankAccountEBankingType/TryGetByValue": { "post": { "tags": [ "AdminBankAccountEBankingType" ], "summary": "AdminBankAccountEBankingType: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminBankAccountEBankingType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminBankAccountEBankingType_TryGetByValue_C007DC8D035E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminBankAccountEBankingType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminBankAccountEBankingType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminBankAccountEBankingType" } } } } } } }, "/api/AdminBankAccountEBankingType/UpsertGraph": { "put": { "tags": [ "AdminBankAccountEBankingType" ], "summary": "AdminBankAccountEBankingType: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminBankAccountEBankingType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminBankAccountEBankingType_UpsertGraph_5C5DBC13AC80", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminBankAccountEBankingType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminBankAccountEBankingType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminBankAccountEBankingType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminBankAccountEBankingType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminBankAccountEBankingType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminBankAccountEBankingType" } } } } } } }, "/api/AdminBankAccountEBankingType/UpsertGraphWithExtraFields": { "put": { "tags": [ "AdminBankAccountEBankingType" ], "summary": "AdminBankAccountEBankingType: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminBankAccountEBankingType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminBankAccountEBankingType_UpsertGraphWithExtraFields_F3ED8ACA827C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminBankAccountEBankingType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminBankAccountEBankingType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminBankAccountEBankingType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminBankAccountEBankingType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminBankAccountEBankingType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminBankAccountEBankingType" } } } } } } }, "/api/AdminCompanySetting": { "get": { "tags": [ "AdminCompanySetting" ], "summary": "AdminCompanySetting: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminCompanySetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminCompanySetting_GetAll_B88D3DDE3CCE", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminCompanySetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminCompanySetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminCompanySetting" } } } } } }, "post": { "tags": [ "AdminCompanySetting" ], "summary": "AdminCompanySetting: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminCompanySetting-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminCompanySetting_Post_215F866F4D1A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCompanySetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCompanySetting" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCompanySetting" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminCompanySetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminCompanySetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminCompanySetting" } } } } } }, "put": { "tags": [ "AdminCompanySetting" ], "summary": "AdminCompanySetting: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminCompanySetting-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminCompanySetting_Put_2E31D1B8A570", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCompanySetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCompanySetting" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCompanySetting" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminCompanySetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminCompanySetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminCompanySetting" } } } } } } }, "/api/AdminCompanySetting/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "AdminCompanySetting" ], "summary": "AdminCompanySetting: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminCompanySetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminCompanySetting_GetPageByValue_0D3021AF9A44", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AdminCompanySetting/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "AdminCompanySetting" ], "summary": "AdminCompanySetting: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminCompanySetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminCompanySetting_GetPageByValue2_CC039B7D1C36", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AdminCompanySetting/DeleteByFilter": { "post": { "tags": [ "AdminCompanySetting" ], "summary": "AdminCompanySetting: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminCompanySetting-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminCompanySetting_DeleteByFilter_CBA50DF54E64", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/AdminCompanySetting/GetAllByValue": { "post": { "tags": [ "AdminCompanySetting" ], "summary": "AdminCompanySetting: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminCompanySetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminCompanySetting_GetAllByValue_A5F94DC40AF3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminCompanySetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminCompanySetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminCompanySetting" } } } } } } }, "/api/AdminCompanySetting/GetAllGraphByValue": { "post": { "tags": [ "AdminCompanySetting" ], "summary": "AdminCompanySetting: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminCompanySetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminCompanySetting_GetAllGraphByValue_F5DB381BE45E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminCompanySetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminCompanySetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminCompanySetting" } } } } } } }, "/api/AdminCompanySetting/GetByValue": { "post": { "tags": [ "AdminCompanySetting" ], "summary": "AdminCompanySetting: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminCompanySetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminCompanySetting_GetByValue_BE1F0ADD546A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminCompanySetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminCompanySetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminCompanySetting" } } } } } } }, "/api/AdminCompanySetting/GetLookup": { "post": { "tags": [ "AdminCompanySetting" ], "summary": "AdminCompanySetting: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminCompanySetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminCompanySetting_GetLookup_FE2AE1484C9B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/AdminCompanySetting/GetLookupByValue": { "post": { "tags": [ "AdminCompanySetting" ], "summary": "AdminCompanySetting: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminCompanySetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminCompanySetting_GetLookupByValue_12541A6F9652", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/AdminCompanySetting/Page": { "get": { "tags": [ "AdminCompanySetting" ], "summary": "AdminCompanySetting: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminCompanySetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminCompanySetting_GetPage_DEC470F600FE", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AdminCompanySetting/PageAsc": { "get": { "tags": [ "AdminCompanySetting" ], "summary": "AdminCompanySetting: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminCompanySetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminCompanySetting_GetPageAsc_7EFA7D4AC62A", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AdminCompanySetting/SearchByValue": { "post": { "tags": [ "AdminCompanySetting" ], "summary": "AdminCompanySetting: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminCompanySetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminCompanySetting_SearchByValue_DDBC6D2269AA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AdminCompanySetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AdminCompanySetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AdminCompanySetting" } } } } } } }, "/api/AdminCompanySetting/TryGetByValue": { "post": { "tags": [ "AdminCompanySetting" ], "summary": "AdminCompanySetting: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminCompanySetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminCompanySetting_TryGetByValue_C96296F7743F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminCompanySetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminCompanySetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminCompanySetting" } } } } } } }, "/api/AdminCompanySetting/UpsertGraph": { "put": { "tags": [ "AdminCompanySetting" ], "summary": "AdminCompanySetting: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminCompanySetting-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminCompanySetting_UpsertGraph_0DF65BCA324A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCompanySetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCompanySetting" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCompanySetting" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminCompanySetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminCompanySetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminCompanySetting" } } } } } } }, "/api/AdminCompanySetting/UpsertGraphWithExtraFields": { "put": { "tags": [ "AdminCompanySetting" ], "summary": "AdminCompanySetting: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminCompanySetting-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminCompanySetting_UpsertGraphWithExtraFields_A795FA796AAB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminCompanySetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminCompanySetting" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminCompanySetting" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminCompanySetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminCompanySetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminCompanySetting" } } } } } } }, "/api/AdminCountry": { "get": { "tags": [ "AdminCountry" ], "summary": "AdminCountry: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminCountry-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminCountry_GetAll_8C02705F1E0D", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminCountry" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminCountry" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminCountry" } } } } } }, "post": { "tags": [ "AdminCountry" ], "summary": "AdminCountry: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminCountry-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminCountry_Post_F2690E00FC6C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCountry" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCountry" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCountry" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminCountry" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminCountry" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminCountry" } } } } } }, "put": { "tags": [ "AdminCountry" ], "summary": "AdminCountry: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminCountry-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminCountry_Put_25A8C9D7AD42", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCountry" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCountry" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCountry" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminCountry" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminCountry" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminCountry" } } } } } } }, "/api/AdminCountry/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "AdminCountry" ], "summary": "AdminCountry: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminCountry-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminCountry_GetPageByValue_8C72E67D6A05", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AdminCountry/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "AdminCountry" ], "summary": "AdminCountry: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminCountry-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminCountry_GetPageByValue2_1F612DB51098", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AdminCountry/DeleteByFilter": { "post": { "tags": [ "AdminCountry" ], "summary": "AdminCountry: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminCountry-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminCountry_DeleteByFilter_778EC447CF7A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/AdminCountry/GetAllByValue": { "post": { "tags": [ "AdminCountry" ], "summary": "AdminCountry: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminCountry-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminCountry_GetAllByValue_39EF16824B48", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminCountry" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminCountry" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminCountry" } } } } } } }, "/api/AdminCountry/GetAllGraphByValue": { "post": { "tags": [ "AdminCountry" ], "summary": "AdminCountry: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminCountry-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminCountry_GetAllGraphByValue_148D4B0A8567", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminCountry" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminCountry" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminCountry" } } } } } } }, "/api/AdminCountry/GetByValue": { "post": { "tags": [ "AdminCountry" ], "summary": "AdminCountry: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminCountry-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminCountry_GetByValue_69CAB30DBE22", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminCountry" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminCountry" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminCountry" } } } } } } }, "/api/AdminCountry/GetLookup": { "post": { "tags": [ "AdminCountry" ], "summary": "AdminCountry: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminCountry-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminCountry_GetLookup_949C353D1C39", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/AdminCountry/GetLookupByValue": { "post": { "tags": [ "AdminCountry" ], "summary": "AdminCountry: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminCountry-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminCountry_GetLookupByValue_DAB95AE4C24E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/AdminCountry/Page": { "get": { "tags": [ "AdminCountry" ], "summary": "AdminCountry: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminCountry-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminCountry_GetPage_357D4336E7D0", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AdminCountry/PageAsc": { "get": { "tags": [ "AdminCountry" ], "summary": "AdminCountry: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminCountry-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminCountry_GetPageAsc_3D145B9B3842", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AdminCountry/SearchByValue": { "post": { "tags": [ "AdminCountry" ], "summary": "AdminCountry: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminCountry-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminCountry_SearchByValue_F49A3E2B1181", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AdminCountry" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AdminCountry" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AdminCountry" } } } } } } }, "/api/AdminCountry/TryGetByValue": { "post": { "tags": [ "AdminCountry" ], "summary": "AdminCountry: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminCountry-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminCountry_TryGetByValue_44A9FFEA4450", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminCountry" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminCountry" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminCountry" } } } } } } }, "/api/AdminCountry/UpsertGraph": { "put": { "tags": [ "AdminCountry" ], "summary": "AdminCountry: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminCountry-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminCountry_UpsertGraph_D9DE095C475D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCountry" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCountry" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCountry" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminCountry" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminCountry" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminCountry" } } } } } } }, "/api/AdminCountry/UpsertGraphWithExtraFields": { "put": { "tags": [ "AdminCountry" ], "summary": "AdminCountry: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminCountry-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminCountry_UpsertGraphWithExtraFields_7AB0468A9D42", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminCountry" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminCountry" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminCountry" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminCountry" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminCountry" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminCountry" } } } } } } }, "/api/AdminCurrency": { "get": { "tags": [ "AdminCurrency" ], "summary": "AdminCurrency: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminCurrency-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminCurrency_GetAll_1313AB289378", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminCurrency" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminCurrency" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminCurrency" } } } } } }, "post": { "tags": [ "AdminCurrency" ], "summary": "AdminCurrency: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminCurrency-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminCurrency_Post_C42DC1499792", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCurrency" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCurrency" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCurrency" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminCurrency" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminCurrency" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminCurrency" } } } } } }, "put": { "tags": [ "AdminCurrency" ], "summary": "AdminCurrency: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminCurrency-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminCurrency_Put_3F12CE87F024", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCurrency" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCurrency" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCurrency" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminCurrency" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminCurrency" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminCurrency" } } } } } } }, "/api/AdminCurrency/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "AdminCurrency" ], "summary": "AdminCurrency: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminCurrency-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminCurrency_GetPageByValue_0ABF0E1930AE", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AdminCurrency/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "AdminCurrency" ], "summary": "AdminCurrency: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminCurrency-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminCurrency_GetPageByValue2_BDF513CBFB78", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AdminCurrency/DeleteByFilter": { "post": { "tags": [ "AdminCurrency" ], "summary": "AdminCurrency: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminCurrency-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminCurrency_DeleteByFilter_CFCA94F45BC1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/AdminCurrency/GetAllByValue": { "post": { "tags": [ "AdminCurrency" ], "summary": "AdminCurrency: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminCurrency-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminCurrency_GetAllByValue_D81A353003DB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminCurrency" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminCurrency" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminCurrency" } } } } } } }, "/api/AdminCurrency/GetAllGraphByValue": { "post": { "tags": [ "AdminCurrency" ], "summary": "AdminCurrency: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminCurrency-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminCurrency_GetAllGraphByValue_D7E0186D8D9C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminCurrency" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminCurrency" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminCurrency" } } } } } } }, "/api/AdminCurrency/GetByValue": { "post": { "tags": [ "AdminCurrency" ], "summary": "AdminCurrency: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminCurrency-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminCurrency_GetByValue_6E18ABF69A62", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminCurrency" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminCurrency" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminCurrency" } } } } } } }, "/api/AdminCurrency/GetLookup": { "post": { "tags": [ "AdminCurrency" ], "summary": "AdminCurrency: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminCurrency-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminCurrency_GetLookup_DC2756A282DC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/AdminCurrency/GetLookupByValue": { "post": { "tags": [ "AdminCurrency" ], "summary": "AdminCurrency: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminCurrency-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminCurrency_GetLookupByValue_D2D38C4CE6AF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/AdminCurrency/Page": { "get": { "tags": [ "AdminCurrency" ], "summary": "AdminCurrency: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminCurrency-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminCurrency_GetPage_459D167359F2", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AdminCurrency/PageAsc": { "get": { "tags": [ "AdminCurrency" ], "summary": "AdminCurrency: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminCurrency-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminCurrency_GetPageAsc_A6BC0B23D730", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AdminCurrency/SearchByValue": { "post": { "tags": [ "AdminCurrency" ], "summary": "AdminCurrency: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminCurrency-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminCurrency_SearchByValue_D872D416C654", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AdminCurrency" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AdminCurrency" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AdminCurrency" } } } } } } }, "/api/AdminCurrency/TryGetByValue": { "post": { "tags": [ "AdminCurrency" ], "summary": "AdminCurrency: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminCurrency-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminCurrency_TryGetByValue_B8FE701C22B7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminCurrency" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminCurrency" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminCurrency" } } } } } } }, "/api/AdminCurrency/UpsertGraph": { "put": { "tags": [ "AdminCurrency" ], "summary": "AdminCurrency: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminCurrency-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminCurrency_UpsertGraph_85101375223D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCurrency" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCurrency" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCurrency" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminCurrency" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminCurrency" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminCurrency" } } } } } } }, "/api/AdminCurrency/UpsertGraphWithExtraFields": { "put": { "tags": [ "AdminCurrency" ], "summary": "AdminCurrency: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminCurrency-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminCurrency_UpsertGraphWithExtraFields_B681772FA970", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminCurrency" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminCurrency" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminCurrency" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminCurrency" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminCurrency" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminCurrency" } } } } } } }, "/api/AdminCurrencyApi": { "get": { "tags": [ "AdminCurrencyApi" ], "summary": "AdminCurrencyApi: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminCurrencyApi-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminCurrencyApi_GetAll_47C28F588C10", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminCurrencyApi" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminCurrencyApi" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminCurrencyApi" } } } } } }, "post": { "tags": [ "AdminCurrencyApi" ], "summary": "AdminCurrencyApi: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminCurrencyApi-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminCurrencyApi_Post_1817F6C42B2F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCurrencyApi" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCurrencyApi" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCurrencyApi" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminCurrencyApi" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminCurrencyApi" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminCurrencyApi" } } } } } }, "put": { "tags": [ "AdminCurrencyApi" ], "summary": "AdminCurrencyApi: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminCurrencyApi-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminCurrencyApi_Put_F15FAFE8AE03", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCurrencyApi" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCurrencyApi" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCurrencyApi" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminCurrencyApi" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminCurrencyApi" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminCurrencyApi" } } } } } } }, "/api/AdminCurrencyApi/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "AdminCurrencyApi" ], "summary": "AdminCurrencyApi: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminCurrencyApi-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminCurrencyApi_GetPageByValue_7379C7C7004A", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AdminCurrencyApi/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "AdminCurrencyApi" ], "summary": "AdminCurrencyApi: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminCurrencyApi-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminCurrencyApi_GetPageByValue2_6BCA2FC41B5B", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AdminCurrencyApi/DeleteByFilter": { "post": { "tags": [ "AdminCurrencyApi" ], "summary": "AdminCurrencyApi: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminCurrencyApi-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminCurrencyApi_DeleteByFilter_B1C4B5B000CD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/AdminCurrencyApi/GetAllByValue": { "post": { "tags": [ "AdminCurrencyApi" ], "summary": "AdminCurrencyApi: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminCurrencyApi-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminCurrencyApi_GetAllByValue_C916450DFA43", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminCurrencyApi" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminCurrencyApi" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminCurrencyApi" } } } } } } }, "/api/AdminCurrencyApi/GetAllGraphByValue": { "post": { "tags": [ "AdminCurrencyApi" ], "summary": "AdminCurrencyApi: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminCurrencyApi-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminCurrencyApi_GetAllGraphByValue_B4A63BED1B2E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminCurrencyApi" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminCurrencyApi" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminCurrencyApi" } } } } } } }, "/api/AdminCurrencyApi/GetByValue": { "post": { "tags": [ "AdminCurrencyApi" ], "summary": "AdminCurrencyApi: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminCurrencyApi-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminCurrencyApi_GetByValue_545310A2A8CB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminCurrencyApi" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminCurrencyApi" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminCurrencyApi" } } } } } } }, "/api/AdminCurrencyApi/GetLookup": { "post": { "tags": [ "AdminCurrencyApi" ], "summary": "AdminCurrencyApi: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminCurrencyApi-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminCurrencyApi_GetLookup_6E477BF61137", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/AdminCurrencyApi/GetLookupByValue": { "post": { "tags": [ "AdminCurrencyApi" ], "summary": "AdminCurrencyApi: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminCurrencyApi-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminCurrencyApi_GetLookupByValue_2C06FB6C95FB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/AdminCurrencyApi/Page": { "get": { "tags": [ "AdminCurrencyApi" ], "summary": "AdminCurrencyApi: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminCurrencyApi-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminCurrencyApi_GetPage_B7893D043FEF", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AdminCurrencyApi/PageAsc": { "get": { "tags": [ "AdminCurrencyApi" ], "summary": "AdminCurrencyApi: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminCurrencyApi-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminCurrencyApi_GetPageAsc_D3A411F38F37", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AdminCurrencyApi/SearchByValue": { "post": { "tags": [ "AdminCurrencyApi" ], "summary": "AdminCurrencyApi: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminCurrencyApi-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminCurrencyApi_SearchByValue_887805890517", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AdminCurrencyApi" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AdminCurrencyApi" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AdminCurrencyApi" } } } } } } }, "/api/AdminCurrencyApi/SyncCurrencyRates": { "get": { "tags": [ "AdminCurrencyApi" ], "summary": "AdminCurrencyApi: SyncCurrencyRates", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminCurrencyApi-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminCurrencyApi_SyncCurrencyRates_E85552343AFA", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/AdminCurrencyApi/TryGetByValue": { "post": { "tags": [ "AdminCurrencyApi" ], "summary": "AdminCurrencyApi: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminCurrencyApi-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminCurrencyApi_TryGetByValue_EEDD5C84EB9F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminCurrencyApi" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminCurrencyApi" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminCurrencyApi" } } } } } } }, "/api/AdminCurrencyApi/UpsertGraph": { "put": { "tags": [ "AdminCurrencyApi" ], "summary": "AdminCurrencyApi: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminCurrencyApi-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminCurrencyApi_UpsertGraph_9ACA9E94401E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCurrencyApi" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCurrencyApi" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCurrencyApi" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminCurrencyApi" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminCurrencyApi" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminCurrencyApi" } } } } } } }, "/api/AdminCurrencyApi/UpsertGraphWithExtraFields": { "put": { "tags": [ "AdminCurrencyApi" ], "summary": "AdminCurrencyApi: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminCurrencyApi-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminCurrencyApi_UpsertGraphWithExtraFields_08101BD3D54C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminCurrencyApi" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminCurrencyApi" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminCurrencyApi" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminCurrencyApi" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminCurrencyApi" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminCurrencyApi" } } } } } } }, "/api/AdminCurrencyRate": { "get": { "tags": [ "AdminCurrencyRate" ], "summary": "AdminCurrencyRate: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminCurrencyRate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminCurrencyRate_GetAll_C54A6B90781D", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminCurrencyRate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminCurrencyRate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminCurrencyRate" } } } } } }, "post": { "tags": [ "AdminCurrencyRate" ], "summary": "AdminCurrencyRate: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminCurrencyRate-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminCurrencyRate_Post_8B948D9FAE9E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCurrencyRate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCurrencyRate" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCurrencyRate" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminCurrencyRate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminCurrencyRate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminCurrencyRate" } } } } } }, "put": { "tags": [ "AdminCurrencyRate" ], "summary": "AdminCurrencyRate: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminCurrencyRate-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminCurrencyRate_Put_6B6A0996B9F3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCurrencyRate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCurrencyRate" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCurrencyRate" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminCurrencyRate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminCurrencyRate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminCurrencyRate" } } } } } } }, "/api/AdminCurrencyRate/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "AdminCurrencyRate" ], "summary": "AdminCurrencyRate: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminCurrencyRate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminCurrencyRate_GetPageByValue_307D5DF863DC", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AdminCurrencyRate/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "AdminCurrencyRate" ], "summary": "AdminCurrencyRate: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminCurrencyRate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminCurrencyRate_GetPageByValue2_2A7EB6909DED", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AdminCurrencyRate/DeleteByFilter": { "post": { "tags": [ "AdminCurrencyRate" ], "summary": "AdminCurrencyRate: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminCurrencyRate-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminCurrencyRate_DeleteByFilter_3D5CD2604974", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/AdminCurrencyRate/GetAllByValue": { "post": { "tags": [ "AdminCurrencyRate" ], "summary": "AdminCurrencyRate: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminCurrencyRate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminCurrencyRate_GetAllByValue_5BD9BE93ED20", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminCurrencyRate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminCurrencyRate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminCurrencyRate" } } } } } } }, "/api/AdminCurrencyRate/GetAllGraphByValue": { "post": { "tags": [ "AdminCurrencyRate" ], "summary": "AdminCurrencyRate: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminCurrencyRate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminCurrencyRate_GetAllGraphByValue_136C0650EE8D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminCurrencyRate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminCurrencyRate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminCurrencyRate" } } } } } } }, "/api/AdminCurrencyRate/GetByValue": { "post": { "tags": [ "AdminCurrencyRate" ], "summary": "AdminCurrencyRate: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminCurrencyRate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminCurrencyRate_GetByValue_D5E2FD3A3135", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminCurrencyRate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminCurrencyRate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminCurrencyRate" } } } } } } }, "/api/AdminCurrencyRate/GetLookup": { "post": { "tags": [ "AdminCurrencyRate" ], "summary": "AdminCurrencyRate: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminCurrencyRate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminCurrencyRate_GetLookup_717D97AA45C3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/AdminCurrencyRate/GetLookupByValue": { "post": { "tags": [ "AdminCurrencyRate" ], "summary": "AdminCurrencyRate: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminCurrencyRate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminCurrencyRate_GetLookupByValue_8B7B09F4487C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/AdminCurrencyRate/Page": { "get": { "tags": [ "AdminCurrencyRate" ], "summary": "AdminCurrencyRate: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminCurrencyRate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminCurrencyRate_GetPage_63FA27ED3AAC", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AdminCurrencyRate/PageAsc": { "get": { "tags": [ "AdminCurrencyRate" ], "summary": "AdminCurrencyRate: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminCurrencyRate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminCurrencyRate_GetPageAsc_E8162154F343", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AdminCurrencyRate/SearchByValue": { "post": { "tags": [ "AdminCurrencyRate" ], "summary": "AdminCurrencyRate: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminCurrencyRate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminCurrencyRate_SearchByValue_2D44BAA311EC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AdminCurrencyRate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AdminCurrencyRate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AdminCurrencyRate" } } } } } } }, "/api/AdminCurrencyRate/TryGetByValue": { "post": { "tags": [ "AdminCurrencyRate" ], "summary": "AdminCurrencyRate: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminCurrencyRate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminCurrencyRate_TryGetByValue_C70153CF2E1E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminCurrencyRate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminCurrencyRate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminCurrencyRate" } } } } } } }, "/api/AdminCurrencyRate/UpsertGraph": { "put": { "tags": [ "AdminCurrencyRate" ], "summary": "AdminCurrencyRate: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminCurrencyRate-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminCurrencyRate_UpsertGraph_40B869B1F6F0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCurrencyRate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCurrencyRate" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCurrencyRate" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminCurrencyRate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminCurrencyRate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminCurrencyRate" } } } } } } }, "/api/AdminCurrencyRate/UpsertGraphWithExtraFields": { "put": { "tags": [ "AdminCurrencyRate" ], "summary": "AdminCurrencyRate: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminCurrencyRate-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminCurrencyRate_UpsertGraphWithExtraFields_CA89AFEC1606", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminCurrencyRate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminCurrencyRate" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminCurrencyRate" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminCurrencyRate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminCurrencyRate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminCurrencyRate" } } } } } } }, "/api/AdminDecimalPlace": { "get": { "tags": [ "AdminDecimalPlace" ], "summary": "AdminDecimalPlace: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminDecimalPlace-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminDecimalPlace_GetAll_1600D29ECC8E", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminDecimalPlace" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminDecimalPlace" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminDecimalPlace" } } } } } }, "post": { "tags": [ "AdminDecimalPlace" ], "summary": "AdminDecimalPlace: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminDecimalPlace-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminDecimalPlace_Post_3247CEA88CA4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminDecimalPlace" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminDecimalPlace" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminDecimalPlace" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminDecimalPlace" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminDecimalPlace" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminDecimalPlace" } } } } } }, "put": { "tags": [ "AdminDecimalPlace" ], "summary": "AdminDecimalPlace: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminDecimalPlace-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminDecimalPlace_Put_1C99F791C40A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminDecimalPlace" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminDecimalPlace" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminDecimalPlace" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminDecimalPlace" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminDecimalPlace" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminDecimalPlace" } } } } } } }, "/api/AdminDecimalPlace/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "AdminDecimalPlace" ], "summary": "AdminDecimalPlace: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminDecimalPlace-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminDecimalPlace_GetPageByValue_5EE0185F60B7", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AdminDecimalPlace/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "AdminDecimalPlace" ], "summary": "AdminDecimalPlace: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminDecimalPlace-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminDecimalPlace_GetPageByValue2_BD15DEAEA7AB", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AdminDecimalPlace/DeleteByFilter": { "post": { "tags": [ "AdminDecimalPlace" ], "summary": "AdminDecimalPlace: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminDecimalPlace-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminDecimalPlace_DeleteByFilter_5DDE4C4C588C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/AdminDecimalPlace/GetAllByValue": { "post": { "tags": [ "AdminDecimalPlace" ], "summary": "AdminDecimalPlace: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminDecimalPlace-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminDecimalPlace_GetAllByValue_433798A8772D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminDecimalPlace" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminDecimalPlace" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminDecimalPlace" } } } } } } }, "/api/AdminDecimalPlace/GetAllGraphByValue": { "post": { "tags": [ "AdminDecimalPlace" ], "summary": "AdminDecimalPlace: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminDecimalPlace-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminDecimalPlace_GetAllGraphByValue_FE09A01015A0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminDecimalPlace" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminDecimalPlace" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminDecimalPlace" } } } } } } }, "/api/AdminDecimalPlace/GetByValue": { "post": { "tags": [ "AdminDecimalPlace" ], "summary": "AdminDecimalPlace: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminDecimalPlace-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminDecimalPlace_GetByValue_9F08F9E742A0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminDecimalPlace" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminDecimalPlace" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminDecimalPlace" } } } } } } }, "/api/AdminDecimalPlace/GetLookup": { "post": { "tags": [ "AdminDecimalPlace" ], "summary": "AdminDecimalPlace: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminDecimalPlace-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminDecimalPlace_GetLookup_959F4F054C76", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/AdminDecimalPlace/GetLookupByValue": { "post": { "tags": [ "AdminDecimalPlace" ], "summary": "AdminDecimalPlace: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminDecimalPlace-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminDecimalPlace_GetLookupByValue_EFB1C9E3A70B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/AdminDecimalPlace/Page": { "get": { "tags": [ "AdminDecimalPlace" ], "summary": "AdminDecimalPlace: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminDecimalPlace-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminDecimalPlace_GetPage_39975F4E57B5", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AdminDecimalPlace/PageAsc": { "get": { "tags": [ "AdminDecimalPlace" ], "summary": "AdminDecimalPlace: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminDecimalPlace-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminDecimalPlace_GetPageAsc_03344A0A171B", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AdminDecimalPlace/SearchByValue": { "post": { "tags": [ "AdminDecimalPlace" ], "summary": "AdminDecimalPlace: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminDecimalPlace-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminDecimalPlace_SearchByValue_B95D149D6A9A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AdminDecimalPlace" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AdminDecimalPlace" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AdminDecimalPlace" } } } } } } }, "/api/AdminDecimalPlace/TryGetByValue": { "post": { "tags": [ "AdminDecimalPlace" ], "summary": "AdminDecimalPlace: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminDecimalPlace-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminDecimalPlace_TryGetByValue_CE80026ADE2F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminDecimalPlace" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminDecimalPlace" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminDecimalPlace" } } } } } } }, "/api/AdminDecimalPlace/UpsertGraph": { "put": { "tags": [ "AdminDecimalPlace" ], "summary": "AdminDecimalPlace: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminDecimalPlace-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminDecimalPlace_UpsertGraph_7F0C12E0DDE7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminDecimalPlace" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminDecimalPlace" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminDecimalPlace" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminDecimalPlace" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminDecimalPlace" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminDecimalPlace" } } } } } } }, "/api/AdminDecimalPlace/UpsertGraphWithExtraFields": { "put": { "tags": [ "AdminDecimalPlace" ], "summary": "AdminDecimalPlace: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminDecimalPlace-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminDecimalPlace_UpsertGraphWithExtraFields_FE2ED1C3FC9D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminDecimalPlace" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminDecimalPlace" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminDecimalPlace" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminDecimalPlace" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminDecimalPlace" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminDecimalPlace" } } } } } } }, "/api/AdminEDocType": { "get": { "tags": [ "AdminEDocType" ], "summary": "AdminEDocType: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminEDocType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminEDocType_GetAll_303639BB4B73", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminEDocType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminEDocType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminEDocType" } } } } } }, "post": { "tags": [ "AdminEDocType" ], "summary": "AdminEDocType: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminEDocType-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminEDocType_Post_7FDCE221BB81", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminEDocType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminEDocType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminEDocType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminEDocType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminEDocType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminEDocType" } } } } } }, "put": { "tags": [ "AdminEDocType" ], "summary": "AdminEDocType: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminEDocType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminEDocType_Put_ECB13EEC9545", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminEDocType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminEDocType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminEDocType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminEDocType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminEDocType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminEDocType" } } } } } } }, "/api/AdminEDocType/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "AdminEDocType" ], "summary": "AdminEDocType: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminEDocType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminEDocType_GetPageByValue_04D861271585", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AdminEDocType/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "AdminEDocType" ], "summary": "AdminEDocType: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminEDocType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminEDocType_GetPageByValue2_488DEE8F9108", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AdminEDocType/DeleteByFilter": { "post": { "tags": [ "AdminEDocType" ], "summary": "AdminEDocType: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminEDocType-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminEDocType_DeleteByFilter_85BB784674C0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/AdminEDocType/GetAllByValue": { "post": { "tags": [ "AdminEDocType" ], "summary": "AdminEDocType: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminEDocType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminEDocType_GetAllByValue_4FA9E4EC878A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminEDocType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminEDocType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminEDocType" } } } } } } }, "/api/AdminEDocType/GetAllGraphByValue": { "post": { "tags": [ "AdminEDocType" ], "summary": "AdminEDocType: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminEDocType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminEDocType_GetAllGraphByValue_C4322ECD392C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminEDocType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminEDocType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminEDocType" } } } } } } }, "/api/AdminEDocType/GetByValue": { "post": { "tags": [ "AdminEDocType" ], "summary": "AdminEDocType: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminEDocType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminEDocType_GetByValue_70EDFA844EFD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminEDocType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminEDocType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminEDocType" } } } } } } }, "/api/AdminEDocType/GetLookup": { "post": { "tags": [ "AdminEDocType" ], "summary": "AdminEDocType: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminEDocType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminEDocType_GetLookup_83CD6DC18704", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/AdminEDocType/GetLookupByValue": { "post": { "tags": [ "AdminEDocType" ], "summary": "AdminEDocType: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminEDocType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminEDocType_GetLookupByValue_7279E83555EE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/AdminEDocType/Page": { "get": { "tags": [ "AdminEDocType" ], "summary": "AdminEDocType: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminEDocType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminEDocType_GetPage_1B7C21F0DCA1", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AdminEDocType/PageAsc": { "get": { "tags": [ "AdminEDocType" ], "summary": "AdminEDocType: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminEDocType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminEDocType_GetPageAsc_B198E0F9DCBD", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AdminEDocType/SearchByValue": { "post": { "tags": [ "AdminEDocType" ], "summary": "AdminEDocType: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminEDocType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminEDocType_SearchByValue_3315D1F734B1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AdminEDocType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AdminEDocType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AdminEDocType" } } } } } } }, "/api/AdminEDocType/TryGetByValue": { "post": { "tags": [ "AdminEDocType" ], "summary": "AdminEDocType: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminEDocType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminEDocType_TryGetByValue_8968878E09FF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminEDocType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminEDocType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminEDocType" } } } } } } }, "/api/AdminEDocType/UpsertGraph": { "put": { "tags": [ "AdminEDocType" ], "summary": "AdminEDocType: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminEDocType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminEDocType_UpsertGraph_4EA99401708A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminEDocType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminEDocType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminEDocType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminEDocType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminEDocType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminEDocType" } } } } } } }, "/api/AdminEDocType/UpsertGraphWithExtraFields": { "put": { "tags": [ "AdminEDocType" ], "summary": "AdminEDocType: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminEDocType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminEDocType_UpsertGraphWithExtraFields_E24EC8EDD040", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminEDocType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminEDocType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminEDocType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminEDocType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminEDocType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminEDocType" } } } } } } }, "/api/AdminFederalState": { "get": { "tags": [ "AdminFederalState" ], "summary": "AdminFederalState: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminFederalState-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminFederalState_GetAll_C79283543DE9", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminFederalState" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminFederalState" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminFederalState" } } } } } }, "post": { "tags": [ "AdminFederalState" ], "summary": "AdminFederalState: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminFederalState-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminFederalState_Post_26342A973371", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminFederalState" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminFederalState" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminFederalState" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminFederalState" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminFederalState" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminFederalState" } } } } } }, "put": { "tags": [ "AdminFederalState" ], "summary": "AdminFederalState: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminFederalState-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminFederalState_Put_B04C2544D52C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminFederalState" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminFederalState" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminFederalState" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminFederalState" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminFederalState" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminFederalState" } } } } } } }, "/api/AdminFederalState/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "AdminFederalState" ], "summary": "AdminFederalState: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminFederalState-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminFederalState_GetPageByValue_FFD193349A6E", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AdminFederalState/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "AdminFederalState" ], "summary": "AdminFederalState: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminFederalState-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminFederalState_GetPageByValue2_26475589F9D9", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AdminFederalState/DeleteByFilter": { "post": { "tags": [ "AdminFederalState" ], "summary": "AdminFederalState: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminFederalState-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminFederalState_DeleteByFilter_DA0BA603E7B3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/AdminFederalState/GetAllByValue": { "post": { "tags": [ "AdminFederalState" ], "summary": "AdminFederalState: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminFederalState-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminFederalState_GetAllByValue_C826C8C29002", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminFederalState" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminFederalState" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminFederalState" } } } } } } }, "/api/AdminFederalState/GetAllGraphByValue": { "post": { "tags": [ "AdminFederalState" ], "summary": "AdminFederalState: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminFederalState-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminFederalState_GetAllGraphByValue_F70869E34298", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminFederalState" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminFederalState" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminFederalState" } } } } } } }, "/api/AdminFederalState/GetByValue": { "post": { "tags": [ "AdminFederalState" ], "summary": "AdminFederalState: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminFederalState-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminFederalState_GetByValue_EFEA1F1DFA6D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminFederalState" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminFederalState" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminFederalState" } } } } } } }, "/api/AdminFederalState/GetLookup": { "post": { "tags": [ "AdminFederalState" ], "summary": "AdminFederalState: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminFederalState-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminFederalState_GetLookup_31253A160154", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/AdminFederalState/GetLookupByValue": { "post": { "tags": [ "AdminFederalState" ], "summary": "AdminFederalState: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminFederalState-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminFederalState_GetLookupByValue_D8AE63C553CE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/AdminFederalState/Page": { "get": { "tags": [ "AdminFederalState" ], "summary": "AdminFederalState: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminFederalState-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminFederalState_GetPage_109E25CFDC01", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AdminFederalState/PageAsc": { "get": { "tags": [ "AdminFederalState" ], "summary": "AdminFederalState: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminFederalState-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminFederalState_GetPageAsc_8BFC50F055A2", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AdminFederalState/SearchByValue": { "post": { "tags": [ "AdminFederalState" ], "summary": "AdminFederalState: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminFederalState-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminFederalState_SearchByValue_7DAAE0EE10EC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AdminFederalState" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AdminFederalState" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AdminFederalState" } } } } } } }, "/api/AdminFederalState/TryGetByValue": { "post": { "tags": [ "AdminFederalState" ], "summary": "AdminFederalState: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminFederalState-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminFederalState_TryGetByValue_E612B643354D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminFederalState" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminFederalState" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminFederalState" } } } } } } }, "/api/AdminFederalState/UpsertGraph": { "put": { "tags": [ "AdminFederalState" ], "summary": "AdminFederalState: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminFederalState-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminFederalState_UpsertGraph_A4337DF15F06", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminFederalState" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminFederalState" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminFederalState" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminFederalState" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminFederalState" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminFederalState" } } } } } } }, "/api/AdminFederalState/UpsertGraphWithExtraFields": { "put": { "tags": [ "AdminFederalState" ], "summary": "AdminFederalState: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminFederalState-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminFederalState_UpsertGraphWithExtraFields_9071DBA402D1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminFederalState" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminFederalState" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminFederalState" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminFederalState" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminFederalState" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminFederalState" } } } } } } }, "/api/AdminFiscalPeriod": { "get": { "tags": [ "AdminFiscalPeriod" ], "summary": "AdminFiscalPeriod: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminFiscalPeriod-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminFiscalPeriod_GetAll_9A51964B115F", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminFiscalPeriod" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminFiscalPeriod" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminFiscalPeriod" } } } } } }, "post": { "tags": [ "AdminFiscalPeriod" ], "summary": "AdminFiscalPeriod: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminFiscalPeriod-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminFiscalPeriod_Post_0F8B7AD7350F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminFiscalPeriod" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminFiscalPeriod" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminFiscalPeriod" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminFiscalPeriod" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminFiscalPeriod" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminFiscalPeriod" } } } } } }, "put": { "tags": [ "AdminFiscalPeriod" ], "summary": "AdminFiscalPeriod: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminFiscalPeriod-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminFiscalPeriod_Put_D874BC592EA6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminFiscalPeriod" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminFiscalPeriod" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminFiscalPeriod" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminFiscalPeriod" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminFiscalPeriod" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminFiscalPeriod" } } } } } } }, "/api/AdminFiscalPeriod/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "AdminFiscalPeriod" ], "summary": "AdminFiscalPeriod: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminFiscalPeriod-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminFiscalPeriod_GetPageByValue_48B112E9650D", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AdminFiscalPeriod/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "AdminFiscalPeriod" ], "summary": "AdminFiscalPeriod: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminFiscalPeriod-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminFiscalPeriod_GetPageByValue2_FCD395345B5F", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AdminFiscalPeriod/DeleteByFilter": { "post": { "tags": [ "AdminFiscalPeriod" ], "summary": "AdminFiscalPeriod: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminFiscalPeriod-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminFiscalPeriod_DeleteByFilter_842EE14A28B9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/AdminFiscalPeriod/GetAllByValue": { "post": { "tags": [ "AdminFiscalPeriod" ], "summary": "AdminFiscalPeriod: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminFiscalPeriod-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminFiscalPeriod_GetAllByValue_58A631762A6D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminFiscalPeriod" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminFiscalPeriod" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminFiscalPeriod" } } } } } } }, "/api/AdminFiscalPeriod/GetAllGraphByValue": { "post": { "tags": [ "AdminFiscalPeriod" ], "summary": "AdminFiscalPeriod: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminFiscalPeriod-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminFiscalPeriod_GetAllGraphByValue_556516FBDAEB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminFiscalPeriod" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminFiscalPeriod" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminFiscalPeriod" } } } } } } }, "/api/AdminFiscalPeriod/GetByValue": { "post": { "tags": [ "AdminFiscalPeriod" ], "summary": "AdminFiscalPeriod: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminFiscalPeriod-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminFiscalPeriod_GetByValue_7EFCDBBC5F1A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminFiscalPeriod" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminFiscalPeriod" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminFiscalPeriod" } } } } } } }, "/api/AdminFiscalPeriod/GetLookup": { "post": { "tags": [ "AdminFiscalPeriod" ], "summary": "AdminFiscalPeriod: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminFiscalPeriod-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminFiscalPeriod_GetLookup_208E8A7C1E08", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/AdminFiscalPeriod/GetLookupByValue": { "post": { "tags": [ "AdminFiscalPeriod" ], "summary": "AdminFiscalPeriod: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminFiscalPeriod-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminFiscalPeriod_GetLookupByValue_3ACE193329C9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/AdminFiscalPeriod/Page": { "get": { "tags": [ "AdminFiscalPeriod" ], "summary": "AdminFiscalPeriod: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminFiscalPeriod-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminFiscalPeriod_GetPage_12FC01F69E06", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AdminFiscalPeriod/PageAsc": { "get": { "tags": [ "AdminFiscalPeriod" ], "summary": "AdminFiscalPeriod: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminFiscalPeriod-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminFiscalPeriod_GetPageAsc_F631CAB39657", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AdminFiscalPeriod/SearchByValue": { "post": { "tags": [ "AdminFiscalPeriod" ], "summary": "AdminFiscalPeriod: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminFiscalPeriod-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminFiscalPeriod_SearchByValue_34A520142D5D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AdminFiscalPeriod" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AdminFiscalPeriod" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AdminFiscalPeriod" } } } } } } }, "/api/AdminFiscalPeriod/TryGetByValue": { "post": { "tags": [ "AdminFiscalPeriod" ], "summary": "AdminFiscalPeriod: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminFiscalPeriod-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminFiscalPeriod_TryGetByValue_B03E0BA0DFA8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminFiscalPeriod" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminFiscalPeriod" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminFiscalPeriod" } } } } } } }, "/api/AdminFiscalPeriod/UpsertGraph": { "put": { "tags": [ "AdminFiscalPeriod" ], "summary": "AdminFiscalPeriod: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminFiscalPeriod-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminFiscalPeriod_UpsertGraph_8D8E54695E3E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminFiscalPeriod" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminFiscalPeriod" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminFiscalPeriod" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminFiscalPeriod" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminFiscalPeriod" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminFiscalPeriod" } } } } } } }, "/api/AdminFiscalPeriod/UpsertGraphWithExtraFields": { "put": { "tags": [ "AdminFiscalPeriod" ], "summary": "AdminFiscalPeriod: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminFiscalPeriod-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminFiscalPeriod_UpsertGraphWithExtraFields_D1B6386591DE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminFiscalPeriod" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminFiscalPeriod" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminFiscalPeriod" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminFiscalPeriod" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminFiscalPeriod" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminFiscalPeriod" } } } } } } }, "/api/AdminLanguage": { "get": { "tags": [ "AdminLanguage" ], "summary": "AdminLanguage: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminLanguage-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminLanguage_GetAll_FFBD837A8C50", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminLanguage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminLanguage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminLanguage" } } } } } }, "post": { "tags": [ "AdminLanguage" ], "summary": "AdminLanguage: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminLanguage-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminLanguage_Post_30EE723119AC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminLanguage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminLanguage" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminLanguage" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminLanguage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminLanguage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminLanguage" } } } } } }, "put": { "tags": [ "AdminLanguage" ], "summary": "AdminLanguage: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminLanguage-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminLanguage_Put_FCE7547EA7A8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminLanguage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminLanguage" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminLanguage" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminLanguage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminLanguage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminLanguage" } } } } } } }, "/api/AdminLanguage/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "AdminLanguage" ], "summary": "AdminLanguage: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminLanguage-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminLanguage_GetPageByValue_63E5488B8D94", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AdminLanguage/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "AdminLanguage" ], "summary": "AdminLanguage: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminLanguage-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminLanguage_GetPageByValue2_22F7B9BB1DCB", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AdminLanguage/DeleteByFilter": { "post": { "tags": [ "AdminLanguage" ], "summary": "AdminLanguage: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminLanguage-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminLanguage_DeleteByFilter_93132A62C4EF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/AdminLanguage/GetAllByValue": { "post": { "tags": [ "AdminLanguage" ], "summary": "AdminLanguage: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminLanguage-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminLanguage_GetAllByValue_A535D3D0313A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminLanguage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminLanguage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminLanguage" } } } } } } }, "/api/AdminLanguage/GetAllGraphByValue": { "post": { "tags": [ "AdminLanguage" ], "summary": "AdminLanguage: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminLanguage-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminLanguage_GetAllGraphByValue_399BD50142A8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminLanguage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminLanguage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminLanguage" } } } } } } }, "/api/AdminLanguage/GetByValue": { "post": { "tags": [ "AdminLanguage" ], "summary": "AdminLanguage: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminLanguage-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminLanguage_GetByValue_6B37750D5F0A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminLanguage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminLanguage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminLanguage" } } } } } } }, "/api/AdminLanguage/GetLookup": { "post": { "tags": [ "AdminLanguage" ], "summary": "AdminLanguage: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminLanguage-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminLanguage_GetLookup_D53F86E3CA28", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/AdminLanguage/GetLookupByValue": { "post": { "tags": [ "AdminLanguage" ], "summary": "AdminLanguage: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminLanguage-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminLanguage_GetLookupByValue_844C705FB2C0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/AdminLanguage/Page": { "get": { "tags": [ "AdminLanguage" ], "summary": "AdminLanguage: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminLanguage-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminLanguage_GetPage_471ED2359DB6", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AdminLanguage/PageAsc": { "get": { "tags": [ "AdminLanguage" ], "summary": "AdminLanguage: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminLanguage-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminLanguage_GetPageAsc_9EE474EAD520", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AdminLanguage/SearchByValue": { "post": { "tags": [ "AdminLanguage" ], "summary": "AdminLanguage: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminLanguage-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminLanguage_SearchByValue_36FBCC6F8030", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AdminLanguage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AdminLanguage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AdminLanguage" } } } } } } }, "/api/AdminLanguage/TryGetByValue": { "post": { "tags": [ "AdminLanguage" ], "summary": "AdminLanguage: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminLanguage-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminLanguage_TryGetByValue_692D705E0D5A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminLanguage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminLanguage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminLanguage" } } } } } } }, "/api/AdminLanguage/UpsertGraph": { "put": { "tags": [ "AdminLanguage" ], "summary": "AdminLanguage: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminLanguage-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminLanguage_UpsertGraph_0859881AE185", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminLanguage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminLanguage" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminLanguage" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminLanguage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminLanguage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminLanguage" } } } } } } }, "/api/AdminLanguage/UpsertGraphWithExtraFields": { "put": { "tags": [ "AdminLanguage" ], "summary": "AdminLanguage: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminLanguage-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminLanguage_UpsertGraphWithExtraFields_E201C448BEF2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminLanguage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminLanguage" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminLanguage" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminLanguage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminLanguage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminLanguage" } } } } } } }, "/api/AdminLocation": { "get": { "tags": [ "AdminLocation" ], "summary": "AdminLocation: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminLocation-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminLocation_GetAll_E3513E6EDEBB", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminLocation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminLocation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminLocation" } } } } } }, "post": { "tags": [ "AdminLocation" ], "summary": "AdminLocation: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminLocation-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminLocation_Post_AF28B4D40009", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminLocation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminLocation" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminLocation" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminLocation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminLocation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminLocation" } } } } } }, "put": { "tags": [ "AdminLocation" ], "summary": "AdminLocation: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminLocation-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminLocation_Put_3095D3357723", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminLocation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminLocation" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminLocation" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminLocation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminLocation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminLocation" } } } } } } }, "/api/AdminLocation/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "AdminLocation" ], "summary": "AdminLocation: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminLocation-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminLocation_GetPageByValue_88DB4EC00362", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AdminLocation/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "AdminLocation" ], "summary": "AdminLocation: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminLocation-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminLocation_GetPageByValue2_82FD5D61CE37", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AdminLocation/DeleteByFilter": { "post": { "tags": [ "AdminLocation" ], "summary": "AdminLocation: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminLocation-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminLocation_DeleteByFilter_52F625920372", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/AdminLocation/GetAllByValue": { "post": { "tags": [ "AdminLocation" ], "summary": "AdminLocation: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminLocation-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminLocation_GetAllByValue_A8F247595F56", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminLocation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminLocation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminLocation" } } } } } } }, "/api/AdminLocation/GetAllGraphByValue": { "post": { "tags": [ "AdminLocation" ], "summary": "AdminLocation: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminLocation-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminLocation_GetAllGraphByValue_5DF2BC3394F3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminLocation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminLocation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminLocation" } } } } } } }, "/api/AdminLocation/GetByValue": { "post": { "tags": [ "AdminLocation" ], "summary": "AdminLocation: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminLocation-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminLocation_GetByValue_F67AB6A80ECA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminLocation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminLocation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminLocation" } } } } } } }, "/api/AdminLocation/GetLookup": { "post": { "tags": [ "AdminLocation" ], "summary": "AdminLocation: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminLocation-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminLocation_GetLookup_E838DDC5DA44", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/AdminLocation/GetLookupByValue": { "post": { "tags": [ "AdminLocation" ], "summary": "AdminLocation: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminLocation-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminLocation_GetLookupByValue_0FB8B518EF47", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/AdminLocation/Page": { "get": { "tags": [ "AdminLocation" ], "summary": "AdminLocation: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminLocation-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminLocation_GetPage_2370FC9A65D5", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AdminLocation/PageAsc": { "get": { "tags": [ "AdminLocation" ], "summary": "AdminLocation: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminLocation-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminLocation_GetPageAsc_4033E707EC8A", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AdminLocation/SearchByValue": { "post": { "tags": [ "AdminLocation" ], "summary": "AdminLocation: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminLocation-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminLocation_SearchByValue_2A701802A37A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AdminLocation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AdminLocation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AdminLocation" } } } } } } }, "/api/AdminLocation/TryGetByValue": { "post": { "tags": [ "AdminLocation" ], "summary": "AdminLocation: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminLocation-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminLocation_TryGetByValue_90CBBC8E9810", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminLocation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminLocation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminLocation" } } } } } } }, "/api/AdminLocation/UpsertGraph": { "put": { "tags": [ "AdminLocation" ], "summary": "AdminLocation: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminLocation-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminLocation_UpsertGraph_954108A646E6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminLocation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminLocation" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminLocation" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminLocation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminLocation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminLocation" } } } } } } }, "/api/AdminLocation/UpsertGraphWithExtraFields": { "put": { "tags": [ "AdminLocation" ], "summary": "AdminLocation: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminLocation-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminLocation_UpsertGraphWithExtraFields_93CC076F7842", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminLocation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminLocation" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminLocation" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminLocation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminLocation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminLocation" } } } } } } }, "/api/AdminMonth": { "get": { "tags": [ "AdminMonth" ], "summary": "AdminMonth: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminMonth-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminMonth_GetAll_EC523A08E4FA", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminMonth" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminMonth" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminMonth" } } } } } }, "post": { "tags": [ "AdminMonth" ], "summary": "AdminMonth: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminMonth-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminMonth_Post_AB87C0B1191F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminMonth" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminMonth" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminMonth" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminMonth" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminMonth" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminMonth" } } } } } }, "put": { "tags": [ "AdminMonth" ], "summary": "AdminMonth: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminMonth-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminMonth_Put_4607C3650076", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminMonth" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminMonth" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminMonth" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminMonth" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminMonth" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminMonth" } } } } } } }, "/api/AdminMonth/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "AdminMonth" ], "summary": "AdminMonth: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminMonth-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminMonth_GetPageByValue_B28DCB165342", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AdminMonth/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "AdminMonth" ], "summary": "AdminMonth: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminMonth-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminMonth_GetPageByValue2_2963A921349F", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AdminMonth/DeleteByFilter": { "post": { "tags": [ "AdminMonth" ], "summary": "AdminMonth: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminMonth-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminMonth_DeleteByFilter_61E50CCB48E8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/AdminMonth/GetAllByValue": { "post": { "tags": [ "AdminMonth" ], "summary": "AdminMonth: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminMonth-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminMonth_GetAllByValue_A419077DDBF5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminMonth" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminMonth" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminMonth" } } } } } } }, "/api/AdminMonth/GetAllGraphByValue": { "post": { "tags": [ "AdminMonth" ], "summary": "AdminMonth: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminMonth-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminMonth_GetAllGraphByValue_CC2E1E43903F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminMonth" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminMonth" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminMonth" } } } } } } }, "/api/AdminMonth/GetByValue": { "post": { "tags": [ "AdminMonth" ], "summary": "AdminMonth: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminMonth-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminMonth_GetByValue_D31439AA25B5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminMonth" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminMonth" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminMonth" } } } } } } }, "/api/AdminMonth/GetLookup": { "post": { "tags": [ "AdminMonth" ], "summary": "AdminMonth: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminMonth-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminMonth_GetLookup_3C4AD3D551D5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/AdminMonth/GetLookupByValue": { "post": { "tags": [ "AdminMonth" ], "summary": "AdminMonth: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminMonth-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminMonth_GetLookupByValue_F1CAC11BC1E6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/AdminMonth/Page": { "get": { "tags": [ "AdminMonth" ], "summary": "AdminMonth: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminMonth-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminMonth_GetPage_A6702C4A766B", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AdminMonth/PageAsc": { "get": { "tags": [ "AdminMonth" ], "summary": "AdminMonth: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminMonth-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminMonth_GetPageAsc_26974732014C", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AdminMonth/SearchByValue": { "post": { "tags": [ "AdminMonth" ], "summary": "AdminMonth: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminMonth-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminMonth_SearchByValue_3847DA32A5F0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AdminMonth" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AdminMonth" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AdminMonth" } } } } } } }, "/api/AdminMonth/TryGetByValue": { "post": { "tags": [ "AdminMonth" ], "summary": "AdminMonth: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminMonth-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminMonth_TryGetByValue_5DB771761413", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminMonth" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminMonth" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminMonth" } } } } } } }, "/api/AdminMonth/UpsertGraph": { "put": { "tags": [ "AdminMonth" ], "summary": "AdminMonth: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminMonth-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminMonth_UpsertGraph_EE51F95D2B1D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminMonth" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminMonth" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminMonth" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminMonth" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminMonth" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminMonth" } } } } } } }, "/api/AdminMonth/UpsertGraphWithExtraFields": { "put": { "tags": [ "AdminMonth" ], "summary": "AdminMonth: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminMonth-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminMonth_UpsertGraphWithExtraFields_EC9FAA7C3E90", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminMonth" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminMonth" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminMonth" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminMonth" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminMonth" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminMonth" } } } } } } }, "/api/AdminProgramAiLanguage": { "get": { "tags": [ "AdminProgramAiLanguage" ], "summary": "AdminProgramAiLanguage: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminProgramAiLanguage-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminProgramAiLanguage_GetAll_E7F3CC6989E1", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminProgramAiLanguage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminProgramAiLanguage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminProgramAiLanguage" } } } } } }, "post": { "tags": [ "AdminProgramAiLanguage" ], "summary": "AdminProgramAiLanguage: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminProgramAiLanguage-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminProgramAiLanguage_Post_264DD69D7513", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminProgramAiLanguage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminProgramAiLanguage" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminProgramAiLanguage" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminProgramAiLanguage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminProgramAiLanguage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminProgramAiLanguage" } } } } } }, "put": { "tags": [ "AdminProgramAiLanguage" ], "summary": "AdminProgramAiLanguage: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminProgramAiLanguage-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminProgramAiLanguage_Put_63AE39D493CF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminProgramAiLanguage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminProgramAiLanguage" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminProgramAiLanguage" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminProgramAiLanguage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminProgramAiLanguage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminProgramAiLanguage" } } } } } } }, "/api/AdminProgramAiLanguage/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "AdminProgramAiLanguage" ], "summary": "AdminProgramAiLanguage: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminProgramAiLanguage-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminProgramAiLanguage_GetPageByValue_E0D82F4A49E4", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AdminProgramAiLanguage/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "AdminProgramAiLanguage" ], "summary": "AdminProgramAiLanguage: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminProgramAiLanguage-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminProgramAiLanguage_GetPageByValue2_E291A2BA8204", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AdminProgramAiLanguage/DeleteByFilter": { "post": { "tags": [ "AdminProgramAiLanguage" ], "summary": "AdminProgramAiLanguage: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminProgramAiLanguage-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminProgramAiLanguage_DeleteByFilter_93A7EAD52D5B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/AdminProgramAiLanguage/GetAllByValue": { "post": { "tags": [ "AdminProgramAiLanguage" ], "summary": "AdminProgramAiLanguage: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminProgramAiLanguage-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminProgramAiLanguage_GetAllByValue_09890519BEF3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminProgramAiLanguage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminProgramAiLanguage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminProgramAiLanguage" } } } } } } }, "/api/AdminProgramAiLanguage/GetAllGraphByValue": { "post": { "tags": [ "AdminProgramAiLanguage" ], "summary": "AdminProgramAiLanguage: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminProgramAiLanguage-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminProgramAiLanguage_GetAllGraphByValue_B6324DD62506", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminProgramAiLanguage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminProgramAiLanguage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminProgramAiLanguage" } } } } } } }, "/api/AdminProgramAiLanguage/GetByValue": { "post": { "tags": [ "AdminProgramAiLanguage" ], "summary": "AdminProgramAiLanguage: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminProgramAiLanguage-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminProgramAiLanguage_GetByValue_E44645C64653", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminProgramAiLanguage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminProgramAiLanguage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminProgramAiLanguage" } } } } } } }, "/api/AdminProgramAiLanguage/GetLookup": { "post": { "tags": [ "AdminProgramAiLanguage" ], "summary": "AdminProgramAiLanguage: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminProgramAiLanguage-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminProgramAiLanguage_GetLookup_7283516657E0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/AdminProgramAiLanguage/GetLookupByValue": { "post": { "tags": [ "AdminProgramAiLanguage" ], "summary": "AdminProgramAiLanguage: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminProgramAiLanguage-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminProgramAiLanguage_GetLookupByValue_08A49CB3CF9D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/AdminProgramAiLanguage/Page": { "get": { "tags": [ "AdminProgramAiLanguage" ], "summary": "AdminProgramAiLanguage: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminProgramAiLanguage-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminProgramAiLanguage_GetPage_E49E1B854649", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AdminProgramAiLanguage/PageAsc": { "get": { "tags": [ "AdminProgramAiLanguage" ], "summary": "AdminProgramAiLanguage: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminProgramAiLanguage-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminProgramAiLanguage_GetPageAsc_1BAAF4168F77", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AdminProgramAiLanguage/SearchByValue": { "post": { "tags": [ "AdminProgramAiLanguage" ], "summary": "AdminProgramAiLanguage: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminProgramAiLanguage-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminProgramAiLanguage_SearchByValue_F07F1211A56C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AdminProgramAiLanguage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AdminProgramAiLanguage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AdminProgramAiLanguage" } } } } } } }, "/api/AdminProgramAiLanguage/TryGetByValue": { "post": { "tags": [ "AdminProgramAiLanguage" ], "summary": "AdminProgramAiLanguage: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminProgramAiLanguage-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminProgramAiLanguage_TryGetByValue_034FF455869B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminProgramAiLanguage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminProgramAiLanguage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminProgramAiLanguage" } } } } } } }, "/api/AdminProgramAiLanguage/UpsertGraph": { "put": { "tags": [ "AdminProgramAiLanguage" ], "summary": "AdminProgramAiLanguage: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminProgramAiLanguage-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminProgramAiLanguage_UpsertGraph_482BFB363EC6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminProgramAiLanguage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminProgramAiLanguage" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminProgramAiLanguage" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminProgramAiLanguage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminProgramAiLanguage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminProgramAiLanguage" } } } } } } }, "/api/AdminProgramAiLanguage/UpsertGraphWithExtraFields": { "put": { "tags": [ "AdminProgramAiLanguage" ], "summary": "AdminProgramAiLanguage: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminProgramAiLanguage-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminProgramAiLanguage_UpsertGraphWithExtraFields_11ED884F9775", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminProgramAiLanguage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminProgramAiLanguage" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminProgramAiLanguage" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminProgramAiLanguage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminProgramAiLanguage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminProgramAiLanguage" } } } } } } }, "/api/AdminProgramSetting": { "get": { "tags": [ "AdminProgramSetting" ], "summary": "AdminProgramSetting: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminProgramSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminProgramSetting_GetAll_26C37F9A4C69", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminProgramSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminProgramSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminProgramSetting" } } } } } }, "post": { "tags": [ "AdminProgramSetting" ], "summary": "AdminProgramSetting: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminProgramSetting-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminProgramSetting_Post_9BF9F0699565", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminProgramSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminProgramSetting" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminProgramSetting" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminProgramSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminProgramSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminProgramSetting" } } } } } }, "put": { "tags": [ "AdminProgramSetting" ], "summary": "AdminProgramSetting: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminProgramSetting-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminProgramSetting_Put_C7C0082489EF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminProgramSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminProgramSetting" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminProgramSetting" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminProgramSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminProgramSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminProgramSetting" } } } } } } }, "/api/AdminProgramSetting/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "AdminProgramSetting" ], "summary": "AdminProgramSetting: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminProgramSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminProgramSetting_GetPageByValue_B738B7302CE9", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AdminProgramSetting/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "AdminProgramSetting" ], "summary": "AdminProgramSetting: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminProgramSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminProgramSetting_GetPageByValue2_DF6C93EE24B2", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AdminProgramSetting/DeleteByFilter": { "post": { "tags": [ "AdminProgramSetting" ], "summary": "AdminProgramSetting: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminProgramSetting-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminProgramSetting_DeleteByFilter_9924A0B1DB15", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/AdminProgramSetting/GetAllByValue": { "post": { "tags": [ "AdminProgramSetting" ], "summary": "AdminProgramSetting: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminProgramSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminProgramSetting_GetAllByValue_857FA0CEE70E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminProgramSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminProgramSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminProgramSetting" } } } } } } }, "/api/AdminProgramSetting/GetAllGraphByValue": { "post": { "tags": [ "AdminProgramSetting" ], "summary": "AdminProgramSetting: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminProgramSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminProgramSetting_GetAllGraphByValue_1B5B39E17BFC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminProgramSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminProgramSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminProgramSetting" } } } } } } }, "/api/AdminProgramSetting/GetByValue": { "post": { "tags": [ "AdminProgramSetting" ], "summary": "AdminProgramSetting: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminProgramSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminProgramSetting_GetByValue_D291687EC539", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminProgramSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminProgramSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminProgramSetting" } } } } } } }, "/api/AdminProgramSetting/GetLookup": { "post": { "tags": [ "AdminProgramSetting" ], "summary": "AdminProgramSetting: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminProgramSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminProgramSetting_GetLookup_85A0C2A424A2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/AdminProgramSetting/GetLookupByValue": { "post": { "tags": [ "AdminProgramSetting" ], "summary": "AdminProgramSetting: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminProgramSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminProgramSetting_GetLookupByValue_D0566A419DCC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/AdminProgramSetting/Page": { "get": { "tags": [ "AdminProgramSetting" ], "summary": "AdminProgramSetting: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminProgramSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminProgramSetting_GetPage_A5A6523AA5FF", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AdminProgramSetting/PageAsc": { "get": { "tags": [ "AdminProgramSetting" ], "summary": "AdminProgramSetting: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminProgramSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminProgramSetting_GetPageAsc_40491DC805F6", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AdminProgramSetting/SearchByValue": { "post": { "tags": [ "AdminProgramSetting" ], "summary": "AdminProgramSetting: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminProgramSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminProgramSetting_SearchByValue_48175BB4AA18", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AdminProgramSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AdminProgramSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AdminProgramSetting" } } } } } } }, "/api/AdminProgramSetting/TryGetByValue": { "post": { "tags": [ "AdminProgramSetting" ], "summary": "AdminProgramSetting: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminProgramSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminProgramSetting_TryGetByValue_2D757B96DA2B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminProgramSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminProgramSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminProgramSetting" } } } } } } }, "/api/AdminProgramSetting/UpsertGraph": { "put": { "tags": [ "AdminProgramSetting" ], "summary": "AdminProgramSetting: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminProgramSetting-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminProgramSetting_UpsertGraph_B9A87B6C38E0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminProgramSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminProgramSetting" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminProgramSetting" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminProgramSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminProgramSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminProgramSetting" } } } } } } }, "/api/AdminProgramSetting/UpsertGraphWithExtraFields": { "put": { "tags": [ "AdminProgramSetting" ], "summary": "AdminProgramSetting: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminProgramSetting-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminProgramSetting_UpsertGraphWithExtraFields_3C2CE82237FE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminProgramSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminProgramSetting" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminProgramSetting" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminProgramSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminProgramSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminProgramSetting" } } } } } } }, "/api/AdminRoute": { "get": { "tags": [ "AdminRoute" ], "summary": "AdminRoute: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminRoute-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminRoute_GetAll_6810F5A55839", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminRoute" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminRoute" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminRoute" } } } } } }, "post": { "tags": [ "AdminRoute" ], "summary": "AdminRoute: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminRoute-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminRoute_Post_9C1433ABE3CB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminRoute" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminRoute" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminRoute" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminRoute" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminRoute" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminRoute" } } } } } }, "put": { "tags": [ "AdminRoute" ], "summary": "AdminRoute: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminRoute-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminRoute_Put_8BC3BC80C025", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminRoute" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminRoute" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminRoute" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminRoute" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminRoute" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminRoute" } } } } } } }, "/api/AdminRoute/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "AdminRoute" ], "summary": "AdminRoute: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminRoute-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminRoute_GetPageByValue_800BE141CA72", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AdminRoute/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "AdminRoute" ], "summary": "AdminRoute: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminRoute-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminRoute_GetPageByValue2_D2AFDEBC30E8", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AdminRoute/DeleteByFilter": { "post": { "tags": [ "AdminRoute" ], "summary": "AdminRoute: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminRoute-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminRoute_DeleteByFilter_5B0E5D149345", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/AdminRoute/GetAllByValue": { "post": { "tags": [ "AdminRoute" ], "summary": "AdminRoute: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminRoute-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminRoute_GetAllByValue_4F2B46D97565", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminRoute" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminRoute" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminRoute" } } } } } } }, "/api/AdminRoute/GetAllGraphByValue": { "post": { "tags": [ "AdminRoute" ], "summary": "AdminRoute: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminRoute-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminRoute_GetAllGraphByValue_AE46F7932923", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminRoute" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminRoute" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminRoute" } } } } } } }, "/api/AdminRoute/GetByValue": { "post": { "tags": [ "AdminRoute" ], "summary": "AdminRoute: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminRoute-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminRoute_GetByValue_3C2A94EEEA81", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminRoute" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminRoute" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminRoute" } } } } } } }, "/api/AdminRoute/GetLookup": { "post": { "tags": [ "AdminRoute" ], "summary": "AdminRoute: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminRoute-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminRoute_GetLookup_453F3D4CA1A3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/AdminRoute/GetLookupByValue": { "post": { "tags": [ "AdminRoute" ], "summary": "AdminRoute: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminRoute-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminRoute_GetLookupByValue_1BE4CF653619", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/AdminRoute/Page": { "get": { "tags": [ "AdminRoute" ], "summary": "AdminRoute: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminRoute-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminRoute_GetPage_12EF225ED99E", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AdminRoute/PageAsc": { "get": { "tags": [ "AdminRoute" ], "summary": "AdminRoute: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminRoute-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminRoute_GetPageAsc_5A561B430C6C", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AdminRoute/SearchByValue": { "post": { "tags": [ "AdminRoute" ], "summary": "AdminRoute: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminRoute-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminRoute_SearchByValue_E1130128F8AE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AdminRoute" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AdminRoute" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AdminRoute" } } } } } } }, "/api/AdminRoute/TryGetByValue": { "post": { "tags": [ "AdminRoute" ], "summary": "AdminRoute: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminRoute-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminRoute_TryGetByValue_DC090A32818C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminRoute" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminRoute" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminRoute" } } } } } } }, "/api/AdminRoute/UpsertGraph": { "put": { "tags": [ "AdminRoute" ], "summary": "AdminRoute: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminRoute-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminRoute_UpsertGraph_0C3135B6A0AE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminRoute" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminRoute" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminRoute" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminRoute" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminRoute" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminRoute" } } } } } } }, "/api/AdminRoute/UpsertGraphWithExtraFields": { "put": { "tags": [ "AdminRoute" ], "summary": "AdminRoute: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminRoute-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminRoute_UpsertGraphWithExtraFields_1B20B6530FEB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminRoute" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminRoute" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminRoute" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminRoute" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminRoute" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminRoute" } } } } } } }, "/api/AdminSvg": { "get": { "tags": [ "AdminSvg" ], "summary": "AdminSvg: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminSvg-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminSvg_GetAll_8017D2BBA608", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminSvg" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminSvg" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminSvg" } } } } } }, "post": { "tags": [ "AdminSvg" ], "summary": "AdminSvg: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminSvg-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminSvg_Post_034C3999796D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminSvg" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminSvg" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminSvg" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminSvg" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminSvg" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminSvg" } } } } } }, "put": { "tags": [ "AdminSvg" ], "summary": "AdminSvg: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminSvg-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminSvg_Put_5CE3E4D2A008", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminSvg" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminSvg" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminSvg" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminSvg" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminSvg" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminSvg" } } } } } } }, "/api/AdminSvg/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "AdminSvg" ], "summary": "AdminSvg: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminSvg-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminSvg_GetPageByValue_5737AA5C218B", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AdminSvg/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "AdminSvg" ], "summary": "AdminSvg: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminSvg-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminSvg_GetPageByValue2_D42C28349AB3", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AdminSvg/DeleteByFilter": { "post": { "tags": [ "AdminSvg" ], "summary": "AdminSvg: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminSvg-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminSvg_DeleteByFilter_5EF0CBF9D93B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/AdminSvg/GetAllByValue": { "post": { "tags": [ "AdminSvg" ], "summary": "AdminSvg: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminSvg-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminSvg_GetAllByValue_A23E47D24599", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminSvg" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminSvg" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminSvg" } } } } } } }, "/api/AdminSvg/GetAllGraphByValue": { "post": { "tags": [ "AdminSvg" ], "summary": "AdminSvg: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminSvg-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminSvg_GetAllGraphByValue_3997D20C7A0B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminSvg" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminSvg" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminSvg" } } } } } } }, "/api/AdminSvg/GetByValue": { "post": { "tags": [ "AdminSvg" ], "summary": "AdminSvg: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminSvg-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminSvg_GetByValue_24C70D3B960D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminSvg" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminSvg" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminSvg" } } } } } } }, "/api/AdminSvg/GetLookup": { "post": { "tags": [ "AdminSvg" ], "summary": "AdminSvg: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminSvg-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminSvg_GetLookup_524CEE5F8BE9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/AdminSvg/GetLookupByValue": { "post": { "tags": [ "AdminSvg" ], "summary": "AdminSvg: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminSvg-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminSvg_GetLookupByValue_B97F7B35C8F1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/AdminSvg/Page": { "get": { "tags": [ "AdminSvg" ], "summary": "AdminSvg: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminSvg-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminSvg_GetPage_2DCB02BA6B21", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AdminSvg/PageAsc": { "get": { "tags": [ "AdminSvg" ], "summary": "AdminSvg: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminSvg-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminSvg_GetPageAsc_4FAA6A3E1E5B", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AdminSvg/SearchByValue": { "post": { "tags": [ "AdminSvg" ], "summary": "AdminSvg: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminSvg-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminSvg_SearchByValue_26DF34CD6388", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AdminSvg" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AdminSvg" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AdminSvg" } } } } } } }, "/api/AdminSvg/TryGetByValue": { "post": { "tags": [ "AdminSvg" ], "summary": "AdminSvg: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminSvg-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminSvg_TryGetByValue_01F55DA0A174", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminSvg" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminSvg" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminSvg" } } } } } } }, "/api/AdminSvg/UpsertGraph": { "put": { "tags": [ "AdminSvg" ], "summary": "AdminSvg: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminSvg-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminSvg_UpsertGraph_D6FFE6F2EA31", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminSvg" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminSvg" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminSvg" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminSvg" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminSvg" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminSvg" } } } } } } }, "/api/AdminSvg/UpsertGraphWithExtraFields": { "put": { "tags": [ "AdminSvg" ], "summary": "AdminSvg: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminSvg-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminSvg_UpsertGraphWithExtraFields_6904A500A722", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminSvg" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminSvg" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminSvg" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminSvg" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminSvg" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminSvg" } } } } } } }, "/api/AdminTimeZone": { "get": { "tags": [ "AdminTimeZone" ], "summary": "AdminTimeZone: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminTimeZone-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminTimeZone_GetAll_06DAF879E72E", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminTimeZone" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminTimeZone" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminTimeZone" } } } } } }, "post": { "tags": [ "AdminTimeZone" ], "summary": "AdminTimeZone: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminTimeZone-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminTimeZone_Post_A2263642CBA9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminTimeZone" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminTimeZone" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminTimeZone" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminTimeZone" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminTimeZone" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminTimeZone" } } } } } }, "put": { "tags": [ "AdminTimeZone" ], "summary": "AdminTimeZone: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminTimeZone-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminTimeZone_Put_784A0024387F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminTimeZone" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminTimeZone" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminTimeZone" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminTimeZone" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminTimeZone" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminTimeZone" } } } } } } }, "/api/AdminTimeZone/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "AdminTimeZone" ], "summary": "AdminTimeZone: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminTimeZone-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminTimeZone_GetPageByValue_271933233BAA", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AdminTimeZone/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "AdminTimeZone" ], "summary": "AdminTimeZone: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminTimeZone-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminTimeZone_GetPageByValue2_93B8465C9D6A", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AdminTimeZone/DeleteByFilter": { "post": { "tags": [ "AdminTimeZone" ], "summary": "AdminTimeZone: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminTimeZone-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminTimeZone_DeleteByFilter_A02CDAB77CBB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/AdminTimeZone/GetAllByValue": { "post": { "tags": [ "AdminTimeZone" ], "summary": "AdminTimeZone: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminTimeZone-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminTimeZone_GetAllByValue_5C1FA97FE4C6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminTimeZone" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminTimeZone" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminTimeZone" } } } } } } }, "/api/AdminTimeZone/GetAllGraphByValue": { "post": { "tags": [ "AdminTimeZone" ], "summary": "AdminTimeZone: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminTimeZone-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminTimeZone_GetAllGraphByValue_02FBEAFCD4E0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminTimeZone" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminTimeZone" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminTimeZone" } } } } } } }, "/api/AdminTimeZone/GetByValue": { "post": { "tags": [ "AdminTimeZone" ], "summary": "AdminTimeZone: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminTimeZone-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminTimeZone_GetByValue_B9F4C940DD69", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminTimeZone" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminTimeZone" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminTimeZone" } } } } } } }, "/api/AdminTimeZone/GetLookup": { "post": { "tags": [ "AdminTimeZone" ], "summary": "AdminTimeZone: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminTimeZone-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminTimeZone_GetLookup_384DD228BFEF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/AdminTimeZone/GetLookupByValue": { "post": { "tags": [ "AdminTimeZone" ], "summary": "AdminTimeZone: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminTimeZone-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminTimeZone_GetLookupByValue_6F0B83B4F56D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/AdminTimeZone/Page": { "get": { "tags": [ "AdminTimeZone" ], "summary": "AdminTimeZone: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminTimeZone-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminTimeZone_GetPage_6038CBD8AB68", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AdminTimeZone/PageAsc": { "get": { "tags": [ "AdminTimeZone" ], "summary": "AdminTimeZone: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminTimeZone-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminTimeZone_GetPageAsc_2AA9C167A0FB", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AdminTimeZone/SearchByValue": { "post": { "tags": [ "AdminTimeZone" ], "summary": "AdminTimeZone: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminTimeZone-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminTimeZone_SearchByValue_184D5D640531", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AdminTimeZone" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AdminTimeZone" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AdminTimeZone" } } } } } } }, "/api/AdminTimeZone/TryGetByValue": { "post": { "tags": [ "AdminTimeZone" ], "summary": "AdminTimeZone: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminTimeZone-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminTimeZone_TryGetByValue_F3D6E4249006", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminTimeZone" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminTimeZone" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminTimeZone" } } } } } } }, "/api/AdminTimeZone/UpsertGraph": { "put": { "tags": [ "AdminTimeZone" ], "summary": "AdminTimeZone: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminTimeZone-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminTimeZone_UpsertGraph_DB5C8E52AF6F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminTimeZone" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminTimeZone" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminTimeZone" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminTimeZone" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminTimeZone" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminTimeZone" } } } } } } }, "/api/AdminTimeZone/UpsertGraphWithExtraFields": { "put": { "tags": [ "AdminTimeZone" ], "summary": "AdminTimeZone: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminTimeZone-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminTimeZone_UpsertGraphWithExtraFields_6930F1FD0781", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminTimeZone" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminTimeZone" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminTimeZone" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminTimeZone" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminTimeZone" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminTimeZone" } } } } } } }, "/api/AdminYear": { "get": { "tags": [ "AdminYear" ], "summary": "AdminYear: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminYear-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminYear_GetAll_4AD91ABB2527", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminYear" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminYear" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminYear" } } } } } }, "post": { "tags": [ "AdminYear" ], "summary": "AdminYear: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminYear-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminYear_Post_E7DF675D7FF9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminYear" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminYear" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminYear" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminYear" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminYear" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminYear" } } } } } }, "put": { "tags": [ "AdminYear" ], "summary": "AdminYear: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminYear-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminYear_Put_FD1D5005C9D3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminYear" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminYear" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminYear" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminYear" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminYear" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminYear" } } } } } } }, "/api/AdminYear/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "AdminYear" ], "summary": "AdminYear: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminYear-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminYear_GetPageByValue_7AA68CBE4973", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AdminYear/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "AdminYear" ], "summary": "AdminYear: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminYear-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminYear_GetPageByValue2_424CACF5EE5E", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AdminYear/DeleteByFilter": { "post": { "tags": [ "AdminYear" ], "summary": "AdminYear: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminYear-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminYear_DeleteByFilter_34F8A052DC83", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/AdminYear/GetAllByValue": { "post": { "tags": [ "AdminYear" ], "summary": "AdminYear: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminYear-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminYear_GetAllByValue_4CABF3EA1ABF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminYear" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminYear" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminYear" } } } } } } }, "/api/AdminYear/GetAllGraphByValue": { "post": { "tags": [ "AdminYear" ], "summary": "AdminYear: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminYear-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminYear_GetAllGraphByValue_DA59B4C95646", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminYear" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminYear" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminYear" } } } } } } }, "/api/AdminYear/GetByValue": { "post": { "tags": [ "AdminYear" ], "summary": "AdminYear: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminYear-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminYear_GetByValue_9F505AC129A7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminYear" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminYear" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminYear" } } } } } } }, "/api/AdminYear/GetLookup": { "post": { "tags": [ "AdminYear" ], "summary": "AdminYear: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminYear-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminYear_GetLookup_3BDA97D791F7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/AdminYear/GetLookupByValue": { "post": { "tags": [ "AdminYear" ], "summary": "AdminYear: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminYear-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminYear_GetLookupByValue_B9D5D8B853F9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/AdminYear/Page": { "get": { "tags": [ "AdminYear" ], "summary": "AdminYear: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminYear-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminYear_GetPage_5BAED0A66744", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AdminYear/PageAsc": { "get": { "tags": [ "AdminYear" ], "summary": "AdminYear: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminYear-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminYear_GetPageAsc_0721AC5B9016", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AdminYear/SearchByValue": { "post": { "tags": [ "AdminYear" ], "summary": "AdminYear: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminYear-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminYear_SearchByValue_82311BE5AD76", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AdminYear" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AdminYear" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AdminYear" } } } } } } }, "/api/AdminYear/TryGetByValue": { "post": { "tags": [ "AdminYear" ], "summary": "AdminYear: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminYear-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminYear_TryGetByValue_483BE78CC5D1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminYear" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminYear" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminYear" } } } } } } }, "/api/AdminYear/UpsertGraph": { "put": { "tags": [ "AdminYear" ], "summary": "AdminYear: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminYear-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminYear_UpsertGraph_63213F25314F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminYear" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminYear" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminYear" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminYear" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminYear" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminYear" } } } } } } }, "/api/AdminYear/UpsertGraphWithExtraFields": { "put": { "tags": [ "AdminYear" ], "summary": "AdminYear: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminYear-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminYear_UpsertGraphWithExtraFields_F077FFC99E1D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminYear" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminYear" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminYear" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminYear" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminYear" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminYear" } } } } } } }, "/api/AdminZip": { "get": { "tags": [ "AdminZip" ], "summary": "AdminZip: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminZip-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminZip_GetAll_B105D28DFDCD", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminZip" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminZip" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminZip" } } } } } }, "post": { "tags": [ "AdminZip" ], "summary": "AdminZip: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminZip-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminZip_Post_9A595A5C52A2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminZip" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminZip" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminZip" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminZip" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminZip" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminZip" } } } } } }, "put": { "tags": [ "AdminZip" ], "summary": "AdminZip: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminZip-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminZip_Put_5763F3335BD5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminZip" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminZip" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminZip" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminZip" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminZip" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminZip" } } } } } } }, "/api/AdminZip/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "AdminZip" ], "summary": "AdminZip: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminZip-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminZip_GetPageByValue_293D444FB0DD", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AdminZip/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "AdminZip" ], "summary": "AdminZip: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminZip-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminZip_GetPageByValue2_B02A9F1E23EF", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AdminZip/DeleteByFilter": { "post": { "tags": [ "AdminZip" ], "summary": "AdminZip: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminZip-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminZip_DeleteByFilter_3A4786302CC6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/AdminZip/GetAllByValue": { "post": { "tags": [ "AdminZip" ], "summary": "AdminZip: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminZip-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminZip_GetAllByValue_846B94ED50DE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminZip" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminZip" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminZip" } } } } } } }, "/api/AdminZip/GetAllGraphByValue": { "post": { "tags": [ "AdminZip" ], "summary": "AdminZip: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminZip-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminZip_GetAllGraphByValue_E0BEE8E50B87", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminZip" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminZip" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminZip" } } } } } } }, "/api/AdminZip/GetByValue": { "post": { "tags": [ "AdminZip" ], "summary": "AdminZip: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminZip-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminZip_GetByValue_9C04BDCDBFA4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminZip" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminZip" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminZip" } } } } } } }, "/api/AdminZip/GetLookup": { "post": { "tags": [ "AdminZip" ], "summary": "AdminZip: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminZip-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminZip_GetLookup_BD30FB221C15", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/AdminZip/GetLookupByValue": { "post": { "tags": [ "AdminZip" ], "summary": "AdminZip: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminZip-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminZip_GetLookupByValue_039DF9CE1853", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/AdminZip/Page": { "get": { "tags": [ "AdminZip" ], "summary": "AdminZip: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminZip-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminZip_GetPage_046343066BD6", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AdminZip/PageAsc": { "get": { "tags": [ "AdminZip" ], "summary": "AdminZip: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminZip-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminZip_GetPageAsc_6C3220031ECB", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AdminZip/SearchByValue": { "post": { "tags": [ "AdminZip" ], "summary": "AdminZip: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminZip-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminZip_SearchByValue_A2FEA3991053", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AdminZip" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AdminZip" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AdminZip" } } } } } } }, "/api/AdminZip/TryGetByValue": { "post": { "tags": [ "AdminZip" ], "summary": "AdminZip: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminZip-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminZip_TryGetByValue_6BABE2CD4830", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminZip" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminZip" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminZip" } } } } } } }, "/api/AdminZip/UpsertGraph": { "put": { "tags": [ "AdminZip" ], "summary": "AdminZip: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminZip-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminZip_UpsertGraph_49D4149EA802", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminZip" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminZip" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminZip" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminZip" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminZip" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminZip" } } } } } } }, "/api/AdminZip/UpsertGraphWithExtraFields": { "put": { "tags": [ "AdminZip" ], "summary": "AdminZip: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AdminZip-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AdminZip_UpsertGraphWithExtraFields_EFA0AC5F674C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminZip" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminZip" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminZip" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminZip" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminZip" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminZip" } } } } } } }, "/api/AI/AskAssistant": { "post": { "tags": [ "AI" ], "summary": "AI: AskAssistant", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AI_AskAssistant_D6B7DB47299C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Server.Controllers.AI.AIAssistantRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Server.Controllers.AI.AIAssistantRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Server.Controllers.AI.AIAssistantRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/AI/AskAssistantStream": { "post": { "tags": [ "AI" ], "summary": "AI: AskAssistantStream", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AI_AskAssistantStream_19AA974C18E8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Server.Controllers.AI.AIAssistantRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Server.Controllers.AI.AIAssistantRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Server.Controllers.AI.AIAssistantRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/AI/ChangeStyle": { "post": { "tags": [ "AI" ], "summary": "AI: ChangeStyle", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AI_ChangeStyle_8215B2132628", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Server.Controllers.AI.AIStyleRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Server.Controllers.AI.AIStyleRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Server.Controllers.AI.AIStyleRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/AI/ChangeTone": { "post": { "tags": [ "AI" ], "summary": "AI: ChangeTone", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AI_ChangeTone_43B28605F19A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Server.Controllers.AI.AIToneRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Server.Controllers.AI.AIToneRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Server.Controllers.AI.AIToneRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/AI/CustomEmailPrompt": { "post": { "tags": [ "AI" ], "summary": "AI: CustomEmailPrompt", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AI_CustomEmailPrompt_ABB261382381", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Server.Controllers.AI.AICustomEmailPromptRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Server.Controllers.AI.AICustomEmailPromptRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Server.Controllers.AI.AICustomEmailPromptRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/AI/CustomTextPrompt": { "post": { "tags": [ "AI" ], "summary": "AI: CustomTextPrompt", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AI_CustomTextPrompt_760ABE34E3D7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Server.Controllers.AI.AICustomTextPromptRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Server.Controllers.AI.AICustomTextPromptRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Server.Controllers.AI.AICustomTextPromptRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/AI/Expand": { "post": { "tags": [ "AI" ], "summary": "AI: Expand", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AI_Expand_D5BEFF48292E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Server.Controllers.AI.AITextRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Server.Controllers.AI.AITextRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Server.Controllers.AI.AITextRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/AI/ExtractPartnerFromEmail": { "post": { "tags": [ "AI" ], "summary": "AI: ExtractPartnerFromEmail", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AI_ExtractPartnerFromEmail_069EE5DF5DFE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Server.Controllers.AI.AIExtractPartnerFromEmailRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Server.Controllers.AI.AIExtractPartnerFromEmailRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Server.Controllers.AI.AIExtractPartnerFromEmailRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/AI/Proofread": { "post": { "tags": [ "AI" ], "summary": "AI: Proofread", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AI_Proofread_C932CDA17CC2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Server.Controllers.AI.AITextRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Server.Controllers.AI.AITextRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Server.Controllers.AI.AITextRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/AI/SaveDroppedFile": { "post": { "tags": [ "AI" ], "summary": "AI: SaveDroppedFile", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AI_SaveDroppedFile_A7F26E8E6F6E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Server.Controllers.AI.AISaveDroppedFileRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Server.Controllers.AI.AISaveDroppedFileRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Server.Controllers.AI.AISaveDroppedFileRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/AI/Shorten": { "post": { "tags": [ "AI" ], "summary": "AI: Shorten", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AI_Shorten_5DB9C515BAE1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Server.Controllers.AI.AITextRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Server.Controllers.AI.AITextRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Server.Controllers.AI.AITextRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/AI/SpeakText": { "post": { "tags": [ "AI" ], "summary": "AI: SpeakText", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AI_SpeakText_4B6685D52C6F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Server.Controllers.AI.AITextRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Server.Controllers.AI.AITextRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Server.Controllers.AI.AITextRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/AI/Summarize": { "post": { "tags": [ "AI" ], "summary": "AI: Summarize", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AI_Summarize_674A701D994C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Server.Controllers.AI.AITextRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Server.Controllers.AI.AITextRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Server.Controllers.AI.AITextRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/AI/Translate": { "post": { "tags": [ "AI" ], "summary": "AI: Translate", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AI_Translate_A16E756575DE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Server.Controllers.AI.AITranslateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Server.Controllers.AI.AITranslateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Server.Controllers.AI.AITranslateRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/AiChatInfo": { "get": { "tags": [ "AiChatInfo" ], "summary": "AiChatInfo: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AiChatInfo-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AiChatInfo_GetAll_578617833AA7", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AiChatInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AiChatInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AiChatInfo" } } } } } }, "post": { "tags": [ "AiChatInfo" ], "summary": "AiChatInfo: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AiChatInfo-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AiChatInfo_Post_7679EB2AEA6C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AiChatInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AiChatInfo" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AiChatInfo" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AiChatInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AiChatInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AiChatInfo" } } } } } }, "put": { "tags": [ "AiChatInfo" ], "summary": "AiChatInfo: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AiChatInfo-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AiChatInfo_Put_F5A51A18AB3B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AiChatInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AiChatInfo" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AiChatInfo" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AiChatInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AiChatInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AiChatInfo" } } } } } } }, "/api/AiChatInfo/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "AiChatInfo" ], "summary": "AiChatInfo: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AiChatInfo-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AiChatInfo_GetPageByValue_4C3ADEF84212", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AiChatInfo/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "AiChatInfo" ], "summary": "AiChatInfo: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AiChatInfo-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AiChatInfo_GetPageByValue2_9A705D3918FC", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AiChatInfo/DeleteByFilter": { "post": { "tags": [ "AiChatInfo" ], "summary": "AiChatInfo: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AiChatInfo-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AiChatInfo_DeleteByFilter_1761B3B746E8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/AiChatInfo/GetAllByValue": { "post": { "tags": [ "AiChatInfo" ], "summary": "AiChatInfo: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AiChatInfo-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AiChatInfo_GetAllByValue_1AF6F1FC76C3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AiChatInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AiChatInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AiChatInfo" } } } } } } }, "/api/AiChatInfo/GetAllGraphByValue": { "post": { "tags": [ "AiChatInfo" ], "summary": "AiChatInfo: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AiChatInfo-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AiChatInfo_GetAllGraphByValue_31906541C6D8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AiChatInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AiChatInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AiChatInfo" } } } } } } }, "/api/AiChatInfo/GetByValue": { "post": { "tags": [ "AiChatInfo" ], "summary": "AiChatInfo: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AiChatInfo-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AiChatInfo_GetByValue_B940EFB461B9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AiChatInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AiChatInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AiChatInfo" } } } } } } }, "/api/AiChatInfo/GetLookup": { "post": { "tags": [ "AiChatInfo" ], "summary": "AiChatInfo: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AiChatInfo-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AiChatInfo_GetLookup_922C27DFAB3D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/AiChatInfo/GetLookupByValue": { "post": { "tags": [ "AiChatInfo" ], "summary": "AiChatInfo: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AiChatInfo-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AiChatInfo_GetLookupByValue_913BA9FD00EF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/AiChatInfo/Page": { "get": { "tags": [ "AiChatInfo" ], "summary": "AiChatInfo: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AiChatInfo-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AiChatInfo_GetPage_B92339C4C12D", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AiChatInfo/PageAsc": { "get": { "tags": [ "AiChatInfo" ], "summary": "AiChatInfo: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AiChatInfo-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AiChatInfo_GetPageAsc_1C4481466AF0", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AiChatInfo/SearchByValue": { "post": { "tags": [ "AiChatInfo" ], "summary": "AiChatInfo: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AiChatInfo-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AiChatInfo_SearchByValue_DBC128F24B90", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AiChatInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AiChatInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AiChatInfo" } } } } } } }, "/api/AiChatInfo/TryGetByValue": { "post": { "tags": [ "AiChatInfo" ], "summary": "AiChatInfo: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AiChatInfo-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AiChatInfo_TryGetByValue_BD67983D12EC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AiChatInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AiChatInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AiChatInfo" } } } } } } }, "/api/AiChatInfo/UpsertGraph": { "put": { "tags": [ "AiChatInfo" ], "summary": "AiChatInfo: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AiChatInfo-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AiChatInfo_UpsertGraph_F682C1BC75F4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AiChatInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AiChatInfo" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AiChatInfo" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AiChatInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AiChatInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AiChatInfo" } } } } } } }, "/api/AiChatInfo/UpsertGraphWithExtraFields": { "put": { "tags": [ "AiChatInfo" ], "summary": "AiChatInfo: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AiChatInfo-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AiChatInfo_UpsertGraphWithExtraFields_3964DE11324D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AiChatInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AiChatInfo" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AiChatInfo" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AiChatInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AiChatInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AiChatInfo" } } } } } } }, "/api/AiChatSetting": { "get": { "tags": [ "AiChatSetting" ], "summary": "AiChatSetting: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AiChatSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AiChatSetting_GetAll_68999EBCB209", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AiChatSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AiChatSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AiChatSetting" } } } } } }, "post": { "tags": [ "AiChatSetting" ], "summary": "AiChatSetting: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AiChatSetting-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AiChatSetting_Post_AC63C8032011", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AiChatSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AiChatSetting" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AiChatSetting" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AiChatSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AiChatSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AiChatSetting" } } } } } }, "put": { "tags": [ "AiChatSetting" ], "summary": "AiChatSetting: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AiChatSetting-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AiChatSetting_Put_3EF1C49150AC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AiChatSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AiChatSetting" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AiChatSetting" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AiChatSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AiChatSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AiChatSetting" } } } } } } }, "/api/AiChatSetting/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "AiChatSetting" ], "summary": "AiChatSetting: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AiChatSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AiChatSetting_GetPageByValue_CCE323CEC941", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AiChatSetting/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "AiChatSetting" ], "summary": "AiChatSetting: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AiChatSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AiChatSetting_GetPageByValue2_77C5B9C08E2B", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AiChatSetting/DeleteByFilter": { "post": { "tags": [ "AiChatSetting" ], "summary": "AiChatSetting: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AiChatSetting-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AiChatSetting_DeleteByFilter_3630BFDBC846", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/AiChatSetting/GetAllByValue": { "post": { "tags": [ "AiChatSetting" ], "summary": "AiChatSetting: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AiChatSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AiChatSetting_GetAllByValue_E82B6CC558BD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AiChatSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AiChatSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AiChatSetting" } } } } } } }, "/api/AiChatSetting/GetAllGraphByValue": { "post": { "tags": [ "AiChatSetting" ], "summary": "AiChatSetting: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AiChatSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AiChatSetting_GetAllGraphByValue_41AFF649B564", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AiChatSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AiChatSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AiChatSetting" } } } } } } }, "/api/AiChatSetting/GetByValue": { "post": { "tags": [ "AiChatSetting" ], "summary": "AiChatSetting: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AiChatSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AiChatSetting_GetByValue_095F73D9CB73", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AiChatSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AiChatSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AiChatSetting" } } } } } } }, "/api/AiChatSetting/GetLookup": { "post": { "tags": [ "AiChatSetting" ], "summary": "AiChatSetting: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AiChatSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AiChatSetting_GetLookup_035A790F6124", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/AiChatSetting/GetLookupByValue": { "post": { "tags": [ "AiChatSetting" ], "summary": "AiChatSetting: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AiChatSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AiChatSetting_GetLookupByValue_B69B1092A172", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/AiChatSetting/Page": { "get": { "tags": [ "AiChatSetting" ], "summary": "AiChatSetting: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AiChatSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AiChatSetting_GetPage_EACE25B48D0A", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AiChatSetting/PageAsc": { "get": { "tags": [ "AiChatSetting" ], "summary": "AiChatSetting: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AiChatSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AiChatSetting_GetPageAsc_E5F4CB5A7FA3", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AiChatSetting/SearchByValue": { "post": { "tags": [ "AiChatSetting" ], "summary": "AiChatSetting: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AiChatSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AiChatSetting_SearchByValue_BB895E86A7F5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AiChatSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AiChatSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AiChatSetting" } } } } } } }, "/api/AiChatSetting/TryGetByValue": { "post": { "tags": [ "AiChatSetting" ], "summary": "AiChatSetting: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AiChatSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AiChatSetting_TryGetByValue_9F12F6E90C31", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AiChatSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AiChatSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AiChatSetting" } } } } } } }, "/api/AiChatSetting/UpsertGraph": { "put": { "tags": [ "AiChatSetting" ], "summary": "AiChatSetting: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AiChatSetting-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AiChatSetting_UpsertGraph_3DA7560FF5F7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AiChatSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AiChatSetting" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AiChatSetting" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AiChatSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AiChatSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AiChatSetting" } } } } } } }, "/api/AiChatSetting/UpsertGraphWithExtraFields": { "put": { "tags": [ "AiChatSetting" ], "summary": "AiChatSetting: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AiChatSetting-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AiChatSetting_UpsertGraphWithExtraFields_029650A07DBF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AiChatSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AiChatSetting" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AiChatSetting" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AiChatSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AiChatSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AiChatSetting" } } } } } } }, "/api/AiEmailInfo": { "get": { "tags": [ "AiEmailInfo" ], "summary": "AiEmailInfo: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AiEmailInfo-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AiEmailInfo_GetAll_9F0343665F46", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AiEmailInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AiEmailInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AiEmailInfo" } } } } } }, "post": { "tags": [ "AiEmailInfo" ], "summary": "AiEmailInfo: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AiEmailInfo-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AiEmailInfo_Post_FACDC3490852", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AiEmailInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AiEmailInfo" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AiEmailInfo" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AiEmailInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AiEmailInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AiEmailInfo" } } } } } }, "put": { "tags": [ "AiEmailInfo" ], "summary": "AiEmailInfo: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AiEmailInfo-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AiEmailInfo_Put_CBD8D0B6E052", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AiEmailInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AiEmailInfo" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AiEmailInfo" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AiEmailInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AiEmailInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AiEmailInfo" } } } } } } }, "/api/AiEmailInfo/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "AiEmailInfo" ], "summary": "AiEmailInfo: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AiEmailInfo-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AiEmailInfo_GetPageByValue_1C005F70346E", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AiEmailInfo/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "AiEmailInfo" ], "summary": "AiEmailInfo: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AiEmailInfo-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AiEmailInfo_GetPageByValue2_DFB0206B35E2", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AiEmailInfo/DeleteByFilter": { "post": { "tags": [ "AiEmailInfo" ], "summary": "AiEmailInfo: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AiEmailInfo-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AiEmailInfo_DeleteByFilter_4FAF6E59FC52", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/AiEmailInfo/GetAllByValue": { "post": { "tags": [ "AiEmailInfo" ], "summary": "AiEmailInfo: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AiEmailInfo-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AiEmailInfo_GetAllByValue_7A31BC8CE6AE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AiEmailInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AiEmailInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AiEmailInfo" } } } } } } }, "/api/AiEmailInfo/GetAllGraphByValue": { "post": { "tags": [ "AiEmailInfo" ], "summary": "AiEmailInfo: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AiEmailInfo-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AiEmailInfo_GetAllGraphByValue_FDD592C26701", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AiEmailInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AiEmailInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AiEmailInfo" } } } } } } }, "/api/AiEmailInfo/GetByValue": { "post": { "tags": [ "AiEmailInfo" ], "summary": "AiEmailInfo: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AiEmailInfo-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AiEmailInfo_GetByValue_FE160B7C4DEA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AiEmailInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AiEmailInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AiEmailInfo" } } } } } } }, "/api/AiEmailInfo/GetLookup": { "post": { "tags": [ "AiEmailInfo" ], "summary": "AiEmailInfo: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AiEmailInfo-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AiEmailInfo_GetLookup_031193EE6A61", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/AiEmailInfo/GetLookupByValue": { "post": { "tags": [ "AiEmailInfo" ], "summary": "AiEmailInfo: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AiEmailInfo-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AiEmailInfo_GetLookupByValue_84C6486827A4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/AiEmailInfo/Page": { "get": { "tags": [ "AiEmailInfo" ], "summary": "AiEmailInfo: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AiEmailInfo-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AiEmailInfo_GetPage_63EFB2FC62E2", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AiEmailInfo/PageAsc": { "get": { "tags": [ "AiEmailInfo" ], "summary": "AiEmailInfo: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AiEmailInfo-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AiEmailInfo_GetPageAsc_87EC6BE3CEDF", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AiEmailInfo/SearchByValue": { "post": { "tags": [ "AiEmailInfo" ], "summary": "AiEmailInfo: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AiEmailInfo-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AiEmailInfo_SearchByValue_897050BB75C1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AiEmailInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AiEmailInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AiEmailInfo" } } } } } } }, "/api/AiEmailInfo/TryGetByValue": { "post": { "tags": [ "AiEmailInfo" ], "summary": "AiEmailInfo: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AiEmailInfo-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AiEmailInfo_TryGetByValue_E357A6FA55C3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AiEmailInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AiEmailInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AiEmailInfo" } } } } } } }, "/api/AiEmailInfo/UpsertGraph": { "put": { "tags": [ "AiEmailInfo" ], "summary": "AiEmailInfo: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AiEmailInfo-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AiEmailInfo_UpsertGraph_E4F690CE73BA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AiEmailInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AiEmailInfo" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AiEmailInfo" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AiEmailInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AiEmailInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AiEmailInfo" } } } } } } }, "/api/AiEmailInfo/UpsertGraphWithExtraFields": { "put": { "tags": [ "AiEmailInfo" ], "summary": "AiEmailInfo: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AiEmailInfo-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AiEmailInfo_UpsertGraphWithExtraFields_909FFB156DD9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AiEmailInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AiEmailInfo" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AiEmailInfo" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AiEmailInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AiEmailInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AiEmailInfo" } } } } } } }, "/api/AiEmbedding": { "get": { "tags": [ "AiEmbedding" ], "summary": "AiEmbedding: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AiEmbedding-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AiEmbedding_GetAll_E3927B00224E", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AiEmbedding" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AiEmbedding" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AiEmbedding" } } } } } }, "post": { "tags": [ "AiEmbedding" ], "summary": "AiEmbedding: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AiEmbedding-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AiEmbedding_Post_736B3E6C7681", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AiEmbedding" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AiEmbedding" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AiEmbedding" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AiEmbedding" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AiEmbedding" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AiEmbedding" } } } } } }, "put": { "tags": [ "AiEmbedding" ], "summary": "AiEmbedding: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AiEmbedding-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AiEmbedding_Put_1B39EA64A8AB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AiEmbedding" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AiEmbedding" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AiEmbedding" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AiEmbedding" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AiEmbedding" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AiEmbedding" } } } } } } }, "/api/AiEmbedding/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "AiEmbedding" ], "summary": "AiEmbedding: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AiEmbedding-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AiEmbedding_GetPageByValue_75D6F9C49219", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AiEmbedding/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "AiEmbedding" ], "summary": "AiEmbedding: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AiEmbedding-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AiEmbedding_GetPageByValue2_7531155A2941", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AiEmbedding/DeleteByFilter": { "post": { "tags": [ "AiEmbedding" ], "summary": "AiEmbedding: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AiEmbedding-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AiEmbedding_DeleteByFilter_174FD2F2C7D3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/AiEmbedding/GetAllByValue": { "post": { "tags": [ "AiEmbedding" ], "summary": "AiEmbedding: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AiEmbedding-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AiEmbedding_GetAllByValue_85518604A4E1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AiEmbedding" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AiEmbedding" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AiEmbedding" } } } } } } }, "/api/AiEmbedding/GetAllGraphByValue": { "post": { "tags": [ "AiEmbedding" ], "summary": "AiEmbedding: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AiEmbedding-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AiEmbedding_GetAllGraphByValue_45620F202F36", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AiEmbedding" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AiEmbedding" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AiEmbedding" } } } } } } }, "/api/AiEmbedding/GetByValue": { "post": { "tags": [ "AiEmbedding" ], "summary": "AiEmbedding: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AiEmbedding-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AiEmbedding_GetByValue_9613B6A9D87F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AiEmbedding" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AiEmbedding" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AiEmbedding" } } } } } } }, "/api/AiEmbedding/GetLookup": { "post": { "tags": [ "AiEmbedding" ], "summary": "AiEmbedding: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AiEmbedding-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AiEmbedding_GetLookup_D4892237EAFC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/AiEmbedding/GetLookupByValue": { "post": { "tags": [ "AiEmbedding" ], "summary": "AiEmbedding: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AiEmbedding-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AiEmbedding_GetLookupByValue_2FC1D0D9B950", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/AiEmbedding/Page": { "get": { "tags": [ "AiEmbedding" ], "summary": "AiEmbedding: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AiEmbedding-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AiEmbedding_GetPage_A853D56A0066", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AiEmbedding/PageAsc": { "get": { "tags": [ "AiEmbedding" ], "summary": "AiEmbedding: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AiEmbedding-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AiEmbedding_GetPageAsc_4AFF5B38250B", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AiEmbedding/SearchByValue": { "post": { "tags": [ "AiEmbedding" ], "summary": "AiEmbedding: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AiEmbedding-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AiEmbedding_SearchByValue_29C026E73533", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AiEmbedding" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AiEmbedding" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AiEmbedding" } } } } } } }, "/api/AiEmbedding/TryGetByValue": { "post": { "tags": [ "AiEmbedding" ], "summary": "AiEmbedding: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AiEmbedding-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AiEmbedding_TryGetByValue_1A2D8511D71E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AiEmbedding" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AiEmbedding" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AiEmbedding" } } } } } } }, "/api/AiEmbedding/UpsertGraph": { "put": { "tags": [ "AiEmbedding" ], "summary": "AiEmbedding: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AiEmbedding-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AiEmbedding_UpsertGraph_8B7EA17344F5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AiEmbedding" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AiEmbedding" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AiEmbedding" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AiEmbedding" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AiEmbedding" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AiEmbedding" } } } } } } }, "/api/AiEmbedding/UpsertGraphWithExtraFields": { "put": { "tags": [ "AiEmbedding" ], "summary": "AiEmbedding: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AiEmbedding-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AiEmbedding_UpsertGraphWithExtraFields_7DBE47F3151F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AiEmbedding" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AiEmbedding" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AiEmbedding" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AiEmbedding" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AiEmbedding" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AiEmbedding" } } } } } } }, "/api/AiTextInfo": { "get": { "tags": [ "AiTextInfo" ], "summary": "AiTextInfo: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AiTextInfo-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AiTextInfo_GetAll_E68AF7B3D3F4", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AiTextInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AiTextInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AiTextInfo" } } } } } }, "post": { "tags": [ "AiTextInfo" ], "summary": "AiTextInfo: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AiTextInfo-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AiTextInfo_Post_8FF990C41E1B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AiTextInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AiTextInfo" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AiTextInfo" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AiTextInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AiTextInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AiTextInfo" } } } } } }, "put": { "tags": [ "AiTextInfo" ], "summary": "AiTextInfo: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AiTextInfo-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AiTextInfo_Put_93D60BD532B2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AiTextInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AiTextInfo" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AiTextInfo" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AiTextInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AiTextInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AiTextInfo" } } } } } } }, "/api/AiTextInfo/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "AiTextInfo" ], "summary": "AiTextInfo: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AiTextInfo-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AiTextInfo_GetPageByValue_48A9EDFEA7B0", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AiTextInfo/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "AiTextInfo" ], "summary": "AiTextInfo: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AiTextInfo-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AiTextInfo_GetPageByValue2_2AFE9FBCD29F", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AiTextInfo/DeleteByFilter": { "post": { "tags": [ "AiTextInfo" ], "summary": "AiTextInfo: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AiTextInfo-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AiTextInfo_DeleteByFilter_E1541F233CA6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/AiTextInfo/GetAllByValue": { "post": { "tags": [ "AiTextInfo" ], "summary": "AiTextInfo: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AiTextInfo-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AiTextInfo_GetAllByValue_63A6D81B9CEA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AiTextInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AiTextInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AiTextInfo" } } } } } } }, "/api/AiTextInfo/GetAllGraphByValue": { "post": { "tags": [ "AiTextInfo" ], "summary": "AiTextInfo: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AiTextInfo-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AiTextInfo_GetAllGraphByValue_F016F8E1FA5D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AiTextInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AiTextInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AiTextInfo" } } } } } } }, "/api/AiTextInfo/GetByValue": { "post": { "tags": [ "AiTextInfo" ], "summary": "AiTextInfo: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AiTextInfo-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AiTextInfo_GetByValue_48FFAA2EBFA2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AiTextInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AiTextInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AiTextInfo" } } } } } } }, "/api/AiTextInfo/GetLookup": { "post": { "tags": [ "AiTextInfo" ], "summary": "AiTextInfo: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AiTextInfo-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AiTextInfo_GetLookup_9F324A00678E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/AiTextInfo/GetLookupByValue": { "post": { "tags": [ "AiTextInfo" ], "summary": "AiTextInfo: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AiTextInfo-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AiTextInfo_GetLookupByValue_4FF8B17EEAEC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/AiTextInfo/Page": { "get": { "tags": [ "AiTextInfo" ], "summary": "AiTextInfo: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AiTextInfo-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AiTextInfo_GetPage_B203D8D28BB9", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AiTextInfo/PageAsc": { "get": { "tags": [ "AiTextInfo" ], "summary": "AiTextInfo: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AiTextInfo-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AiTextInfo_GetPageAsc_E816BC2066CD", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AiTextInfo/SearchByValue": { "post": { "tags": [ "AiTextInfo" ], "summary": "AiTextInfo: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AiTextInfo-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AiTextInfo_SearchByValue_780FB34B3070", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AiTextInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AiTextInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AiTextInfo" } } } } } } }, "/api/AiTextInfo/TryGetByValue": { "post": { "tags": [ "AiTextInfo" ], "summary": "AiTextInfo: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AiTextInfo-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AiTextInfo_TryGetByValue_6C552067CD01", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AiTextInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AiTextInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AiTextInfo" } } } } } } }, "/api/AiTextInfo/UpsertGraph": { "put": { "tags": [ "AiTextInfo" ], "summary": "AiTextInfo: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AiTextInfo-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AiTextInfo_UpsertGraph_FD7081578B0C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AiTextInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AiTextInfo" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AiTextInfo" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AiTextInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AiTextInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AiTextInfo" } } } } } } }, "/api/AiTextInfo/UpsertGraphWithExtraFields": { "put": { "tags": [ "AiTextInfo" ], "summary": "AiTextInfo: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AiTextInfo-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AiTextInfo_UpsertGraphWithExtraFields_093EFBA3A46D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AiTextInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AiTextInfo" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AiTextInfo" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AiTextInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AiTextInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AiTextInfo" } } } } } } }, "/api/AppRole": { "get": { "tags": [ "AppRole" ], "summary": "AppRole: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AppRole-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AppRole_GetAll_124D2B2C11B8", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Email" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Email" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Email" } } } } } }, "post": { "tags": [ "AppRole" ], "summary": "AppRole: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AppRole-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AppRole_Post_5784653216FD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Email" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Email" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Email" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Email" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Email" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Email" } } } } } }, "put": { "tags": [ "AppRole" ], "summary": "AppRole: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AppRole-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AppRole_Put_087FCE1EF222", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Email" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Email" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Email" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Email" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Email" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Email" } } } } } } }, "/api/AppRole/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "AppRole" ], "summary": "AppRole: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AppRole-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AppRole_GetPageByValue_EDDC59DCE7D6", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AppRole/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "AppRole" ], "summary": "AppRole: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AppRole-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AppRole_GetPageByValue2_46A3A4EE79FD", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AppRole/CreateRole": { "post": { "tags": [ "AppRole" ], "summary": "AppRole: CreateRole", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AppRole-Create.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AppRole_CreateRole_60521FCA50CB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AppRoleDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AppRoleDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AppRoleDto" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AppRoleDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AppRoleDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AppRoleDto" } } } } } } }, "/api/AppRole/DeleteByFilter": { "post": { "tags": [ "AppRole" ], "summary": "AppRole: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AppRole-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AppRole_DeleteByFilter_C5AC2F7106F0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/AppRole/DeleteRole": { "post": { "tags": [ "AppRole" ], "summary": "AppRole: DeleteRole", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AppRole-Delete.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AppRole_DeleteRole_01EA311C3798", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AppRole_DeleteRoleRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AppRole_DeleteRoleRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AppRole_DeleteRoleRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/AppRole/GetAll": { "get": { "tags": [ "AppRole" ], "summary": "AppRole: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AppRole-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AppRole_GetAll_BA54B23887A3", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AppRoleDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AppRoleDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AppRoleDto" } } } } } } }, "/api/AppRole/GetAllByValue": { "post": { "tags": [ "AppRole" ], "summary": "AppRole: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AppRole-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AppRole_GetAllByValue_41B0CA1A8C76", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Email" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Email" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Email" } } } } } } }, "/api/AppRole/GetAllGraphByValue": { "post": { "tags": [ "AppRole" ], "summary": "AppRole: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AppRole-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AppRole_GetAllGraphByValue_2B9F76766973", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Email" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Email" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Email" } } } } } } }, "/api/AppRole/GetByValue": { "post": { "tags": [ "AppRole" ], "summary": "AppRole: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AppRole-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AppRole_GetByValue_E3B5BFFBAAEB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Email" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Email" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Email" } } } } } } }, "/api/AppRole/GetCurrentUserRoleIds": { "get": { "tags": [ "AppRole" ], "summary": "AppRole: GetCurrentUserRoleIds", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AppRole_GetCurrentUserRoleIds_90480FB909E0", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_System.String" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_System.String" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_System.String" } } } } } } }, "/api/AppRole/GetCurrentWorkspaceRoleMenuVisibility": { "get": { "tags": [ "AppRole" ], "summary": "AppRole: GetCurrentWorkspaceRoleMenuVisibility", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AppRole_GetCurrentWorkspaceRoleMenuVisibility_DA7BE1F87DAF", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.MenuVisibilityDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.MenuVisibilityDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.MenuVisibilityDto" } } } } } } }, "/api/AppRole/GetLookup": { "post": { "tags": [ "AppRole" ], "summary": "AppRole: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AppRole-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AppRole_GetLookup_30551B530975", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/AppRole/GetLookupByValue": { "post": { "tags": [ "AppRole" ], "summary": "AppRole: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AppRole-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AppRole_GetLookupByValue_1B6BD1C59780", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/AppRole/GetPage": { "get": { "tags": [ "AppRole" ], "summary": "AppRole: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AppRole-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AppRole_GetPage_8442B662DF53", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AppRole/GetRoleAllPagesPermission": { "post": { "tags": [ "AppRole" ], "summary": "AppRole: GetRoleAllPagesPermission", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AppRole-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AppRole_GetRoleAllPagesPermission_55288E2B026D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AppRole_GetRoleAllPagesPermissionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AppRole_GetRoleAllPagesPermissionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AppRole_GetRoleAllPagesPermissionRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.RoleAllPagesPermissionDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.RoleAllPagesPermissionDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.RoleAllPagesPermissionDto" } } } } } } }, "/api/AppRole/GetRoleAllWebApisPermission": { "post": { "tags": [ "AppRole" ], "summary": "AppRole: GetRoleAllWebApisPermission", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AppRole-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AppRole_GetRoleAllWebApisPermission_1A6986228013", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AppRole_GetRoleAllWebApisPermissionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AppRole_GetRoleAllWebApisPermissionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AppRole_GetRoleAllWebApisPermissionRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.RoleAllWebApisPermissionDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.RoleAllWebApisPermissionDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.RoleAllWebApisPermissionDto" } } } } } } }, "/api/AppRole/Page": { "get": { "tags": [ "AppRole" ], "summary": "AppRole: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AppRole-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AppRole_GetPage_2F4D4F766C15", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AppRole/PageAsc": { "get": { "tags": [ "AppRole" ], "summary": "AppRole: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AppRole-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AppRole_GetPageAsc_4D47D9C91CE5", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AppRole/SearchByValue": { "post": { "tags": [ "AppRole" ], "summary": "AppRole: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AppRole-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AppRole_SearchByValue_D571519893E8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.Email" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.Email" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.Email" } } } } } } }, "/api/AppRole/TryGetByValue": { "post": { "tags": [ "AppRole" ], "summary": "AppRole: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AppRole-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AppRole_TryGetByValue_A6391E9CD500", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Email" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Email" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Email" } } } } } } }, "/api/AppRole/UpdateRole": { "put": { "tags": [ "AppRole" ], "summary": "AppRole: UpdateRole", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AppRole-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AppRole_UpdateRole_885001804EC6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AppRoleDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AppRoleDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AppRoleDto" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AppRoleDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AppRoleDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AppRoleDto" } } } } } } }, "/api/AppRole/UpsertGraph": { "put": { "tags": [ "AppRole" ], "summary": "AppRole: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AppRole-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AppRole_UpsertGraph_F978D6FD91D8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Email" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Email" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Email" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Email" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Email" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Email" } } } } } } }, "/api/AppRole/UpsertGraphWithExtraFields": { "put": { "tags": [ "AppRole" ], "summary": "AppRole: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AppRole-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AppRole_UpsertGraphWithExtraFields_697A467E926D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Email" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Email" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Email" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Email" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Email" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Email" } } } } } } }, "/api/AppUser": { "get": { "tags": [ "AppUser" ], "summary": "AppUser: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AppUser-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AppUser_GetAll_D61B3C3BC3F8", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AppUser" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AppUser" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AppUser" } } } } } }, "post": { "tags": [ "AppUser" ], "summary": "AppUser: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AppUser-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AppUser_Post_D7ACBAFC7197", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AppUser" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AppUser" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AppUser" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AppUser" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AppUser" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AppUser" } } } } } }, "put": { "tags": [ "AppUser" ], "summary": "AppUser: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AppUser-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AppUser_Put_943CFCA21B27", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AppUser" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AppUser" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AppUser" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AppUser" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AppUser" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AppUser" } } } } } } }, "/api/AppUser/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "AppUser" ], "summary": "AppUser: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AppUser-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AppUser_GetPageByValue_0EBD1E1C6409", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AppUser/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "AppUser" ], "summary": "AppUser: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AppUser-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AppUser_GetPageByValue2_C9A012B8F502", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AppUser/CreateUser": { "post": { "tags": [ "AppUser" ], "summary": "AppUser: CreateUser", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AppUser-Create.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AppUser_CreateUser_AC71114A3839", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AppUserDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AppUserDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AppUserDto" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AppUserDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AppUserDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AppUserDto" } } } } } } }, "/api/AppUser/DeleteByFilter": { "post": { "tags": [ "AppUser" ], "summary": "AppUser: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AppUser-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AppUser_DeleteByFilter_3A357A1A96E9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/AppUser/DeleteUser": { "post": { "tags": [ "AppUser" ], "summary": "AppUser: DeleteUser", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AppUser-Delete.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AppUser_DeleteUser_4D3D5DB7AD35", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AppUser_DeleteUserRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AppUser_DeleteUserRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AppUser_DeleteUserRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/AppUser/GetActiveUsersCount": { "get": { "tags": [ "AppUser" ], "summary": "AppUser: GetActiveUsersCount", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AppUser-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AppUser_GetActiveUsersCount_53CFEEC384D6", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/AppUser/GetAll": { "get": { "tags": [ "AppUser" ], "summary": "AppUser: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AppUser-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AppUser_GetAll_EDE508440EE2", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AppUserDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AppUserDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AppUserDto" } } } } } } }, "/api/AppUser/GetAllByValue": { "post": { "tags": [ "AppUser" ], "summary": "AppUser: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AppUser-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AppUser_GetAllByValue_A7656279D2A8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AppUser" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AppUser" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AppUser" } } } } } } }, "/api/AppUser/GetAllGraphByValue": { "post": { "tags": [ "AppUser" ], "summary": "AppUser: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AppUser-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AppUser_GetAllGraphByValue_68CAF80189DF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AppUser" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AppUser" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AppUser" } } } } } } }, "/api/AppUser/GetByUserName": { "post": { "tags": [ "AppUser" ], "summary": "AppUser: GetByUserName", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AppUser-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AppUser_GetByUserName_28801A0B9254", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AppUser_GetByUserNameRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AppUser_GetByUserNameRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AppUser_GetByUserNameRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AppUserDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AppUserDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AppUserDto" } } } } } } }, "/api/AppUser/GetByValue": { "post": { "tags": [ "AppUser" ], "summary": "AppUser: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AppUser-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AppUser_GetByValue_946A379B2ABF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AppUser" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AppUser" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AppUser" } } } } } } }, "/api/AppUser/GetCurrentUserCultureCode": { "get": { "tags": [ "AppUser" ], "summary": "AppUser: GetCurrentUserCultureCode", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AppUser_GetCurrentUserCultureCode_E4C249589258", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.String" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.String" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.String" } } } } } } }, "/api/AppUser/GetCurrentUserUiPermissions": { "get": { "tags": [ "AppUser" ], "summary": "AppUser: GetCurrentUserUiPermissions", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AppUser-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AppUser_GetCurrentUserUiPermissions_7854BA70F062", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_System.String" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_System.String" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_System.String" } } } } } } }, "/api/AppUser/GetEmailAccount": { "post": { "tags": [ "AppUser" ], "summary": "AppUser: GetEmailAccount", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AppUser-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AppUser_GetEmailAccount_424B7A9E1FBB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AppUser_GetEmailAccountRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AppUser_GetEmailAccountRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AppUser_GetEmailAccountRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailAccount" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailAccount" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailAccount" } } } } } } }, "/api/AppUser/GetLookup": { "post": { "tags": [ "AppUser" ], "summary": "AppUser: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AppUser-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AppUser_GetLookup_D416D5449495", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/AppUser/GetLookupByValue": { "post": { "tags": [ "AppUser" ], "summary": "AppUser: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AppUser-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AppUser_GetLookupByValue_AA60A5299862", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/AppUser/GetPage": { "get": { "tags": [ "AppUser" ], "summary": "AppUser: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AppUser-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AppUser_GetPage_D8D95D2A5C95", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AppUser/GetUserLinkedWithEmployee": { "post": { "tags": [ "AppUser" ], "summary": "AppUser: GetUserLinkedWithEmployee", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AppUser-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AppUser_GetUserLinkedWithEmployee_6E5051160504", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AppUser_GetUserLinkedWithEmployeeRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AppUser_GetUserLinkedWithEmployeeRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AppUser_GetUserLinkedWithEmployeeRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AppUser" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AppUser" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AppUser" } } } } } } }, "/api/AppUser/GetUserRole": { "post": { "tags": [ "AppUser" ], "summary": "AppUser: GetUserRole", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AppUser-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AppUser_GetUserRole_FA3C84E1C489", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AppUser_GetUserRoleRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AppUser_GetUserRoleRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AppUser_GetUserRoleRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AppRoleDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AppRoleDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AppRoleDto" } } } } } } }, "/api/AppUser/IsActiveUsersLimitExceeded": { "get": { "tags": [ "AppUser" ], "summary": "AppUser: IsActiveUsersLimitExceeded", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AppUser-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AppUser_IsActiveUsersLimitExceeded_AAC85CDF7EE7", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/AppUser/Page": { "get": { "tags": [ "AppUser" ], "summary": "AppUser: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AppUser-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AppUser_GetPage_4C14C7F805B3", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AppUser/PageAsc": { "get": { "tags": [ "AppUser" ], "summary": "AppUser: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AppUser-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AppUser_GetPageAsc_6CB59843407C", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AppUser/SearchByValue": { "post": { "tags": [ "AppUser" ], "summary": "AppUser: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AppUser-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AppUser_SearchByValue_2883D6019FD9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AppUser" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AppUser" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AppUser" } } } } } } }, "/api/AppUser/TryGetByValue": { "post": { "tags": [ "AppUser" ], "summary": "AppUser: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AppUser-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AppUser_TryGetByValue_31ADBCA7AE98", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AppUser" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AppUser" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AppUser" } } } } } } }, "/api/AppUser/UpdateCultureCode": { "post": { "tags": [ "AppUser" ], "summary": "AppUser: UpdateCultureCode", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AppUser-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AppUser_UpdateCultureCode_066929D5C512", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AppUser_UpdateCultureCodeRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AppUser_UpdateCultureCodeRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AppUser_UpdateCultureCodeRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/AppUser/UpdateUser": { "put": { "tags": [ "AppUser" ], "summary": "AppUser: UpdateUser", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AppUser-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AppUser_UpdateUser_23E5F9FA240A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AppUserDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AppUserDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AppUserDto" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AppUserDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AppUserDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AppUserDto" } } } } } } }, "/api/AppUser/UpsertGraph": { "put": { "tags": [ "AppUser" ], "summary": "AppUser: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AppUser-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AppUser_UpsertGraph_BCD10D35480C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AppUser" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AppUser" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AppUser" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AppUser" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AppUser" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AppUser" } } } } } } }, "/api/AppUser/UpsertGraphWithExtraFields": { "put": { "tags": [ "AppUser" ], "summary": "AppUser: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AppUser-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AppUser_UpsertGraphWithExtraFields_0A236A9091C9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AppUser" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AppUser" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AppUser" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AppUser" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AppUser" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AppUser" } } } } } } }, "/api/Archive": { "get": { "tags": [ "Archive" ], "summary": "Archive: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Archive-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Archive_GetAll_30525E98764C", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Archive" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Archive" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Archive" } } } } } }, "post": { "tags": [ "Archive" ], "summary": "Archive: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Archive-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Archive_Post_64E016A77F91", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Archive" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Archive" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Archive" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Archive" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Archive" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Archive" } } } } } }, "put": { "tags": [ "Archive" ], "summary": "Archive: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Archive-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Archive_Put_5E0C398F2995", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Archive" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Archive" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Archive" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Archive" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Archive" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Archive" } } } } } } }, "/api/Archive/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "Archive" ], "summary": "Archive: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Archive-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Archive_GetPageByValue_81A854D8D328", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Archive/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "Archive" ], "summary": "Archive: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Archive-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Archive_GetPageByValue2_C2325A7DB005", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Archive/DeleteByFilter": { "post": { "tags": [ "Archive" ], "summary": "Archive: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Archive-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Archive_DeleteByFilter_BD7B099D030F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/Archive/GetAllByValue": { "post": { "tags": [ "Archive" ], "summary": "Archive: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Archive-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Archive_GetAllByValue_538096E2FDE4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Archive" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Archive" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Archive" } } } } } } }, "/api/Archive/GetAllGraphByValue": { "post": { "tags": [ "Archive" ], "summary": "Archive: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Archive-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Archive_GetAllGraphByValue_AA646E58F21F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Archive" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Archive" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Archive" } } } } } } }, "/api/Archive/GetByValue": { "post": { "tags": [ "Archive" ], "summary": "Archive: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Archive-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Archive_GetByValue_317F33DC4FE6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Archive" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Archive" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Archive" } } } } } } }, "/api/Archive/GetLookup": { "post": { "tags": [ "Archive" ], "summary": "Archive: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Archive-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Archive_GetLookup_9C19D8592198", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/Archive/GetLookupByValue": { "post": { "tags": [ "Archive" ], "summary": "Archive: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Archive-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Archive_GetLookupByValue_57B2E9F77A77", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/Archive/Page": { "get": { "tags": [ "Archive" ], "summary": "Archive: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Archive-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Archive_GetPage_7AB958400E78", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Archive/PageAsc": { "get": { "tags": [ "Archive" ], "summary": "Archive: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Archive-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Archive_GetPageAsc_D1EBF9539679", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Archive/SearchByValue": { "post": { "tags": [ "Archive" ], "summary": "Archive: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Archive-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Archive_SearchByValue_E4151F7C45A8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.Archive" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.Archive" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.Archive" } } } } } } }, "/api/Archive/TryGetByValue": { "post": { "tags": [ "Archive" ], "summary": "Archive: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Archive-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Archive_TryGetByValue_205691AC45E0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Archive" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Archive" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Archive" } } } } } } }, "/api/Archive/UpsertGraph": { "put": { "tags": [ "Archive" ], "summary": "Archive: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Archive-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Archive_UpsertGraph_D364757FAFF1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Archive" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Archive" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Archive" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Archive" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Archive" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Archive" } } } } } } }, "/api/Archive/UpsertGraphWithExtraFields": { "put": { "tags": [ "Archive" ], "summary": "Archive: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Archive-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Archive_UpsertGraphWithExtraFields_E6452481227D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Archive" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Archive" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Archive" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Archive" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Archive" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Archive" } } } } } } }, "/api/ArchiveDunning": { "get": { "tags": [ "ArchiveDunning" ], "summary": "ArchiveDunning: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArchiveDunning-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArchiveDunning_GetAll_9060CEC66ECF", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArchiveDunning" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArchiveDunning" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArchiveDunning" } } } } } }, "post": { "tags": [ "ArchiveDunning" ], "summary": "ArchiveDunning: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArchiveDunning-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArchiveDunning_Post_6A08C14D841E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArchiveDunning" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArchiveDunning" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArchiveDunning" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArchiveDunning" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArchiveDunning" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArchiveDunning" } } } } } }, "put": { "tags": [ "ArchiveDunning" ], "summary": "ArchiveDunning: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArchiveDunning-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArchiveDunning_Put_72B055A04F49", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArchiveDunning" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArchiveDunning" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArchiveDunning" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArchiveDunning" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArchiveDunning" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArchiveDunning" } } } } } } }, "/api/ArchiveDunning/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "ArchiveDunning" ], "summary": "ArchiveDunning: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArchiveDunning-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArchiveDunning_GetPageByValue_4A14C0E9D60E", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArchiveDunning/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "ArchiveDunning" ], "summary": "ArchiveDunning: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArchiveDunning-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArchiveDunning_GetPageByValue2_E53D7DDFCB64", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArchiveDunning/DeleteByFilter": { "post": { "tags": [ "ArchiveDunning" ], "summary": "ArchiveDunning: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArchiveDunning-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArchiveDunning_DeleteByFilter_4FD2A8898B05", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/ArchiveDunning/GetAllByValue": { "post": { "tags": [ "ArchiveDunning" ], "summary": "ArchiveDunning: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArchiveDunning-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArchiveDunning_GetAllByValue_49412A77F0EE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArchiveDunning" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArchiveDunning" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArchiveDunning" } } } } } } }, "/api/ArchiveDunning/GetAllGraphByValue": { "post": { "tags": [ "ArchiveDunning" ], "summary": "ArchiveDunning: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArchiveDunning-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArchiveDunning_GetAllGraphByValue_2C8B9C625927", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArchiveDunning" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArchiveDunning" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArchiveDunning" } } } } } } }, "/api/ArchiveDunning/GetByValue": { "post": { "tags": [ "ArchiveDunning" ], "summary": "ArchiveDunning: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArchiveDunning-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArchiveDunning_GetByValue_CF5930FB5D76", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArchiveDunning" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArchiveDunning" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArchiveDunning" } } } } } } }, "/api/ArchiveDunning/GetLookup": { "post": { "tags": [ "ArchiveDunning" ], "summary": "ArchiveDunning: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArchiveDunning-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArchiveDunning_GetLookup_77298D2AC2AF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ArchiveDunning/GetLookupByValue": { "post": { "tags": [ "ArchiveDunning" ], "summary": "ArchiveDunning: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArchiveDunning-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArchiveDunning_GetLookupByValue_02E12A356A8F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ArchiveDunning/Page": { "get": { "tags": [ "ArchiveDunning" ], "summary": "ArchiveDunning: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArchiveDunning-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArchiveDunning_GetPage_E69E2D13E049", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArchiveDunning/PageAsc": { "get": { "tags": [ "ArchiveDunning" ], "summary": "ArchiveDunning: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArchiveDunning-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArchiveDunning_GetPageAsc_D34E1AF976FB", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArchiveDunning/SearchByValue": { "post": { "tags": [ "ArchiveDunning" ], "summary": "ArchiveDunning: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArchiveDunning-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArchiveDunning_SearchByValue_00DF54D4D90E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArchiveDunning" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArchiveDunning" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArchiveDunning" } } } } } } }, "/api/ArchiveDunning/TryGetByValue": { "post": { "tags": [ "ArchiveDunning" ], "summary": "ArchiveDunning: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArchiveDunning-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArchiveDunning_TryGetByValue_6AD5DEB1C840", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArchiveDunning" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArchiveDunning" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArchiveDunning" } } } } } } }, "/api/ArchiveDunning/UpsertGraph": { "put": { "tags": [ "ArchiveDunning" ], "summary": "ArchiveDunning: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArchiveDunning-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArchiveDunning_UpsertGraph_00D08E3FD62C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArchiveDunning" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArchiveDunning" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArchiveDunning" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArchiveDunning" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArchiveDunning" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArchiveDunning" } } } } } } }, "/api/ArchiveDunning/UpsertGraphWithExtraFields": { "put": { "tags": [ "ArchiveDunning" ], "summary": "ArchiveDunning: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArchiveDunning-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArchiveDunning_UpsertGraphWithExtraFields_CE5800477B62", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArchiveDunning" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArchiveDunning" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArchiveDunning" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArchiveDunning" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArchiveDunning" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArchiveDunning" } } } } } } }, "/api/Article": { "get": { "tags": [ "Article" ], "summary": "Article: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Article-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Article_GetAll_5CE39736AEBF", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Article" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Article" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Article" } } } } } }, "post": { "tags": [ "Article" ], "summary": "Article: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Article-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Article_Post_A1415E0F727E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Article" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Article" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Article" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Article" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Article" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Article" } } } } } }, "put": { "tags": [ "Article" ], "summary": "Article: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Article-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Article_Put_BDE4AC50B20D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Article" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Article" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Article" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Article" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Article" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Article" } } } } } } }, "/api/Article/{ArticleId}/GetPageChangeLog": { "get": { "tags": [ "Article" ], "summary": "Article: GetPageChangeLog", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Article-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Article_GetPageChangeLog_8DD56C00A831", "parameters": [ { "name": "ArticleId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Article/{ArticleId}/GetUsageProductions": { "get": { "tags": [ "Article" ], "summary": "Article: GetUsageProductions", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Article-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Article_GetUsageProductions_53B35A332411", "parameters": [ { "name": "ArticleId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Article/{ArticleId}/GetUsageSets": { "get": { "tags": [ "Article" ], "summary": "Article: GetUsageSets", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Article-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Article_GetUsageSets_CC59AA1D17AF", "parameters": [ { "name": "ArticleId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Article/{ArticleId}/UpdatePurchasePriceList": { "get": { "tags": [ "Article" ], "summary": "Article: UpdatePurchasePriceList", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Article-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Article_UpdatePurchasePriceList_123912F1B69F", "parameters": [ { "name": "ArticleId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/Article/{Id}/{OnlyContracts}/GetPositionHistory": { "get": { "tags": [ "Article" ], "summary": "Article: GetPositionHistory", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Article-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Article_GetPositionHistory_0C317A62D7D1", "parameters": [ { "name": "Id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "OnlyContracts", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Article/{Id}/GetRevenueMonthly": { "get": { "tags": [ "Article" ], "summary": "Article: GetRevenueMonthly", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Article-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Article_GetRevenueMonthly_319214BA4003", "parameters": [ { "name": "Id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Article/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "Article" ], "summary": "Article: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Article-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Article_GetPageByValue_E192817CC11A", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Article/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "Article" ], "summary": "Article: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Article-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Article_GetPageByValue2_99FCD66BB7E0", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Article/ArticleSalesPriceWizard": { "post": { "tags": [ "Article" ], "summary": "Article: ArticleSalesPriceWizard", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Article-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Article_ArticleSalesPriceWizard_E2792425257C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Article_SalesPriceWizardRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Article_SalesPriceWizardRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Article_SalesPriceWizardRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/Article/DeleteByFilter": { "post": { "tags": [ "Article" ], "summary": "Article: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Article-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Article_DeleteByFilter_F464A7E72000", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/Article/GetAllByValue": { "post": { "tags": [ "Article" ], "summary": "Article: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Article-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Article_GetAllByValue_A187A750043B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Article" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Article" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Article" } } } } } } }, "/api/Article/GetAllGraphByValue": { "post": { "tags": [ "Article" ], "summary": "Article: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Article-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Article_GetAllGraphByValue_A174CE657CF5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Article" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Article" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Article" } } } } } } }, "/api/Article/GetByValue": { "post": { "tags": [ "Article" ], "summary": "Article: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Article-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Article_GetByValue_18DE9E77BD6E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Article" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Article" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Article" } } } } } } }, "/api/Article/GetComponentHierarchy": { "post": { "tags": [ "Article" ], "summary": "Article: GetComponentHierarchy", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Article-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Article_GetComponentHierarchy_0CCA881BB0D3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Article_GetComponentHierarchyRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Article_GetComponentHierarchyRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Article_GetComponentHierarchyRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ComponentHierarchyResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ComponentHierarchyResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ComponentHierarchyResult" } } } } } } }, "/api/Article/GetIsProductionStepArticle": { "post": { "tags": [ "Article" ], "summary": "Article: GetIsProductionStepArticle", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Article-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Article_GetIsProductionStepArticle_FBE08A1B3EBA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Article_GetIsProductionStepArticleRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Article_GetIsProductionStepArticleRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Article_GetIsProductionStepArticleRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/Article/GetLookup": { "post": { "tags": [ "Article" ], "summary": "Article: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Article-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Article_GetLookup_945384C1923D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/Article/GetLookupByValue": { "post": { "tags": [ "Article" ], "summary": "Article: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Article-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Article_GetLookupByValue_814618FF71A2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/Article/GetViewExtraField": { "get": { "tags": [ "Article" ], "summary": "Article: GetViewExtraField", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Article-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Article_GetViewExtraField_4966F6FEAA75", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExtraField" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExtraField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExtraField" } } } } } } }, "/api/Article/Page": { "get": { "tags": [ "Article" ], "summary": "Article: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Article-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Article_GetPage_8604634A7972", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Article/PageAsc": { "get": { "tags": [ "Article" ], "summary": "Article: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Article-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Article_GetPageAsc_E9A94C98A653", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Article/PageFromView/{WithProduct}/{GroupId}/{IncludeSubNodes}/{activeOnly}/{favoriteOnly}/{batch}/{salesArticle}/{purchaseArticle}/{warehousingOnly}/{isProductionStepOnly}": { "get": { "tags": [ "Article" ], "summary": "Article: GetPageFromView", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Article-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Article_GetPageFromView_43B2961DF914", "parameters": [ { "name": "WithProduct", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "GroupId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "IncludeSubNodes", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "activeOnly", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "favoriteOnly", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "batch", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "salesArticle", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "purchaseArticle", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "warehousingOnly", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "isProductionStepOnly", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Article/SearchByValue": { "post": { "tags": [ "Article" ], "summary": "Article: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Article-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Article_SearchByValue_A239BEF392A3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.Article" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.Article" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.Article" } } } } } } }, "/api/Article/TryGetByValue": { "post": { "tags": [ "Article" ], "summary": "Article: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Article-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Article_TryGetByValue_54E83EC403B0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Article" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Article" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Article" } } } } } } }, "/api/Article/UpsertGraph": { "put": { "tags": [ "Article" ], "summary": "Article: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Article-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Article_UpsertGraph_512446052B10", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Article" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Article" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Article" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Article" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Article" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Article" } } } } } } }, "/api/Article/UpsertGraphWithExtraFields": { "put": { "tags": [ "Article" ], "summary": "Article: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Article-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Article_UpsertGraphWithExtraFields_2C9F8EFACD05", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Article" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Article" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Article" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Article" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Article" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Article" } } } } } } }, "/api/ArticleAccessory": { "get": { "tags": [ "ArticleAccessory" ], "summary": "ArticleAccessory: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleAccessory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleAccessory_GetAll_1695CAB0C7F2", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleAccessory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleAccessory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleAccessory" } } } } } }, "post": { "tags": [ "ArticleAccessory" ], "summary": "ArticleAccessory: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleAccessory-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleAccessory_Post_25A4C434579C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleAccessory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleAccessory" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleAccessory" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleAccessory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleAccessory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleAccessory" } } } } } }, "put": { "tags": [ "ArticleAccessory" ], "summary": "ArticleAccessory: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleAccessory-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleAccessory_Put_1E9FA0CCB033", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleAccessory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleAccessory" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleAccessory" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleAccessory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleAccessory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleAccessory" } } } } } } }, "/api/ArticleAccessory/{ArticleId}/PageFromViewByArticleId": { "get": { "tags": [ "ArticleAccessory" ], "summary": "ArticleAccessory: GetPageFromViewByArticleId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleAccessory-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleAccessory_GetPageFromViewByArticleId_78FCC4230720", "parameters": [ { "name": "ArticleId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleAccessory/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "ArticleAccessory" ], "summary": "ArticleAccessory: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleAccessory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleAccessory_GetPageByValue_2A9F679F1C2A", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleAccessory/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "ArticleAccessory" ], "summary": "ArticleAccessory: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleAccessory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleAccessory_GetPageByValue2_28344AB98416", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleAccessory/DeleteByFilter": { "post": { "tags": [ "ArticleAccessory" ], "summary": "ArticleAccessory: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleAccessory-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleAccessory_DeleteByFilter_BF7C5EF95D07", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/ArticleAccessory/GetAllByValue": { "post": { "tags": [ "ArticleAccessory" ], "summary": "ArticleAccessory: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleAccessory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleAccessory_GetAllByValue_4ABDDDD35869", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleAccessory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleAccessory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleAccessory" } } } } } } }, "/api/ArticleAccessory/GetAllGraphByValue": { "post": { "tags": [ "ArticleAccessory" ], "summary": "ArticleAccessory: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleAccessory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleAccessory_GetAllGraphByValue_3588A9B3CF02", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleAccessory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleAccessory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleAccessory" } } } } } } }, "/api/ArticleAccessory/GetByValue": { "post": { "tags": [ "ArticleAccessory" ], "summary": "ArticleAccessory: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleAccessory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleAccessory_GetByValue_B7711402F644", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleAccessory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleAccessory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleAccessory" } } } } } } }, "/api/ArticleAccessory/GetLookup": { "post": { "tags": [ "ArticleAccessory" ], "summary": "ArticleAccessory: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleAccessory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleAccessory_GetLookup_0311039C7068", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ArticleAccessory/GetLookupByValue": { "post": { "tags": [ "ArticleAccessory" ], "summary": "ArticleAccessory: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleAccessory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleAccessory_GetLookupByValue_B4F48EE52BD5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ArticleAccessory/Page": { "get": { "tags": [ "ArticleAccessory" ], "summary": "ArticleAccessory: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleAccessory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleAccessory_GetPage_33241947903A", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleAccessory/PageAsc": { "get": { "tags": [ "ArticleAccessory" ], "summary": "ArticleAccessory: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleAccessory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleAccessory_GetPageAsc_8E3996355631", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleAccessory/SearchByValue": { "post": { "tags": [ "ArticleAccessory" ], "summary": "ArticleAccessory: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleAccessory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleAccessory_SearchByValue_03CBC829EC18", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleAccessory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleAccessory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleAccessory" } } } } } } }, "/api/ArticleAccessory/TryGetByValue": { "post": { "tags": [ "ArticleAccessory" ], "summary": "ArticleAccessory: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleAccessory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleAccessory_TryGetByValue_57EC06E19F3F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleAccessory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleAccessory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleAccessory" } } } } } } }, "/api/ArticleAccessory/UpsertGraph": { "put": { "tags": [ "ArticleAccessory" ], "summary": "ArticleAccessory: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleAccessory-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleAccessory_UpsertGraph_BE22FBC3834D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleAccessory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleAccessory" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleAccessory" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleAccessory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleAccessory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleAccessory" } } } } } } }, "/api/ArticleAccessory/UpsertGraphWithExtraFields": { "put": { "tags": [ "ArticleAccessory" ], "summary": "ArticleAccessory: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleAccessory-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleAccessory_UpsertGraphWithExtraFields_CF1CC1889598", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleAccessory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleAccessory" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleAccessory" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleAccessory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleAccessory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleAccessory" } } } } } } }, "/api/ArticleCategory": { "get": { "tags": [ "ArticleCategory" ], "summary": "ArticleCategory: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleCategory_GetAll_9F812630A40F", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleCategory" } } } } } }, "post": { "tags": [ "ArticleCategory" ], "summary": "ArticleCategory: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleCategory-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleCategory_Post_1DBB0D6B689C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleCategory" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleCategory" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleCategory" } } } } } }, "put": { "tags": [ "ArticleCategory" ], "summary": "ArticleCategory: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleCategory-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleCategory_Put_4FF6262993AC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleCategory" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleCategory" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleCategory" } } } } } } }, "/api/ArticleCategory/{ArticleId}/PageFromViewByArticleId": { "get": { "tags": [ "ArticleCategory" ], "summary": "ArticleCategory: GetPageFromViewByArticleId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleCategory-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleCategory_GetPageFromViewByArticleId_AC6BFAC00A90", "parameters": [ { "name": "ArticleId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleCategory/{CategoryId}/PageFromViewByCategoryId": { "get": { "tags": [ "ArticleCategory" ], "summary": "ArticleCategory: GetPageFromViewByArticleCategoryNameId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleCategory-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleCategory_GetPageFromViewByArticleCategoryNameId_F44EC02D1DD0", "parameters": [ { "name": "CategoryId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleCategory/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "ArticleCategory" ], "summary": "ArticleCategory: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleCategory_GetPageByValue_31E1B1D48472", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleCategory/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "ArticleCategory" ], "summary": "ArticleCategory: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleCategory_GetPageByValue2_884D28DEFBED", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleCategory/DeleteByFilter": { "post": { "tags": [ "ArticleCategory" ], "summary": "ArticleCategory: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleCategory-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleCategory_DeleteByFilter_4A57443A4AF4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/ArticleCategory/GetAllByValue": { "post": { "tags": [ "ArticleCategory" ], "summary": "ArticleCategory: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleCategory_GetAllByValue_0AD80D06FD7E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleCategory" } } } } } } }, "/api/ArticleCategory/GetAllGraphByValue": { "post": { "tags": [ "ArticleCategory" ], "summary": "ArticleCategory: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleCategory_GetAllGraphByValue_B34957AD1948", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleCategory" } } } } } } }, "/api/ArticleCategory/GetByValue": { "post": { "tags": [ "ArticleCategory" ], "summary": "ArticleCategory: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleCategory_GetByValue_2CFF05EE94D7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleCategory" } } } } } } }, "/api/ArticleCategory/GetLookup": { "post": { "tags": [ "ArticleCategory" ], "summary": "ArticleCategory: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleCategory_GetLookup_A6211C2D2D55", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ArticleCategory/GetLookupByValue": { "post": { "tags": [ "ArticleCategory" ], "summary": "ArticleCategory: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleCategory_GetLookupByValue_93C90D59AD65", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ArticleCategory/Page": { "get": { "tags": [ "ArticleCategory" ], "summary": "ArticleCategory: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleCategory_GetPage_86B27ABDED8D", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleCategory/PageAsc": { "get": { "tags": [ "ArticleCategory" ], "summary": "ArticleCategory: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleCategory_GetPageAsc_0D31881CCE0E", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleCategory/SearchByValue": { "post": { "tags": [ "ArticleCategory" ], "summary": "ArticleCategory: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleCategory_SearchByValue_AED5709D1DAC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleCategory" } } } } } } }, "/api/ArticleCategory/TryGetByValue": { "post": { "tags": [ "ArticleCategory" ], "summary": "ArticleCategory: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleCategory_TryGetByValue_06F56863A952", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleCategory" } } } } } } }, "/api/ArticleCategory/UpsertGraph": { "put": { "tags": [ "ArticleCategory" ], "summary": "ArticleCategory: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleCategory-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleCategory_UpsertGraph_8682911FA11D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleCategory" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleCategory" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleCategory" } } } } } } }, "/api/ArticleCategory/UpsertGraphWithExtraFields": { "put": { "tags": [ "ArticleCategory" ], "summary": "ArticleCategory: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleCategory-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleCategory_UpsertGraphWithExtraFields_E42C88051053", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleCategory" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleCategory" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleCategory" } } } } } } }, "/api/ArticleCategoryName": { "get": { "tags": [ "ArticleCategoryName" ], "summary": "ArticleCategoryName: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleCategoryName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleCategoryName_GetAll_7E986FC2B1EF", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleCategoryName" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleCategoryName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleCategoryName" } } } } } }, "post": { "tags": [ "ArticleCategoryName" ], "summary": "ArticleCategoryName: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleCategoryName-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleCategoryName_Post_A4FB3D9EB713", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleCategoryName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleCategoryName" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleCategoryName" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleCategoryName" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleCategoryName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleCategoryName" } } } } } }, "put": { "tags": [ "ArticleCategoryName" ], "summary": "ArticleCategoryName: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleCategoryName-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleCategoryName_Put_967B72C22946", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleCategoryName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleCategoryName" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleCategoryName" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleCategoryName" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleCategoryName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleCategoryName" } } } } } } }, "/api/ArticleCategoryName/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "ArticleCategoryName" ], "summary": "ArticleCategoryName: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleCategoryName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleCategoryName_GetPageByValue_443350AD5ACA", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleCategoryName/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "ArticleCategoryName" ], "summary": "ArticleCategoryName: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleCategoryName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleCategoryName_GetPageByValue2_42FEB2789717", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleCategoryName/DeleteByFilter": { "post": { "tags": [ "ArticleCategoryName" ], "summary": "ArticleCategoryName: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleCategoryName-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleCategoryName_DeleteByFilter_531446DD553D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/ArticleCategoryName/GetAllByValue": { "post": { "tags": [ "ArticleCategoryName" ], "summary": "ArticleCategoryName: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleCategoryName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleCategoryName_GetAllByValue_D67BDB657EFD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleCategoryName" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleCategoryName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleCategoryName" } } } } } } }, "/api/ArticleCategoryName/GetAllGraphByValue": { "post": { "tags": [ "ArticleCategoryName" ], "summary": "ArticleCategoryName: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleCategoryName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleCategoryName_GetAllGraphByValue_421BE8E93EF0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleCategoryName" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleCategoryName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleCategoryName" } } } } } } }, "/api/ArticleCategoryName/GetByValue": { "post": { "tags": [ "ArticleCategoryName" ], "summary": "ArticleCategoryName: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleCategoryName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleCategoryName_GetByValue_E71856F25A3A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleCategoryName" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleCategoryName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleCategoryName" } } } } } } }, "/api/ArticleCategoryName/GetCategoryList": { "get": { "tags": [ "ArticleCategoryName" ], "summary": "ArticleCategoryName: GetCategoryList", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleCategoryName-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleCategoryName_GetCategoryList_02EFD1ED2889", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Dto.CategoryNameDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Dto.CategoryNameDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Dto.CategoryNameDto" } } } } } } }, "/api/ArticleCategoryName/GetLookup": { "post": { "tags": [ "ArticleCategoryName" ], "summary": "ArticleCategoryName: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleCategoryName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleCategoryName_GetLookup_F8F22F69FC7C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ArticleCategoryName/GetLookupByValue": { "post": { "tags": [ "ArticleCategoryName" ], "summary": "ArticleCategoryName: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleCategoryName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleCategoryName_GetLookupByValue_2B0E1D31D276", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ArticleCategoryName/Page": { "get": { "tags": [ "ArticleCategoryName" ], "summary": "ArticleCategoryName: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleCategoryName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleCategoryName_GetPage_7A7737B5F22C", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleCategoryName/PageArticleCategoryNamesByParent/{ParentId}/{IncludeSubNodes}/{TopParentsOnly}": { "get": { "tags": [ "ArticleCategoryName" ], "summary": "ArticleCategoryName: GetPageArticleCategoryNamesByParent", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleCategoryName-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleCategoryName_GetPageArticleCategoryNamesByParent_34EA7C13ED7A", "parameters": [ { "name": "ParentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "IncludeSubNodes", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "TopParentsOnly", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleCategoryName/PageAsc": { "get": { "tags": [ "ArticleCategoryName" ], "summary": "ArticleCategoryName: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleCategoryName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleCategoryName_GetPageAsc_D18C2C7ADD91", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleCategoryName/SearchByValue": { "post": { "tags": [ "ArticleCategoryName" ], "summary": "ArticleCategoryName: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleCategoryName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleCategoryName_SearchByValue_0FC142F8D423", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleCategoryName" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleCategoryName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleCategoryName" } } } } } } }, "/api/ArticleCategoryName/TryGetByValue": { "post": { "tags": [ "ArticleCategoryName" ], "summary": "ArticleCategoryName: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleCategoryName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleCategoryName_TryGetByValue_FE6FF7779EA5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleCategoryName" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleCategoryName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleCategoryName" } } } } } } }, "/api/ArticleCategoryName/UpsertGraph": { "put": { "tags": [ "ArticleCategoryName" ], "summary": "ArticleCategoryName: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleCategoryName-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleCategoryName_UpsertGraph_4FB1EA21437C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleCategoryName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleCategoryName" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleCategoryName" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleCategoryName" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleCategoryName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleCategoryName" } } } } } } }, "/api/ArticleCategoryName/UpsertGraphWithExtraFields": { "put": { "tags": [ "ArticleCategoryName" ], "summary": "ArticleCategoryName: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleCategoryName-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleCategoryName_UpsertGraphWithExtraFields_5617B2AF9C00", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleCategoryName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleCategoryName" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleCategoryName" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleCategoryName" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleCategoryName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleCategoryName" } } } } } } }, "/api/ArticleCost": { "get": { "tags": [ "ArticleCost" ], "summary": "ArticleCost: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleCost-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleCost_GetAll_DF44591DAB46", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleCost" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleCost" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleCost" } } } } } }, "post": { "tags": [ "ArticleCost" ], "summary": "ArticleCost: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleCost-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleCost_Post_6EC4DA561E2A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleCost" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleCost" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleCost" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleCost" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleCost" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleCost" } } } } } }, "put": { "tags": [ "ArticleCost" ], "summary": "ArticleCost: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleCost-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleCost_Put_B54F9A538083", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleCost" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleCost" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleCost" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleCost" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleCost" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleCost" } } } } } } }, "/api/ArticleCost/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "ArticleCost" ], "summary": "ArticleCost: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleCost-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleCost_GetPageByValue_39BB5E18E09E", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleCost/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "ArticleCost" ], "summary": "ArticleCost: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleCost-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleCost_GetPageByValue2_A8FFE4079E97", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleCost/DeleteByFilter": { "post": { "tags": [ "ArticleCost" ], "summary": "ArticleCost: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleCost-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleCost_DeleteByFilter_563D0E649216", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/ArticleCost/GetAllByValue": { "post": { "tags": [ "ArticleCost" ], "summary": "ArticleCost: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleCost-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleCost_GetAllByValue_3C14D020CB40", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleCost" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleCost" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleCost" } } } } } } }, "/api/ArticleCost/GetAllGraphByValue": { "post": { "tags": [ "ArticleCost" ], "summary": "ArticleCost: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleCost-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleCost_GetAllGraphByValue_D43BAFD44076", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleCost" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleCost" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleCost" } } } } } } }, "/api/ArticleCost/GetByValue": { "post": { "tags": [ "ArticleCost" ], "summary": "ArticleCost: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleCost-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleCost_GetByValue_D949F7C86C59", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleCost" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleCost" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleCost" } } } } } } }, "/api/ArticleCost/GetLookup": { "post": { "tags": [ "ArticleCost" ], "summary": "ArticleCost: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleCost-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleCost_GetLookup_E3B73DCBF774", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ArticleCost/GetLookupByValue": { "post": { "tags": [ "ArticleCost" ], "summary": "ArticleCost: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleCost-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleCost_GetLookupByValue_033AD8F53713", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ArticleCost/Page": { "get": { "tags": [ "ArticleCost" ], "summary": "ArticleCost: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleCost-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleCost_GetPage_F45130D9B7CA", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleCost/PageAsc": { "get": { "tags": [ "ArticleCost" ], "summary": "ArticleCost: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleCost-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleCost_GetPageAsc_C2AACA824D2A", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleCost/SearchByValue": { "post": { "tags": [ "ArticleCost" ], "summary": "ArticleCost: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleCost-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleCost_SearchByValue_1245D37F1156", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleCost" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleCost" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleCost" } } } } } } }, "/api/ArticleCost/TryGetByValue": { "post": { "tags": [ "ArticleCost" ], "summary": "ArticleCost: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleCost-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleCost_TryGetByValue_05C466B1692A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleCost" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleCost" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleCost" } } } } } } }, "/api/ArticleCost/UpsertGraph": { "put": { "tags": [ "ArticleCost" ], "summary": "ArticleCost: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleCost-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleCost_UpsertGraph_1D49A7C4AD55", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleCost" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleCost" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleCost" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleCost" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleCost" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleCost" } } } } } } }, "/api/ArticleCost/UpsertGraphWithExtraFields": { "put": { "tags": [ "ArticleCost" ], "summary": "ArticleCost: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleCost-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleCost_UpsertGraphWithExtraFields_312F908B7652", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleCost" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleCost" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleCost" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleCost" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleCost" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleCost" } } } } } } }, "/api/ArticleDimensionText": { "get": { "tags": [ "ArticleDimensionText" ], "summary": "ArticleDimensionText: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleDimensionText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleDimensionText_GetAll_0D51E9619522", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleDimensionText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleDimensionText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleDimensionText" } } } } } }, "post": { "tags": [ "ArticleDimensionText" ], "summary": "ArticleDimensionText: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleDimensionText-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleDimensionText_Post_23662BF8B3DE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleDimensionText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleDimensionText" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleDimensionText" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleDimensionText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleDimensionText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleDimensionText" } } } } } }, "put": { "tags": [ "ArticleDimensionText" ], "summary": "ArticleDimensionText: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleDimensionText-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleDimensionText_Put_EEFA307D60DC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleDimensionText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleDimensionText" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleDimensionText" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleDimensionText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleDimensionText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleDimensionText" } } } } } } }, "/api/ArticleDimensionText/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "ArticleDimensionText" ], "summary": "ArticleDimensionText: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleDimensionText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleDimensionText_GetPageByValue_304076BCBDE0", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleDimensionText/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "ArticleDimensionText" ], "summary": "ArticleDimensionText: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleDimensionText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleDimensionText_GetPageByValue2_7E2FB77341FF", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleDimensionText/DeleteByFilter": { "post": { "tags": [ "ArticleDimensionText" ], "summary": "ArticleDimensionText: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleDimensionText-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleDimensionText_DeleteByFilter_972237E5832A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/ArticleDimensionText/GetAllByValue": { "post": { "tags": [ "ArticleDimensionText" ], "summary": "ArticleDimensionText: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleDimensionText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleDimensionText_GetAllByValue_657F947EF635", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleDimensionText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleDimensionText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleDimensionText" } } } } } } }, "/api/ArticleDimensionText/GetAllGraphByValue": { "post": { "tags": [ "ArticleDimensionText" ], "summary": "ArticleDimensionText: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleDimensionText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleDimensionText_GetAllGraphByValue_A0E5B6EB6F50", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleDimensionText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleDimensionText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleDimensionText" } } } } } } }, "/api/ArticleDimensionText/GetByValue": { "post": { "tags": [ "ArticleDimensionText" ], "summary": "ArticleDimensionText: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleDimensionText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleDimensionText_GetByValue_8D0793393EBC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleDimensionText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleDimensionText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleDimensionText" } } } } } } }, "/api/ArticleDimensionText/GetLookup": { "post": { "tags": [ "ArticleDimensionText" ], "summary": "ArticleDimensionText: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleDimensionText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleDimensionText_GetLookup_554A06F8DC1A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ArticleDimensionText/GetLookupByValue": { "post": { "tags": [ "ArticleDimensionText" ], "summary": "ArticleDimensionText: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleDimensionText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleDimensionText_GetLookupByValue_B869D4009DA2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ArticleDimensionText/Page": { "get": { "tags": [ "ArticleDimensionText" ], "summary": "ArticleDimensionText: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleDimensionText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleDimensionText_GetPage_662DD65E8A99", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleDimensionText/PageAsc": { "get": { "tags": [ "ArticleDimensionText" ], "summary": "ArticleDimensionText: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleDimensionText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleDimensionText_GetPageAsc_B24966344D17", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleDimensionText/SearchByValue": { "post": { "tags": [ "ArticleDimensionText" ], "summary": "ArticleDimensionText: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleDimensionText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleDimensionText_SearchByValue_62DA7DBDE3E6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleDimensionText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleDimensionText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleDimensionText" } } } } } } }, "/api/ArticleDimensionText/TryGetByValue": { "post": { "tags": [ "ArticleDimensionText" ], "summary": "ArticleDimensionText: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleDimensionText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleDimensionText_TryGetByValue_7DA64717EEC2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleDimensionText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleDimensionText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleDimensionText" } } } } } } }, "/api/ArticleDimensionText/UpsertGraph": { "put": { "tags": [ "ArticleDimensionText" ], "summary": "ArticleDimensionText: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleDimensionText-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleDimensionText_UpsertGraph_65E1C4D5293F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleDimensionText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleDimensionText" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleDimensionText" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleDimensionText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleDimensionText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleDimensionText" } } } } } } }, "/api/ArticleDimensionText/UpsertGraphWithExtraFields": { "put": { "tags": [ "ArticleDimensionText" ], "summary": "ArticleDimensionText: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleDimensionText-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleDimensionText_UpsertGraphWithExtraFields_0B90B26EC1BB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleDimensionText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleDimensionText" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleDimensionText" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleDimensionText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleDimensionText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleDimensionText" } } } } } } }, "/api/ArticleEInvoiceUoM": { "get": { "tags": [ "ArticleEInvoiceUoM" ], "summary": "ArticleEInvoiceUoM: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleEInvoiceUoM-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleEInvoiceUoM_GetAll_378B6E6B40C0", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleEInvoiceUoM" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleEInvoiceUoM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleEInvoiceUoM" } } } } } }, "post": { "tags": [ "ArticleEInvoiceUoM" ], "summary": "ArticleEInvoiceUoM: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleEInvoiceUoM-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleEInvoiceUoM_Post_C823DABD932F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleEInvoiceUoM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleEInvoiceUoM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleEInvoiceUoM" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleEInvoiceUoM" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleEInvoiceUoM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleEInvoiceUoM" } } } } } }, "put": { "tags": [ "ArticleEInvoiceUoM" ], "summary": "ArticleEInvoiceUoM: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleEInvoiceUoM-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleEInvoiceUoM_Put_9821127DD050", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleEInvoiceUoM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleEInvoiceUoM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleEInvoiceUoM" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleEInvoiceUoM" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleEInvoiceUoM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleEInvoiceUoM" } } } } } } }, "/api/ArticleEInvoiceUoM/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "ArticleEInvoiceUoM" ], "summary": "ArticleEInvoiceUoM: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleEInvoiceUoM-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleEInvoiceUoM_GetPageByValue_BB81BC58B5E3", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleEInvoiceUoM/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "ArticleEInvoiceUoM" ], "summary": "ArticleEInvoiceUoM: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleEInvoiceUoM-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleEInvoiceUoM_GetPageByValue2_7DD867A769E0", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleEInvoiceUoM/DeleteByFilter": { "post": { "tags": [ "ArticleEInvoiceUoM" ], "summary": "ArticleEInvoiceUoM: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleEInvoiceUoM-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleEInvoiceUoM_DeleteByFilter_98DDC8A21558", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/ArticleEInvoiceUoM/GetAllByValue": { "post": { "tags": [ "ArticleEInvoiceUoM" ], "summary": "ArticleEInvoiceUoM: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleEInvoiceUoM-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleEInvoiceUoM_GetAllByValue_24EF6CF6B6B5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleEInvoiceUoM" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleEInvoiceUoM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleEInvoiceUoM" } } } } } } }, "/api/ArticleEInvoiceUoM/GetAllGraphByValue": { "post": { "tags": [ "ArticleEInvoiceUoM" ], "summary": "ArticleEInvoiceUoM: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleEInvoiceUoM-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleEInvoiceUoM_GetAllGraphByValue_037BAD735136", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleEInvoiceUoM" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleEInvoiceUoM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleEInvoiceUoM" } } } } } } }, "/api/ArticleEInvoiceUoM/GetByValue": { "post": { "tags": [ "ArticleEInvoiceUoM" ], "summary": "ArticleEInvoiceUoM: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleEInvoiceUoM-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleEInvoiceUoM_GetByValue_5E00A0B23B97", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleEInvoiceUoM" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleEInvoiceUoM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleEInvoiceUoM" } } } } } } }, "/api/ArticleEInvoiceUoM/GetLookup": { "post": { "tags": [ "ArticleEInvoiceUoM" ], "summary": "ArticleEInvoiceUoM: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleEInvoiceUoM-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleEInvoiceUoM_GetLookup_6EBA86DD71A9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ArticleEInvoiceUoM/GetLookupByValue": { "post": { "tags": [ "ArticleEInvoiceUoM" ], "summary": "ArticleEInvoiceUoM: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleEInvoiceUoM-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleEInvoiceUoM_GetLookupByValue_2A3B9CF7CDD4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ArticleEInvoiceUoM/Page": { "get": { "tags": [ "ArticleEInvoiceUoM" ], "summary": "ArticleEInvoiceUoM: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleEInvoiceUoM-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleEInvoiceUoM_GetPage_65D468202C83", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleEInvoiceUoM/PageAsc": { "get": { "tags": [ "ArticleEInvoiceUoM" ], "summary": "ArticleEInvoiceUoM: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleEInvoiceUoM-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleEInvoiceUoM_GetPageAsc_3F0B68061C94", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleEInvoiceUoM/SearchByValue": { "post": { "tags": [ "ArticleEInvoiceUoM" ], "summary": "ArticleEInvoiceUoM: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleEInvoiceUoM-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleEInvoiceUoM_SearchByValue_CD43A8FC89BE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleEInvoiceUoM" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleEInvoiceUoM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleEInvoiceUoM" } } } } } } }, "/api/ArticleEInvoiceUoM/TryGetByValue": { "post": { "tags": [ "ArticleEInvoiceUoM" ], "summary": "ArticleEInvoiceUoM: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleEInvoiceUoM-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleEInvoiceUoM_TryGetByValue_94727E28A34E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleEInvoiceUoM" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleEInvoiceUoM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleEInvoiceUoM" } } } } } } }, "/api/ArticleEInvoiceUoM/UpsertGraph": { "put": { "tags": [ "ArticleEInvoiceUoM" ], "summary": "ArticleEInvoiceUoM: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleEInvoiceUoM-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleEInvoiceUoM_UpsertGraph_4B8379C89CAA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleEInvoiceUoM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleEInvoiceUoM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleEInvoiceUoM" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleEInvoiceUoM" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleEInvoiceUoM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleEInvoiceUoM" } } } } } } }, "/api/ArticleEInvoiceUoM/UpsertGraphWithExtraFields": { "put": { "tags": [ "ArticleEInvoiceUoM" ], "summary": "ArticleEInvoiceUoM: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleEInvoiceUoM-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleEInvoiceUoM_UpsertGraphWithExtraFields_341B765E1A77", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleEInvoiceUoM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleEInvoiceUoM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleEInvoiceUoM" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleEInvoiceUoM" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleEInvoiceUoM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleEInvoiceUoM" } } } } } } }, "/api/ArticleGroup": { "get": { "tags": [ "ArticleGroup" ], "summary": "ArticleGroup: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleGroup_GetAll_30108623A7A7", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleGroup" } } } } } }, "post": { "tags": [ "ArticleGroup" ], "summary": "ArticleGroup: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleGroup-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleGroup_Post_46C476897582", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleGroup" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleGroup" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleGroup" } } } } } }, "put": { "tags": [ "ArticleGroup" ], "summary": "ArticleGroup: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleGroup-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleGroup_Put_488A971D9C91", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleGroup" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleGroup" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleGroup" } } } } } } }, "/api/ArticleGroup/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "ArticleGroup" ], "summary": "ArticleGroup: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleGroup_GetPageByValue_C2F8811747A5", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleGroup/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "ArticleGroup" ], "summary": "ArticleGroup: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleGroup_GetPageByValue2_59FB753CC5C2", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleGroup/DeleteByFilter": { "post": { "tags": [ "ArticleGroup" ], "summary": "ArticleGroup: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleGroup-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleGroup_DeleteByFilter_4E7A5E5FBD4E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/ArticleGroup/GetAllByValue": { "post": { "tags": [ "ArticleGroup" ], "summary": "ArticleGroup: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleGroup_GetAllByValue_265BC9E85572", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleGroup" } } } } } } }, "/api/ArticleGroup/GetAllGraphByValue": { "post": { "tags": [ "ArticleGroup" ], "summary": "ArticleGroup: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleGroup_GetAllGraphByValue_4D9DFACD6C35", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleGroup" } } } } } } }, "/api/ArticleGroup/GetAllSortedByHierarchy": { "get": { "tags": [ "ArticleGroup" ], "summary": "ArticleGroup: GetAllSortedByHierarchy", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleGroup-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleGroup_GetAllSortedByHierarchy_B8B6B61BDBAB", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleGroup" } } } } } } }, "/api/ArticleGroup/GetByValue": { "post": { "tags": [ "ArticleGroup" ], "summary": "ArticleGroup: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleGroup_GetByValue_0EB85CE794A0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleGroup" } } } } } } }, "/api/ArticleGroup/GetChildArticleGroups/{ParentId}": { "get": { "tags": [ "ArticleGroup" ], "summary": "ArticleGroup: GetChildArticleGroups", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleGroup-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleGroup_GetChildArticleGroups_BAFC68101CE9", "parameters": [ { "name": "ParentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleGroup" } } } } } } }, "/api/ArticleGroup/GetLookup": { "post": { "tags": [ "ArticleGroup" ], "summary": "ArticleGroup: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleGroup_GetLookup_917CC8416E9E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ArticleGroup/GetLookupByValue": { "post": { "tags": [ "ArticleGroup" ], "summary": "ArticleGroup: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleGroup_GetLookupByValue_7F5ECD9FAD00", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ArticleGroup/GetRootArticleGroups": { "get": { "tags": [ "ArticleGroup" ], "summary": "ArticleGroup: GetRootArticleGroups", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleGroup-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleGroup_GetRootArticleGroups_9B5797A19A4A", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleGroup" } } } } } } }, "/api/ArticleGroup/Page": { "get": { "tags": [ "ArticleGroup" ], "summary": "ArticleGroup: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleGroup_GetPage_E893463D35B2", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleGroup/PageArticleGroupsByParent/{ParentId}/{IncludeSubNodes}/{TopParentsOnly}": { "get": { "tags": [ "ArticleGroup" ], "summary": "ArticleGroup: GetPageArticleGroupsByParent", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleGroup-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleGroup_GetPageArticleGroupsByParent_512E639BFB7D", "parameters": [ { "name": "ParentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "IncludeSubNodes", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "TopParentsOnly", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleGroup/PageAsc": { "get": { "tags": [ "ArticleGroup" ], "summary": "ArticleGroup: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleGroup_GetPageAsc_268EC7BDE343", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleGroup/SearchByValue": { "post": { "tags": [ "ArticleGroup" ], "summary": "ArticleGroup: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleGroup_SearchByValue_EAA03D88A0B1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleGroup" } } } } } } }, "/api/ArticleGroup/TryGetByValue": { "post": { "tags": [ "ArticleGroup" ], "summary": "ArticleGroup: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleGroup_TryGetByValue_B3B757B96116", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleGroup" } } } } } } }, "/api/ArticleGroup/UpsertGraph": { "put": { "tags": [ "ArticleGroup" ], "summary": "ArticleGroup: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleGroup-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleGroup_UpsertGraph_B8DFA9486B22", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleGroup" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleGroup" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleGroup" } } } } } } }, "/api/ArticleGroup/UpsertGraphWithExtraFields": { "put": { "tags": [ "ArticleGroup" ], "summary": "ArticleGroup: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleGroup-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleGroup_UpsertGraphWithExtraFields_35A041B2E20A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleGroup" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleGroup" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleGroup" } } } } } } }, "/api/ArticleIndividualization": { "get": { "tags": [ "ArticleIndividualization" ], "summary": "ArticleIndividualization: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleIndividualization-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleIndividualization_GetAll_C3BED25E663C", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleIndividualization" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleIndividualization" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleIndividualization" } } } } } }, "post": { "tags": [ "ArticleIndividualization" ], "summary": "ArticleIndividualization: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleIndividualization-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleIndividualization_Post_200A98055342", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleIndividualization" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleIndividualization" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleIndividualization" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleIndividualization" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleIndividualization" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleIndividualization" } } } } } }, "put": { "tags": [ "ArticleIndividualization" ], "summary": "ArticleIndividualization: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleIndividualization-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleIndividualization_Put_BDC196BA4A7F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleIndividualization" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleIndividualization" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleIndividualization" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleIndividualization" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleIndividualization" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleIndividualization" } } } } } } }, "/api/ArticleIndividualization/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "ArticleIndividualization" ], "summary": "ArticleIndividualization: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleIndividualization-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleIndividualization_GetPageByValue_DEAFE0D0C99A", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleIndividualization/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "ArticleIndividualization" ], "summary": "ArticleIndividualization: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleIndividualization-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleIndividualization_GetPageByValue2_44D63AA433BE", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleIndividualization/DeleteByFilter": { "post": { "tags": [ "ArticleIndividualization" ], "summary": "ArticleIndividualization: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleIndividualization-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleIndividualization_DeleteByFilter_36B293C6816F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/ArticleIndividualization/GetAllByValue": { "post": { "tags": [ "ArticleIndividualization" ], "summary": "ArticleIndividualization: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleIndividualization-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleIndividualization_GetAllByValue_52D7045E0BB9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleIndividualization" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleIndividualization" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleIndividualization" } } } } } } }, "/api/ArticleIndividualization/GetAllGraphByValue": { "post": { "tags": [ "ArticleIndividualization" ], "summary": "ArticleIndividualization: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleIndividualization-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleIndividualization_GetAllGraphByValue_2F3089E65A14", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleIndividualization" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleIndividualization" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleIndividualization" } } } } } } }, "/api/ArticleIndividualization/GetByValue": { "post": { "tags": [ "ArticleIndividualization" ], "summary": "ArticleIndividualization: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleIndividualization-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleIndividualization_GetByValue_A6042870734B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleIndividualization" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleIndividualization" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleIndividualization" } } } } } } }, "/api/ArticleIndividualization/GetLookup": { "post": { "tags": [ "ArticleIndividualization" ], "summary": "ArticleIndividualization: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleIndividualization-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleIndividualization_GetLookup_932AE0772548", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ArticleIndividualization/GetLookupByValue": { "post": { "tags": [ "ArticleIndividualization" ], "summary": "ArticleIndividualization: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleIndividualization-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleIndividualization_GetLookupByValue_312F41BAAC43", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ArticleIndividualization/Page": { "get": { "tags": [ "ArticleIndividualization" ], "summary": "ArticleIndividualization: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleIndividualization-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleIndividualization_GetPage_4B15871CCEC3", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleIndividualization/PageArticleIndividualizationByBatch/{IsBatch}/{IsForSale}/{ArticleId}/{WarehouseId}/{BinLocationId}": { "get": { "tags": [ "ArticleIndividualization" ], "summary": "ArticleIndividualization: GetPageArticleIndividualizationByBatch", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleIndividualization-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleIndividualization_GetPageArticleIndividualizationByBatch_AB1791157B15", "parameters": [ { "name": "IsBatch", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "IsForSale", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "ArticleId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "WarehouseId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "BinLocationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleIndividualization/PageAsc": { "get": { "tags": [ "ArticleIndividualization" ], "summary": "ArticleIndividualization: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleIndividualization-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleIndividualization_GetPageAsc_6A91DA956D47", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleIndividualization/SearchByValue": { "post": { "tags": [ "ArticleIndividualization" ], "summary": "ArticleIndividualization: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleIndividualization-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleIndividualization_SearchByValue_3602DA1EBF1B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleIndividualization" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleIndividualization" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleIndividualization" } } } } } } }, "/api/ArticleIndividualization/TryGetByValue": { "post": { "tags": [ "ArticleIndividualization" ], "summary": "ArticleIndividualization: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleIndividualization-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleIndividualization_TryGetByValue_5F7434097794", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleIndividualization" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleIndividualization" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleIndividualization" } } } } } } }, "/api/ArticleIndividualization/UpsertGraph": { "put": { "tags": [ "ArticleIndividualization" ], "summary": "ArticleIndividualization: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleIndividualization-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleIndividualization_UpsertGraph_86D935BDC5E0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleIndividualization" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleIndividualization" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleIndividualization" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleIndividualization" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleIndividualization" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleIndividualization" } } } } } } }, "/api/ArticleIndividualization/UpsertGraphWithExtraFields": { "put": { "tags": [ "ArticleIndividualization" ], "summary": "ArticleIndividualization: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleIndividualization-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleIndividualization_UpsertGraphWithExtraFields_2153FFFC2E58", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleIndividualization" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleIndividualization" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleIndividualization" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleIndividualization" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleIndividualization" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleIndividualization" } } } } } } }, "/api/ArticleIndividualizationQuantity": { "get": { "tags": [ "ArticleIndividualizationQuantity" ], "summary": "ArticleIndividualizationQuantity: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleIndividualizationQuantity-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleIndividualizationQuantity_GetAll_1455F466BDC5", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleIndividualizationQuantity" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleIndividualizationQuantity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleIndividualizationQuantity" } } } } } }, "post": { "tags": [ "ArticleIndividualizationQuantity" ], "summary": "ArticleIndividualizationQuantity: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleIndividualizationQuantity-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleIndividualizationQuantity_Post_D085C32F60F7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleIndividualizationQuantity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleIndividualizationQuantity" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleIndividualizationQuantity" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleIndividualizationQuantity" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleIndividualizationQuantity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleIndividualizationQuantity" } } } } } }, "put": { "tags": [ "ArticleIndividualizationQuantity" ], "summary": "ArticleIndividualizationQuantity: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleIndividualizationQuantity-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleIndividualizationQuantity_Put_D03CA31C6628", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleIndividualizationQuantity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleIndividualizationQuantity" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleIndividualizationQuantity" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleIndividualizationQuantity" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleIndividualizationQuantity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleIndividualizationQuantity" } } } } } } }, "/api/ArticleIndividualizationQuantity/{ArticleIndividualizationId}/GetPageFromView": { "get": { "tags": [ "ArticleIndividualizationQuantity" ], "summary": "ArticleIndividualizationQuantity: GetPageFromView", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleIndividualizationQuantity-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleIndividualizationQuantity_GetPageFromView_D0AFA008C29E", "parameters": [ { "name": "ArticleIndividualizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleIndividualizationQuantity/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "ArticleIndividualizationQuantity" ], "summary": "ArticleIndividualizationQuantity: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleIndividualizationQuantity-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleIndividualizationQuantity_GetPageByValue_D8EE723D3CD3", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleIndividualizationQuantity/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "ArticleIndividualizationQuantity" ], "summary": "ArticleIndividualizationQuantity: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleIndividualizationQuantity-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleIndividualizationQuantity_GetPageByValue2_EDB30C8371A6", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleIndividualizationQuantity/DeleteByFilter": { "post": { "tags": [ "ArticleIndividualizationQuantity" ], "summary": "ArticleIndividualizationQuantity: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleIndividualizationQuantity-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleIndividualizationQuantity_DeleteByFilter_A17BFB8D8D82", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/ArticleIndividualizationQuantity/GetAllByValue": { "post": { "tags": [ "ArticleIndividualizationQuantity" ], "summary": "ArticleIndividualizationQuantity: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleIndividualizationQuantity-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleIndividualizationQuantity_GetAllByValue_6C305FF730D2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleIndividualizationQuantity" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleIndividualizationQuantity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleIndividualizationQuantity" } } } } } } }, "/api/ArticleIndividualizationQuantity/GetAllGraphByValue": { "post": { "tags": [ "ArticleIndividualizationQuantity" ], "summary": "ArticleIndividualizationQuantity: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleIndividualizationQuantity-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleIndividualizationQuantity_GetAllGraphByValue_E81997A6D05E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleIndividualizationQuantity" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleIndividualizationQuantity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleIndividualizationQuantity" } } } } } } }, "/api/ArticleIndividualizationQuantity/GetByValue": { "post": { "tags": [ "ArticleIndividualizationQuantity" ], "summary": "ArticleIndividualizationQuantity: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleIndividualizationQuantity-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleIndividualizationQuantity_GetByValue_C7F017F800F9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleIndividualizationQuantity" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleIndividualizationQuantity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleIndividualizationQuantity" } } } } } } }, "/api/ArticleIndividualizationQuantity/GetLookup": { "post": { "tags": [ "ArticleIndividualizationQuantity" ], "summary": "ArticleIndividualizationQuantity: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleIndividualizationQuantity-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleIndividualizationQuantity_GetLookup_977E6A5F9C43", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ArticleIndividualizationQuantity/GetLookupByValue": { "post": { "tags": [ "ArticleIndividualizationQuantity" ], "summary": "ArticleIndividualizationQuantity: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleIndividualizationQuantity-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleIndividualizationQuantity_GetLookupByValue_18B654255C1F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ArticleIndividualizationQuantity/Page": { "get": { "tags": [ "ArticleIndividualizationQuantity" ], "summary": "ArticleIndividualizationQuantity: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleIndividualizationQuantity-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleIndividualizationQuantity_GetPage_C5AFFD146C79", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleIndividualizationQuantity/PageAsc": { "get": { "tags": [ "ArticleIndividualizationQuantity" ], "summary": "ArticleIndividualizationQuantity: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleIndividualizationQuantity-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleIndividualizationQuantity_GetPageAsc_543842BD3991", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleIndividualizationQuantity/SearchByValue": { "post": { "tags": [ "ArticleIndividualizationQuantity" ], "summary": "ArticleIndividualizationQuantity: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleIndividualizationQuantity-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleIndividualizationQuantity_SearchByValue_1B90267D9619", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleIndividualizationQuantity" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleIndividualizationQuantity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleIndividualizationQuantity" } } } } } } }, "/api/ArticleIndividualizationQuantity/TryGetByValue": { "post": { "tags": [ "ArticleIndividualizationQuantity" ], "summary": "ArticleIndividualizationQuantity: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleIndividualizationQuantity-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleIndividualizationQuantity_TryGetByValue_B6A01E2C6375", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleIndividualizationQuantity" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleIndividualizationQuantity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleIndividualizationQuantity" } } } } } } }, "/api/ArticleIndividualizationQuantity/UpsertGraph": { "put": { "tags": [ "ArticleIndividualizationQuantity" ], "summary": "ArticleIndividualizationQuantity: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleIndividualizationQuantity-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleIndividualizationQuantity_UpsertGraph_BDC2E0CBE92F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleIndividualizationQuantity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleIndividualizationQuantity" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleIndividualizationQuantity" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleIndividualizationQuantity" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleIndividualizationQuantity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleIndividualizationQuantity" } } } } } } }, "/api/ArticleIndividualizationQuantity/UpsertGraphWithExtraFields": { "put": { "tags": [ "ArticleIndividualizationQuantity" ], "summary": "ArticleIndividualizationQuantity: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleIndividualizationQuantity-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleIndividualizationQuantity_UpsertGraphWithExtraFields_9D4C6281FABF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleIndividualizationQuantity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleIndividualizationQuantity" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleIndividualizationQuantity" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleIndividualizationQuantity" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleIndividualizationQuantity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleIndividualizationQuantity" } } } } } } }, "/api/ArticleIndividualizationType": { "get": { "tags": [ "ArticleIndividualizationType" ], "summary": "ArticleIndividualizationType: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleIndividualizationType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleIndividualizationType_GetAll_153D0DF60E53", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleIndividualizationType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleIndividualizationType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleIndividualizationType" } } } } } }, "post": { "tags": [ "ArticleIndividualizationType" ], "summary": "ArticleIndividualizationType: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleIndividualizationType-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleIndividualizationType_Post_4024BBDC29A4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleIndividualizationType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleIndividualizationType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleIndividualizationType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleIndividualizationType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleIndividualizationType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleIndividualizationType" } } } } } }, "put": { "tags": [ "ArticleIndividualizationType" ], "summary": "ArticleIndividualizationType: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleIndividualizationType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleIndividualizationType_Put_8AEDE056D720", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleIndividualizationType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleIndividualizationType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleIndividualizationType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleIndividualizationType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleIndividualizationType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleIndividualizationType" } } } } } } }, "/api/ArticleIndividualizationType/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "ArticleIndividualizationType" ], "summary": "ArticleIndividualizationType: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleIndividualizationType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleIndividualizationType_GetPageByValue_B2B8E74F9D8A", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleIndividualizationType/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "ArticleIndividualizationType" ], "summary": "ArticleIndividualizationType: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleIndividualizationType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleIndividualizationType_GetPageByValue2_A961B61F5D3F", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleIndividualizationType/DeleteByFilter": { "post": { "tags": [ "ArticleIndividualizationType" ], "summary": "ArticleIndividualizationType: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleIndividualizationType-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleIndividualizationType_DeleteByFilter_6851416CB72B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/ArticleIndividualizationType/GetAllByValue": { "post": { "tags": [ "ArticleIndividualizationType" ], "summary": "ArticleIndividualizationType: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleIndividualizationType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleIndividualizationType_GetAllByValue_F0CE7A737347", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleIndividualizationType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleIndividualizationType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleIndividualizationType" } } } } } } }, "/api/ArticleIndividualizationType/GetAllGraphByValue": { "post": { "tags": [ "ArticleIndividualizationType" ], "summary": "ArticleIndividualizationType: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleIndividualizationType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleIndividualizationType_GetAllGraphByValue_0430B4C7EAA6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleIndividualizationType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleIndividualizationType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleIndividualizationType" } } } } } } }, "/api/ArticleIndividualizationType/GetByValue": { "post": { "tags": [ "ArticleIndividualizationType" ], "summary": "ArticleIndividualizationType: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleIndividualizationType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleIndividualizationType_GetByValue_A922BF1D21DD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleIndividualizationType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleIndividualizationType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleIndividualizationType" } } } } } } }, "/api/ArticleIndividualizationType/GetLookup": { "post": { "tags": [ "ArticleIndividualizationType" ], "summary": "ArticleIndividualizationType: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleIndividualizationType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleIndividualizationType_GetLookup_C8BBAA64F4F6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ArticleIndividualizationType/GetLookupByValue": { "post": { "tags": [ "ArticleIndividualizationType" ], "summary": "ArticleIndividualizationType: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleIndividualizationType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleIndividualizationType_GetLookupByValue_F7EFF0DDA12D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ArticleIndividualizationType/Page": { "get": { "tags": [ "ArticleIndividualizationType" ], "summary": "ArticleIndividualizationType: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleIndividualizationType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleIndividualizationType_GetPage_CD804BE7EE09", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleIndividualizationType/PageAsc": { "get": { "tags": [ "ArticleIndividualizationType" ], "summary": "ArticleIndividualizationType: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleIndividualizationType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleIndividualizationType_GetPageAsc_0C5F9F62F055", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleIndividualizationType/SearchByValue": { "post": { "tags": [ "ArticleIndividualizationType" ], "summary": "ArticleIndividualizationType: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleIndividualizationType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleIndividualizationType_SearchByValue_A4A93E06C019", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleIndividualizationType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleIndividualizationType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleIndividualizationType" } } } } } } }, "/api/ArticleIndividualizationType/TryGetByValue": { "post": { "tags": [ "ArticleIndividualizationType" ], "summary": "ArticleIndividualizationType: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleIndividualizationType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleIndividualizationType_TryGetByValue_E948B0AE966D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleIndividualizationType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleIndividualizationType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleIndividualizationType" } } } } } } }, "/api/ArticleIndividualizationType/UpsertGraph": { "put": { "tags": [ "ArticleIndividualizationType" ], "summary": "ArticleIndividualizationType: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleIndividualizationType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleIndividualizationType_UpsertGraph_72BF6B0A6789", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleIndividualizationType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleIndividualizationType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleIndividualizationType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleIndividualizationType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleIndividualizationType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleIndividualizationType" } } } } } } }, "/api/ArticleIndividualizationType/UpsertGraphWithExtraFields": { "put": { "tags": [ "ArticleIndividualizationType" ], "summary": "ArticleIndividualizationType: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleIndividualizationType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleIndividualizationType_UpsertGraphWithExtraFields_F3CE9E2413DA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleIndividualizationType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleIndividualizationType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleIndividualizationType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleIndividualizationType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleIndividualizationType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleIndividualizationType" } } } } } } }, "/api/ArticleInfoText": { "get": { "tags": [ "ArticleInfoText" ], "summary": "ArticleInfoText: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleInfoText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleInfoText_GetAll_3123BA34A847", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleInfoText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleInfoText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleInfoText" } } } } } }, "post": { "tags": [ "ArticleInfoText" ], "summary": "ArticleInfoText: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleInfoText-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleInfoText_Post_8FCD117C3967", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleInfoText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleInfoText" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleInfoText" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleInfoText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleInfoText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleInfoText" } } } } } }, "put": { "tags": [ "ArticleInfoText" ], "summary": "ArticleInfoText: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleInfoText-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleInfoText_Put_284F7D30D73F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleInfoText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleInfoText" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleInfoText" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleInfoText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleInfoText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleInfoText" } } } } } } }, "/api/ArticleInfoText/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "ArticleInfoText" ], "summary": "ArticleInfoText: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleInfoText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleInfoText_GetPageByValue_AF3E34D702B6", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleInfoText/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "ArticleInfoText" ], "summary": "ArticleInfoText: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleInfoText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleInfoText_GetPageByValue2_6F5507A9158D", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleInfoText/DeleteByFilter": { "post": { "tags": [ "ArticleInfoText" ], "summary": "ArticleInfoText: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleInfoText-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleInfoText_DeleteByFilter_20E5A780925A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/ArticleInfoText/GetAllByValue": { "post": { "tags": [ "ArticleInfoText" ], "summary": "ArticleInfoText: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleInfoText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleInfoText_GetAllByValue_235B50D1A849", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleInfoText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleInfoText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleInfoText" } } } } } } }, "/api/ArticleInfoText/GetAllGraphByValue": { "post": { "tags": [ "ArticleInfoText" ], "summary": "ArticleInfoText: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleInfoText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleInfoText_GetAllGraphByValue_E8D743F9EEB7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleInfoText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleInfoText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleInfoText" } } } } } } }, "/api/ArticleInfoText/GetByValue": { "post": { "tags": [ "ArticleInfoText" ], "summary": "ArticleInfoText: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleInfoText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleInfoText_GetByValue_770ECF144659", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleInfoText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleInfoText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleInfoText" } } } } } } }, "/api/ArticleInfoText/GetLookup": { "post": { "tags": [ "ArticleInfoText" ], "summary": "ArticleInfoText: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleInfoText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleInfoText_GetLookup_D9F9ADDFF1A4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ArticleInfoText/GetLookupByValue": { "post": { "tags": [ "ArticleInfoText" ], "summary": "ArticleInfoText: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleInfoText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleInfoText_GetLookupByValue_52AC2F113A60", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ArticleInfoText/Page": { "get": { "tags": [ "ArticleInfoText" ], "summary": "ArticleInfoText: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleInfoText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleInfoText_GetPage_1A2DACFF1561", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleInfoText/PageAsc": { "get": { "tags": [ "ArticleInfoText" ], "summary": "ArticleInfoText: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleInfoText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleInfoText_GetPageAsc_CA27B2B42CA7", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleInfoText/SearchByValue": { "post": { "tags": [ "ArticleInfoText" ], "summary": "ArticleInfoText: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleInfoText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleInfoText_SearchByValue_393FC8B9CED4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleInfoText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleInfoText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleInfoText" } } } } } } }, "/api/ArticleInfoText/TryGetByValue": { "post": { "tags": [ "ArticleInfoText" ], "summary": "ArticleInfoText: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleInfoText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleInfoText_TryGetByValue_714E81A2D1C6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleInfoText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleInfoText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleInfoText" } } } } } } }, "/api/ArticleInfoText/UpsertGraph": { "put": { "tags": [ "ArticleInfoText" ], "summary": "ArticleInfoText: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleInfoText-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleInfoText_UpsertGraph_1B5C48DE0ED0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleInfoText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleInfoText" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleInfoText" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleInfoText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleInfoText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleInfoText" } } } } } } }, "/api/ArticleInfoText/UpsertGraphWithExtraFields": { "put": { "tags": [ "ArticleInfoText" ], "summary": "ArticleInfoText: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleInfoText-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleInfoText_UpsertGraphWithExtraFields_5A3159114AFA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleInfoText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleInfoText" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleInfoText" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleInfoText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleInfoText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleInfoText" } } } } } } }, "/api/ArticleMacro": { "get": { "tags": [ "ArticleMacro" ], "summary": "ArticleMacro: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleMacro-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleMacro_GetAll_DE9B3772B822", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleMacro" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleMacro" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleMacro" } } } } } }, "post": { "tags": [ "ArticleMacro" ], "summary": "ArticleMacro: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleMacro-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleMacro_Post_085056ACA7C3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleMacro" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleMacro" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleMacro" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleMacro" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleMacro" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleMacro" } } } } } }, "put": { "tags": [ "ArticleMacro" ], "summary": "ArticleMacro: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleMacro-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleMacro_Put_B0B66E29BB86", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleMacro" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleMacro" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleMacro" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleMacro" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleMacro" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleMacro" } } } } } } }, "/api/ArticleMacro/{ArticleId}/PageFromViewByArticleId": { "get": { "tags": [ "ArticleMacro" ], "summary": "ArticleMacro: GetPageFromViewByArticleId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleMacro-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleMacro_GetPageFromViewByArticleId_C0814FCF14C1", "parameters": [ { "name": "ArticleId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleMacro/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "ArticleMacro" ], "summary": "ArticleMacro: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleMacro-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleMacro_GetPageByValue_4ECF1EE54A9B", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleMacro/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "ArticleMacro" ], "summary": "ArticleMacro: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleMacro-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleMacro_GetPageByValue2_F3E242C8D0A9", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleMacro/DeleteByFilter": { "post": { "tags": [ "ArticleMacro" ], "summary": "ArticleMacro: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleMacro-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleMacro_DeleteByFilter_11447ED4EC1D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/ArticleMacro/GetAllByValue": { "post": { "tags": [ "ArticleMacro" ], "summary": "ArticleMacro: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleMacro-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleMacro_GetAllByValue_84A3ECE7B6F0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleMacro" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleMacro" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleMacro" } } } } } } }, "/api/ArticleMacro/GetAllGraphByValue": { "post": { "tags": [ "ArticleMacro" ], "summary": "ArticleMacro: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleMacro-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleMacro_GetAllGraphByValue_A6E97558F56B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleMacro" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleMacro" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleMacro" } } } } } } }, "/api/ArticleMacro/GetByValue": { "post": { "tags": [ "ArticleMacro" ], "summary": "ArticleMacro: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleMacro-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleMacro_GetByValue_9496D7FE5917", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleMacro" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleMacro" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleMacro" } } } } } } }, "/api/ArticleMacro/GetLookup": { "post": { "tags": [ "ArticleMacro" ], "summary": "ArticleMacro: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleMacro-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleMacro_GetLookup_CC830748D0A5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ArticleMacro/GetLookupByValue": { "post": { "tags": [ "ArticleMacro" ], "summary": "ArticleMacro: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleMacro-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleMacro_GetLookupByValue_A728204E7B18", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ArticleMacro/Page": { "get": { "tags": [ "ArticleMacro" ], "summary": "ArticleMacro: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleMacro-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleMacro_GetPage_F3C69CFBE7C7", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleMacro/PageAsc": { "get": { "tags": [ "ArticleMacro" ], "summary": "ArticleMacro: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleMacro-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleMacro_GetPageAsc_18E85AB1A29F", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleMacro/SearchByValue": { "post": { "tags": [ "ArticleMacro" ], "summary": "ArticleMacro: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleMacro-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleMacro_SearchByValue_7EAC50FB9C0E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleMacro" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleMacro" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleMacro" } } } } } } }, "/api/ArticleMacro/TryGetByValue": { "post": { "tags": [ "ArticleMacro" ], "summary": "ArticleMacro: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleMacro-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleMacro_TryGetByValue_4A1912463C40", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleMacro" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleMacro" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleMacro" } } } } } } }, "/api/ArticleMacro/UpsertGraph": { "put": { "tags": [ "ArticleMacro" ], "summary": "ArticleMacro: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleMacro-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleMacro_UpsertGraph_380F2CE85F39", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleMacro" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleMacro" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleMacro" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleMacro" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleMacro" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleMacro" } } } } } } }, "/api/ArticleMacro/UpsertGraphWithExtraFields": { "put": { "tags": [ "ArticleMacro" ], "summary": "ArticleMacro: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleMacro-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleMacro_UpsertGraphWithExtraFields_CCF56A4F2DDF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleMacro" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleMacro" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleMacro" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleMacro" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleMacro" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleMacro" } } } } } } }, "/api/ArticleOrderText": { "get": { "tags": [ "ArticleOrderText" ], "summary": "ArticleOrderText: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleOrderText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleOrderText_GetAll_68E7EA8F195D", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleOrderText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleOrderText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleOrderText" } } } } } }, "post": { "tags": [ "ArticleOrderText" ], "summary": "ArticleOrderText: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleOrderText-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleOrderText_Post_85B335535C2B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleOrderText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleOrderText" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleOrderText" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleOrderText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleOrderText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleOrderText" } } } } } }, "put": { "tags": [ "ArticleOrderText" ], "summary": "ArticleOrderText: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleOrderText-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleOrderText_Put_87F9E697AFF7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleOrderText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleOrderText" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleOrderText" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleOrderText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleOrderText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleOrderText" } } } } } } }, "/api/ArticleOrderText/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "ArticleOrderText" ], "summary": "ArticleOrderText: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleOrderText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleOrderText_GetPageByValue_B5A0643BE8C9", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleOrderText/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "ArticleOrderText" ], "summary": "ArticleOrderText: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleOrderText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleOrderText_GetPageByValue2_D0686D6B2EFF", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleOrderText/DeleteByFilter": { "post": { "tags": [ "ArticleOrderText" ], "summary": "ArticleOrderText: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleOrderText-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleOrderText_DeleteByFilter_C284641C0525", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/ArticleOrderText/GetAllByValue": { "post": { "tags": [ "ArticleOrderText" ], "summary": "ArticleOrderText: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleOrderText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleOrderText_GetAllByValue_E3324CBAFDAC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleOrderText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleOrderText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleOrderText" } } } } } } }, "/api/ArticleOrderText/GetAllGraphByValue": { "post": { "tags": [ "ArticleOrderText" ], "summary": "ArticleOrderText: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleOrderText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleOrderText_GetAllGraphByValue_6D0978AB59B7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleOrderText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleOrderText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleOrderText" } } } } } } }, "/api/ArticleOrderText/GetByValue": { "post": { "tags": [ "ArticleOrderText" ], "summary": "ArticleOrderText: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleOrderText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleOrderText_GetByValue_8936F1891A0C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleOrderText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleOrderText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleOrderText" } } } } } } }, "/api/ArticleOrderText/GetLookup": { "post": { "tags": [ "ArticleOrderText" ], "summary": "ArticleOrderText: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleOrderText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleOrderText_GetLookup_2D10807509B7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ArticleOrderText/GetLookupByValue": { "post": { "tags": [ "ArticleOrderText" ], "summary": "ArticleOrderText: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleOrderText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleOrderText_GetLookupByValue_A1D04DC585EF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ArticleOrderText/Page": { "get": { "tags": [ "ArticleOrderText" ], "summary": "ArticleOrderText: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleOrderText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleOrderText_GetPage_FA9021889973", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleOrderText/PageAsc": { "get": { "tags": [ "ArticleOrderText" ], "summary": "ArticleOrderText: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleOrderText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleOrderText_GetPageAsc_B40F60FC4FAC", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleOrderText/SearchByValue": { "post": { "tags": [ "ArticleOrderText" ], "summary": "ArticleOrderText: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleOrderText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleOrderText_SearchByValue_59A3B4B545C9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleOrderText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleOrderText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleOrderText" } } } } } } }, "/api/ArticleOrderText/TryGetByValue": { "post": { "tags": [ "ArticleOrderText" ], "summary": "ArticleOrderText: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleOrderText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleOrderText_TryGetByValue_F17696C2027C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleOrderText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleOrderText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleOrderText" } } } } } } }, "/api/ArticleOrderText/UpsertGraph": { "put": { "tags": [ "ArticleOrderText" ], "summary": "ArticleOrderText: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleOrderText-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleOrderText_UpsertGraph_DD8523BD3B14", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleOrderText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleOrderText" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleOrderText" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleOrderText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleOrderText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleOrderText" } } } } } } }, "/api/ArticleOrderText/UpsertGraphWithExtraFields": { "put": { "tags": [ "ArticleOrderText" ], "summary": "ArticleOrderText: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleOrderText-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleOrderText_UpsertGraphWithExtraFields_E84BF390963E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleOrderText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleOrderText" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleOrderText" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleOrderText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleOrderText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleOrderText" } } } } } } }, "/api/ArticlePicture": { "get": { "tags": [ "ArticlePicture" ], "summary": "ArticlePicture: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticlePicture-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticlePicture_GetAll_18E68E3D2FD1", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticlePicture" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticlePicture" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticlePicture" } } } } } }, "post": { "tags": [ "ArticlePicture" ], "summary": "ArticlePicture: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticlePicture-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticlePicture_Post_29DEAEBDBD35", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticlePicture" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticlePicture" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticlePicture" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticlePicture" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticlePicture" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticlePicture" } } } } } }, "put": { "tags": [ "ArticlePicture" ], "summary": "ArticlePicture: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticlePicture-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticlePicture_Put_38694E73C605", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticlePicture" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticlePicture" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticlePicture" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticlePicture" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticlePicture" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticlePicture" } } } } } } }, "/api/ArticlePicture/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "ArticlePicture" ], "summary": "ArticlePicture: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticlePicture-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticlePicture_GetPageByValue_C493D556FD56", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticlePicture/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "ArticlePicture" ], "summary": "ArticlePicture: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticlePicture-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticlePicture_GetPageByValue2_BE03F907DF41", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticlePicture/DeleteByFilter": { "post": { "tags": [ "ArticlePicture" ], "summary": "ArticlePicture: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticlePicture-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticlePicture_DeleteByFilter_DFB005D6C2CE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/ArticlePicture/GetAllByValue": { "post": { "tags": [ "ArticlePicture" ], "summary": "ArticlePicture: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticlePicture-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticlePicture_GetAllByValue_B2C69EE22418", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticlePicture" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticlePicture" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticlePicture" } } } } } } }, "/api/ArticlePicture/GetAllGraphByValue": { "post": { "tags": [ "ArticlePicture" ], "summary": "ArticlePicture: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticlePicture-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticlePicture_GetAllGraphByValue_BA83784ECED3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticlePicture" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticlePicture" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticlePicture" } } } } } } }, "/api/ArticlePicture/GetByValue": { "post": { "tags": [ "ArticlePicture" ], "summary": "ArticlePicture: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticlePicture-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticlePicture_GetByValue_40D74E244D22", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticlePicture" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticlePicture" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticlePicture" } } } } } } }, "/api/ArticlePicture/GetLookup": { "post": { "tags": [ "ArticlePicture" ], "summary": "ArticlePicture: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticlePicture-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticlePicture_GetLookup_D7D7B1E3552D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ArticlePicture/GetLookupByValue": { "post": { "tags": [ "ArticlePicture" ], "summary": "ArticlePicture: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticlePicture-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticlePicture_GetLookupByValue_68951C5D0315", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ArticlePicture/Page": { "get": { "tags": [ "ArticlePicture" ], "summary": "ArticlePicture: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticlePicture-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticlePicture_GetPage_39AC5309CE36", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticlePicture/PageAsc": { "get": { "tags": [ "ArticlePicture" ], "summary": "ArticlePicture: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticlePicture-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticlePicture_GetPageAsc_FAB9A42FFC82", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticlePicture/SearchByValue": { "post": { "tags": [ "ArticlePicture" ], "summary": "ArticlePicture: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticlePicture-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticlePicture_SearchByValue_35FD4C613F6B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticlePicture" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticlePicture" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticlePicture" } } } } } } }, "/api/ArticlePicture/TryGetByValue": { "post": { "tags": [ "ArticlePicture" ], "summary": "ArticlePicture: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticlePicture-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticlePicture_TryGetByValue_A013EB8820BB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticlePicture" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticlePicture" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticlePicture" } } } } } } }, "/api/ArticlePicture/UpsertGraph": { "put": { "tags": [ "ArticlePicture" ], "summary": "ArticlePicture: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticlePicture-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticlePicture_UpsertGraph_2F878F32095C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticlePicture" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticlePicture" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticlePicture" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticlePicture" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticlePicture" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticlePicture" } } } } } } }, "/api/ArticlePicture/UpsertGraphWithExtraFields": { "put": { "tags": [ "ArticlePicture" ], "summary": "ArticlePicture: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticlePicture-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticlePicture_UpsertGraphWithExtraFields_ADDEE682C985", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticlePicture" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticlePicture" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticlePicture" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticlePicture" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticlePicture" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticlePicture" } } } } } } }, "/api/ArticlePriceCalculation": { "get": { "tags": [ "ArticlePriceCalculation" ], "summary": "ArticlePriceCalculation: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticlePriceCalculation-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticlePriceCalculation_GetAll_5E88001EAA05", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticlePriceCalculation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticlePriceCalculation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticlePriceCalculation" } } } } } }, "post": { "tags": [ "ArticlePriceCalculation" ], "summary": "ArticlePriceCalculation: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticlePriceCalculation-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticlePriceCalculation_Post_4AE2D4CAAC69", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticlePriceCalculation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticlePriceCalculation" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticlePriceCalculation" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticlePriceCalculation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticlePriceCalculation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticlePriceCalculation" } } } } } }, "put": { "tags": [ "ArticlePriceCalculation" ], "summary": "ArticlePriceCalculation: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticlePriceCalculation-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticlePriceCalculation_Put_D8A5D6B64807", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticlePriceCalculation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticlePriceCalculation" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticlePriceCalculation" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticlePriceCalculation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticlePriceCalculation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticlePriceCalculation" } } } } } } }, "/api/ArticlePriceCalculation/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "ArticlePriceCalculation" ], "summary": "ArticlePriceCalculation: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticlePriceCalculation-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticlePriceCalculation_GetPageByValue_47D8256CF33E", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticlePriceCalculation/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "ArticlePriceCalculation" ], "summary": "ArticlePriceCalculation: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticlePriceCalculation-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticlePriceCalculation_GetPageByValue2_675D1B6FD14F", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticlePriceCalculation/DeleteByFilter": { "post": { "tags": [ "ArticlePriceCalculation" ], "summary": "ArticlePriceCalculation: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticlePriceCalculation-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticlePriceCalculation_DeleteByFilter_C89688C3DC74", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/ArticlePriceCalculation/GetAllByValue": { "post": { "tags": [ "ArticlePriceCalculation" ], "summary": "ArticlePriceCalculation: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticlePriceCalculation-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticlePriceCalculation_GetAllByValue_D33B7F3E93BC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticlePriceCalculation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticlePriceCalculation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticlePriceCalculation" } } } } } } }, "/api/ArticlePriceCalculation/GetAllGraphByValue": { "post": { "tags": [ "ArticlePriceCalculation" ], "summary": "ArticlePriceCalculation: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticlePriceCalculation-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticlePriceCalculation_GetAllGraphByValue_70497B318E14", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticlePriceCalculation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticlePriceCalculation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticlePriceCalculation" } } } } } } }, "/api/ArticlePriceCalculation/GetByValue": { "post": { "tags": [ "ArticlePriceCalculation" ], "summary": "ArticlePriceCalculation: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticlePriceCalculation-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticlePriceCalculation_GetByValue_9744893AEC0D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticlePriceCalculation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticlePriceCalculation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticlePriceCalculation" } } } } } } }, "/api/ArticlePriceCalculation/GetLookup": { "post": { "tags": [ "ArticlePriceCalculation" ], "summary": "ArticlePriceCalculation: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticlePriceCalculation-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticlePriceCalculation_GetLookup_0FB8FE45062C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ArticlePriceCalculation/GetLookupByValue": { "post": { "tags": [ "ArticlePriceCalculation" ], "summary": "ArticlePriceCalculation: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticlePriceCalculation-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticlePriceCalculation_GetLookupByValue_7FC39F8BB937", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ArticlePriceCalculation/Page": { "get": { "tags": [ "ArticlePriceCalculation" ], "summary": "ArticlePriceCalculation: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticlePriceCalculation-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticlePriceCalculation_GetPage_A5136E52749F", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticlePriceCalculation/PageAsc": { "get": { "tags": [ "ArticlePriceCalculation" ], "summary": "ArticlePriceCalculation: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticlePriceCalculation-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticlePriceCalculation_GetPageAsc_50801775C06A", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticlePriceCalculation/SearchByValue": { "post": { "tags": [ "ArticlePriceCalculation" ], "summary": "ArticlePriceCalculation: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticlePriceCalculation-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticlePriceCalculation_SearchByValue_2D3B357E5E3C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticlePriceCalculation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticlePriceCalculation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticlePriceCalculation" } } } } } } }, "/api/ArticlePriceCalculation/TryGetByValue": { "post": { "tags": [ "ArticlePriceCalculation" ], "summary": "ArticlePriceCalculation: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticlePriceCalculation-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticlePriceCalculation_TryGetByValue_22FBE9830DD1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticlePriceCalculation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticlePriceCalculation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticlePriceCalculation" } } } } } } }, "/api/ArticlePriceCalculation/UpsertGraph": { "put": { "tags": [ "ArticlePriceCalculation" ], "summary": "ArticlePriceCalculation: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticlePriceCalculation-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticlePriceCalculation_UpsertGraph_CB9817A8890A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticlePriceCalculation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticlePriceCalculation" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticlePriceCalculation" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticlePriceCalculation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticlePriceCalculation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticlePriceCalculation" } } } } } } }, "/api/ArticlePriceCalculation/UpsertGraphWithExtraFields": { "put": { "tags": [ "ArticlePriceCalculation" ], "summary": "ArticlePriceCalculation: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticlePriceCalculation-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticlePriceCalculation_UpsertGraphWithExtraFields_2FDC2B5FF0F8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticlePriceCalculation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticlePriceCalculation" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticlePriceCalculation" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticlePriceCalculation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticlePriceCalculation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticlePriceCalculation" } } } } } } }, "/api/ArticlePriceUnit": { "get": { "tags": [ "ArticlePriceUnit" ], "summary": "ArticlePriceUnit: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticlePriceUnit-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticlePriceUnit_GetAll_76EFA5C1F590", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticlePriceUnit" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticlePriceUnit" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticlePriceUnit" } } } } } }, "post": { "tags": [ "ArticlePriceUnit" ], "summary": "ArticlePriceUnit: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticlePriceUnit-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticlePriceUnit_Post_3FAB0518429A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticlePriceUnit" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticlePriceUnit" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticlePriceUnit" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticlePriceUnit" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticlePriceUnit" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticlePriceUnit" } } } } } }, "put": { "tags": [ "ArticlePriceUnit" ], "summary": "ArticlePriceUnit: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticlePriceUnit-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticlePriceUnit_Put_3F1BDD426A1E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticlePriceUnit" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticlePriceUnit" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticlePriceUnit" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticlePriceUnit" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticlePriceUnit" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticlePriceUnit" } } } } } } }, "/api/ArticlePriceUnit/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "ArticlePriceUnit" ], "summary": "ArticlePriceUnit: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticlePriceUnit-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticlePriceUnit_GetPageByValue_411DE3C16BA0", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticlePriceUnit/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "ArticlePriceUnit" ], "summary": "ArticlePriceUnit: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticlePriceUnit-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticlePriceUnit_GetPageByValue2_33A0B856D019", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticlePriceUnit/DeleteByFilter": { "post": { "tags": [ "ArticlePriceUnit" ], "summary": "ArticlePriceUnit: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticlePriceUnit-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticlePriceUnit_DeleteByFilter_8727925CA5E6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/ArticlePriceUnit/GetAllByValue": { "post": { "tags": [ "ArticlePriceUnit" ], "summary": "ArticlePriceUnit: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticlePriceUnit-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticlePriceUnit_GetAllByValue_A674085D5A2C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticlePriceUnit" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticlePriceUnit" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticlePriceUnit" } } } } } } }, "/api/ArticlePriceUnit/GetAllGraphByValue": { "post": { "tags": [ "ArticlePriceUnit" ], "summary": "ArticlePriceUnit: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticlePriceUnit-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticlePriceUnit_GetAllGraphByValue_9AB0D92A822F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticlePriceUnit" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticlePriceUnit" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticlePriceUnit" } } } } } } }, "/api/ArticlePriceUnit/GetByValue": { "post": { "tags": [ "ArticlePriceUnit" ], "summary": "ArticlePriceUnit: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticlePriceUnit-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticlePriceUnit_GetByValue_6410A007B9AC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticlePriceUnit" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticlePriceUnit" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticlePriceUnit" } } } } } } }, "/api/ArticlePriceUnit/GetLookup": { "post": { "tags": [ "ArticlePriceUnit" ], "summary": "ArticlePriceUnit: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticlePriceUnit-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticlePriceUnit_GetLookup_079577BF6CAB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ArticlePriceUnit/GetLookupByValue": { "post": { "tags": [ "ArticlePriceUnit" ], "summary": "ArticlePriceUnit: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticlePriceUnit-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticlePriceUnit_GetLookupByValue_A210521B864C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ArticlePriceUnit/Page": { "get": { "tags": [ "ArticlePriceUnit" ], "summary": "ArticlePriceUnit: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticlePriceUnit-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticlePriceUnit_GetPage_94066D23E741", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticlePriceUnit/PageAsc": { "get": { "tags": [ "ArticlePriceUnit" ], "summary": "ArticlePriceUnit: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticlePriceUnit-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticlePriceUnit_GetPageAsc_03CE928692F2", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticlePriceUnit/SearchByValue": { "post": { "tags": [ "ArticlePriceUnit" ], "summary": "ArticlePriceUnit: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticlePriceUnit-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticlePriceUnit_SearchByValue_098CABCE34DD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticlePriceUnit" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticlePriceUnit" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticlePriceUnit" } } } } } } }, "/api/ArticlePriceUnit/TryGetByValue": { "post": { "tags": [ "ArticlePriceUnit" ], "summary": "ArticlePriceUnit: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticlePriceUnit-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticlePriceUnit_TryGetByValue_E1E8DAB93F0C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticlePriceUnit" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticlePriceUnit" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticlePriceUnit" } } } } } } }, "/api/ArticlePriceUnit/UpsertGraph": { "put": { "tags": [ "ArticlePriceUnit" ], "summary": "ArticlePriceUnit: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticlePriceUnit-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticlePriceUnit_UpsertGraph_04EA83BAD9DA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticlePriceUnit" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticlePriceUnit" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticlePriceUnit" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticlePriceUnit" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticlePriceUnit" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticlePriceUnit" } } } } } } }, "/api/ArticlePriceUnit/UpsertGraphWithExtraFields": { "put": { "tags": [ "ArticlePriceUnit" ], "summary": "ArticlePriceUnit: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticlePriceUnit-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticlePriceUnit_UpsertGraphWithExtraFields_5298F02FD4F9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticlePriceUnit" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticlePriceUnit" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticlePriceUnit" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticlePriceUnit" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticlePriceUnit" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticlePriceUnit" } } } } } } }, "/api/ArticleProcurementType": { "get": { "tags": [ "ArticleProcurementType" ], "summary": "ArticleProcurementType: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProcurementType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProcurementType_GetAll_F28AF22E6558", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleProcurementType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleProcurementType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleProcurementType" } } } } } }, "post": { "tags": [ "ArticleProcurementType" ], "summary": "ArticleProcurementType: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProcurementType-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProcurementType_Post_8F7EBC64A9EB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProcurementType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProcurementType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProcurementType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProcurementType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProcurementType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProcurementType" } } } } } }, "put": { "tags": [ "ArticleProcurementType" ], "summary": "ArticleProcurementType: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProcurementType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProcurementType_Put_C718204DB2AA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProcurementType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProcurementType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProcurementType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProcurementType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProcurementType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProcurementType" } } } } } } }, "/api/ArticleProcurementType/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "ArticleProcurementType" ], "summary": "ArticleProcurementType: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProcurementType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProcurementType_GetPageByValue_2B65AF191558", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleProcurementType/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "ArticleProcurementType" ], "summary": "ArticleProcurementType: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProcurementType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProcurementType_GetPageByValue2_7FCE91C87C83", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleProcurementType/DeleteByFilter": { "post": { "tags": [ "ArticleProcurementType" ], "summary": "ArticleProcurementType: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProcurementType-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProcurementType_DeleteByFilter_32DC0C542A5B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/ArticleProcurementType/GetAllByValue": { "post": { "tags": [ "ArticleProcurementType" ], "summary": "ArticleProcurementType: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProcurementType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProcurementType_GetAllByValue_03390CD30F47", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleProcurementType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleProcurementType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleProcurementType" } } } } } } }, "/api/ArticleProcurementType/GetAllGraphByValue": { "post": { "tags": [ "ArticleProcurementType" ], "summary": "ArticleProcurementType: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProcurementType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProcurementType_GetAllGraphByValue_73394FBB9C1F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleProcurementType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleProcurementType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleProcurementType" } } } } } } }, "/api/ArticleProcurementType/GetByValue": { "post": { "tags": [ "ArticleProcurementType" ], "summary": "ArticleProcurementType: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProcurementType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProcurementType_GetByValue_ACBEF6376D2A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProcurementType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProcurementType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProcurementType" } } } } } } }, "/api/ArticleProcurementType/GetLookup": { "post": { "tags": [ "ArticleProcurementType" ], "summary": "ArticleProcurementType: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProcurementType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProcurementType_GetLookup_305A79DB416B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ArticleProcurementType/GetLookupByValue": { "post": { "tags": [ "ArticleProcurementType" ], "summary": "ArticleProcurementType: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProcurementType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProcurementType_GetLookupByValue_C81BCB8AB7DD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ArticleProcurementType/Page": { "get": { "tags": [ "ArticleProcurementType" ], "summary": "ArticleProcurementType: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProcurementType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProcurementType_GetPage_89F271D23402", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleProcurementType/PageAsc": { "get": { "tags": [ "ArticleProcurementType" ], "summary": "ArticleProcurementType: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProcurementType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProcurementType_GetPageAsc_86352B00E37E", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleProcurementType/SearchByValue": { "post": { "tags": [ "ArticleProcurementType" ], "summary": "ArticleProcurementType: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProcurementType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProcurementType_SearchByValue_02ECE71C4B27", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleProcurementType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleProcurementType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleProcurementType" } } } } } } }, "/api/ArticleProcurementType/TryGetByValue": { "post": { "tags": [ "ArticleProcurementType" ], "summary": "ArticleProcurementType: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProcurementType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProcurementType_TryGetByValue_6CA2539C8C6D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProcurementType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProcurementType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProcurementType" } } } } } } }, "/api/ArticleProcurementType/UpsertGraph": { "put": { "tags": [ "ArticleProcurementType" ], "summary": "ArticleProcurementType: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProcurementType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProcurementType_UpsertGraph_81158A3DA6C1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProcurementType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProcurementType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProcurementType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProcurementType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProcurementType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProcurementType" } } } } } } }, "/api/ArticleProcurementType/UpsertGraphWithExtraFields": { "put": { "tags": [ "ArticleProcurementType" ], "summary": "ArticleProcurementType: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProcurementType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProcurementType_UpsertGraphWithExtraFields_5EA6AFC7E2DD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleProcurementType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleProcurementType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleProcurementType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleProcurementType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleProcurementType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleProcurementType" } } } } } } }, "/api/ArticleProduct": { "get": { "tags": [ "ArticleProduct" ], "summary": "ArticleProduct: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProduct-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProduct_GetAll_1C2C23D4F7CB", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleProduct" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleProduct" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleProduct" } } } } } }, "post": { "tags": [ "ArticleProduct" ], "summary": "ArticleProduct: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProduct-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProduct_Post_A91BE200A775", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProduct" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProduct" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProduct" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProduct" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProduct" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProduct" } } } } } }, "put": { "tags": [ "ArticleProduct" ], "summary": "ArticleProduct: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProduct-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProduct_Put_B8DF03059F8B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProduct" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProduct" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProduct" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProduct" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProduct" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProduct" } } } } } } }, "/api/ArticleProduct/{ArticleId}/GetProductionStepComponents": { "get": { "tags": [ "ArticleProduct" ], "summary": "ArticleProduct: GetProductionStepComponents", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProduct-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProduct_GetProductionStepComponents_0E2E28EAF3DC", "parameters": [ { "name": "ArticleId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleProduct" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleProduct" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleProduct" } } } } } } }, "/api/ArticleProduct/{ArticleId}/PageFromViewByArticleId": { "get": { "tags": [ "ArticleProduct" ], "summary": "ArticleProduct: GetPageFromViewByArticleId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProduct-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProduct_GetPageFromViewByArticleId_FE6640FAA376", "parameters": [ { "name": "ArticleId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleProduct/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "ArticleProduct" ], "summary": "ArticleProduct: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProduct-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProduct_GetPageByValue_31EBBF72FD3F", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleProduct/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "ArticleProduct" ], "summary": "ArticleProduct: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProduct-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProduct_GetPageByValue2_3E0363B8C458", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleProduct/DeleteByFilter": { "post": { "tags": [ "ArticleProduct" ], "summary": "ArticleProduct: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProduct-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProduct_DeleteByFilter_4C2A865FC563", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/ArticleProduct/GetAllByValue": { "post": { "tags": [ "ArticleProduct" ], "summary": "ArticleProduct: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProduct-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProduct_GetAllByValue_F2A2702956D7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleProduct" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleProduct" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleProduct" } } } } } } }, "/api/ArticleProduct/GetAllGraphByValue": { "post": { "tags": [ "ArticleProduct" ], "summary": "ArticleProduct: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProduct-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProduct_GetAllGraphByValue_AE24EA0FE1A1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleProduct" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleProduct" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleProduct" } } } } } } }, "/api/ArticleProduct/GetByValue": { "post": { "tags": [ "ArticleProduct" ], "summary": "ArticleProduct: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProduct-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProduct_GetByValue_DFBB9D3A10C7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProduct" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProduct" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProduct" } } } } } } }, "/api/ArticleProduct/GetLookup": { "post": { "tags": [ "ArticleProduct" ], "summary": "ArticleProduct: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProduct-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProduct_GetLookup_D9CE9BF8DF66", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ArticleProduct/GetLookupByValue": { "post": { "tags": [ "ArticleProduct" ], "summary": "ArticleProduct: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProduct-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProduct_GetLookupByValue_65FDFEEF1BCA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ArticleProduct/Page": { "get": { "tags": [ "ArticleProduct" ], "summary": "ArticleProduct: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProduct-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProduct_GetPage_785637C476C9", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleProduct/PageAsc": { "get": { "tags": [ "ArticleProduct" ], "summary": "ArticleProduct: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProduct-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProduct_GetPageAsc_08E9B96E0E68", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleProduct/SearchByValue": { "post": { "tags": [ "ArticleProduct" ], "summary": "ArticleProduct: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProduct-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProduct_SearchByValue_5605777A0CD6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleProduct" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleProduct" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleProduct" } } } } } } }, "/api/ArticleProduct/TryGetByValue": { "post": { "tags": [ "ArticleProduct" ], "summary": "ArticleProduct: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProduct-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProduct_TryGetByValue_C503DDAD37CE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProduct" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProduct" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProduct" } } } } } } }, "/api/ArticleProduct/UpsertGraph": { "put": { "tags": [ "ArticleProduct" ], "summary": "ArticleProduct: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProduct-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProduct_UpsertGraph_8EAB2AFC6AC9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProduct" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProduct" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProduct" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProduct" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProduct" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProduct" } } } } } } }, "/api/ArticleProduct/UpsertGraphWithExtraFields": { "put": { "tags": [ "ArticleProduct" ], "summary": "ArticleProduct: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProduct-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProduct_UpsertGraphWithExtraFields_4378E442688D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleProduct" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleProduct" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleProduct" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleProduct" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleProduct" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleProduct" } } } } } } }, "/api/ArticleProductDependencyType": { "get": { "tags": [ "ArticleProductDependencyType" ], "summary": "ArticleProductDependencyType: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProductDependencyType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProductDependencyType_GetAll_AD4D05C932A8", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleProductDependencyType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleProductDependencyType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleProductDependencyType" } } } } } }, "post": { "tags": [ "ArticleProductDependencyType" ], "summary": "ArticleProductDependencyType: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProductDependencyType-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProductDependencyType_Post_EFCACE220C9E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProductDependencyType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProductDependencyType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProductDependencyType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProductDependencyType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProductDependencyType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProductDependencyType" } } } } } }, "put": { "tags": [ "ArticleProductDependencyType" ], "summary": "ArticleProductDependencyType: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProductDependencyType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProductDependencyType_Put_6A486AC4DA09", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProductDependencyType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProductDependencyType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProductDependencyType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProductDependencyType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProductDependencyType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProductDependencyType" } } } } } } }, "/api/ArticleProductDependencyType/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "ArticleProductDependencyType" ], "summary": "ArticleProductDependencyType: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProductDependencyType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProductDependencyType_GetPageByValue_FA64A649CF5E", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleProductDependencyType/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "ArticleProductDependencyType" ], "summary": "ArticleProductDependencyType: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProductDependencyType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProductDependencyType_GetPageByValue2_43F9FB2490EF", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleProductDependencyType/DeleteByFilter": { "post": { "tags": [ "ArticleProductDependencyType" ], "summary": "ArticleProductDependencyType: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProductDependencyType-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProductDependencyType_DeleteByFilter_D0517444EBB4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/ArticleProductDependencyType/GetAllByValue": { "post": { "tags": [ "ArticleProductDependencyType" ], "summary": "ArticleProductDependencyType: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProductDependencyType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProductDependencyType_GetAllByValue_69CC00E1A88E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleProductDependencyType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleProductDependencyType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleProductDependencyType" } } } } } } }, "/api/ArticleProductDependencyType/GetAllGraphByValue": { "post": { "tags": [ "ArticleProductDependencyType" ], "summary": "ArticleProductDependencyType: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProductDependencyType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProductDependencyType_GetAllGraphByValue_3581D018F9DF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleProductDependencyType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleProductDependencyType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleProductDependencyType" } } } } } } }, "/api/ArticleProductDependencyType/GetByValue": { "post": { "tags": [ "ArticleProductDependencyType" ], "summary": "ArticleProductDependencyType: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProductDependencyType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProductDependencyType_GetByValue_5DF080B44EFF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProductDependencyType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProductDependencyType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProductDependencyType" } } } } } } }, "/api/ArticleProductDependencyType/GetLookup": { "post": { "tags": [ "ArticleProductDependencyType" ], "summary": "ArticleProductDependencyType: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProductDependencyType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProductDependencyType_GetLookup_9B5465BD42A9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ArticleProductDependencyType/GetLookupByValue": { "post": { "tags": [ "ArticleProductDependencyType" ], "summary": "ArticleProductDependencyType: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProductDependencyType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProductDependencyType_GetLookupByValue_1B6420A4A2B6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ArticleProductDependencyType/Page": { "get": { "tags": [ "ArticleProductDependencyType" ], "summary": "ArticleProductDependencyType: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProductDependencyType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProductDependencyType_GetPage_71A654910AF0", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleProductDependencyType/PageAsc": { "get": { "tags": [ "ArticleProductDependencyType" ], "summary": "ArticleProductDependencyType: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProductDependencyType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProductDependencyType_GetPageAsc_8C6636DF0414", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleProductDependencyType/SearchByValue": { "post": { "tags": [ "ArticleProductDependencyType" ], "summary": "ArticleProductDependencyType: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProductDependencyType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProductDependencyType_SearchByValue_82A07349E753", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleProductDependencyType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleProductDependencyType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleProductDependencyType" } } } } } } }, "/api/ArticleProductDependencyType/TryGetByValue": { "post": { "tags": [ "ArticleProductDependencyType" ], "summary": "ArticleProductDependencyType: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProductDependencyType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProductDependencyType_TryGetByValue_1B706DE44206", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProductDependencyType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProductDependencyType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProductDependencyType" } } } } } } }, "/api/ArticleProductDependencyType/UpsertGraph": { "put": { "tags": [ "ArticleProductDependencyType" ], "summary": "ArticleProductDependencyType: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProductDependencyType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProductDependencyType_UpsertGraph_931D9B680A45", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProductDependencyType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProductDependencyType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProductDependencyType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProductDependencyType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProductDependencyType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProductDependencyType" } } } } } } }, "/api/ArticleProductDependencyType/UpsertGraphWithExtraFields": { "put": { "tags": [ "ArticleProductDependencyType" ], "summary": "ArticleProductDependencyType: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProductDependencyType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProductDependencyType_UpsertGraphWithExtraFields_313F4666C4F2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleProductDependencyType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleProductDependencyType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleProductDependencyType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleProductDependencyType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleProductDependencyType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleProductDependencyType" } } } } } } }, "/api/ArticleProductionStepComponent": { "get": { "tags": [ "ArticleProductionStepComponent" ], "summary": "ArticleProductionStepComponent: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProductionStepComponent-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProductionStepComponent_GetAll_55246D9080F3", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleProductionStepComponent" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleProductionStepComponent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleProductionStepComponent" } } } } } }, "post": { "tags": [ "ArticleProductionStepComponent" ], "summary": "ArticleProductionStepComponent: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProductionStepComponent-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProductionStepComponent_Post_DFCAD7F7F69F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProductionStepComponent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProductionStepComponent" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProductionStepComponent" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProductionStepComponent" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProductionStepComponent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProductionStepComponent" } } } } } }, "put": { "tags": [ "ArticleProductionStepComponent" ], "summary": "ArticleProductionStepComponent: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProductionStepComponent-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProductionStepComponent_Put_812278322B19", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProductionStepComponent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProductionStepComponent" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProductionStepComponent" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProductionStepComponent" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProductionStepComponent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProductionStepComponent" } } } } } } }, "/api/ArticleProductionStepComponent/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "ArticleProductionStepComponent" ], "summary": "ArticleProductionStepComponent: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProductionStepComponent-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProductionStepComponent_GetPageByValue_49B1064505C1", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleProductionStepComponent/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "ArticleProductionStepComponent" ], "summary": "ArticleProductionStepComponent: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProductionStepComponent-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProductionStepComponent_GetPageByValue2_B51596033FFA", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleProductionStepComponent/DeleteByFilter": { "post": { "tags": [ "ArticleProductionStepComponent" ], "summary": "ArticleProductionStepComponent: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProductionStepComponent-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProductionStepComponent_DeleteByFilter_03C8148375D4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/ArticleProductionStepComponent/GetAllByValue": { "post": { "tags": [ "ArticleProductionStepComponent" ], "summary": "ArticleProductionStepComponent: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProductionStepComponent-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProductionStepComponent_GetAllByValue_06FD3A7DB51F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleProductionStepComponent" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleProductionStepComponent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleProductionStepComponent" } } } } } } }, "/api/ArticleProductionStepComponent/GetAllGraphByValue": { "post": { "tags": [ "ArticleProductionStepComponent" ], "summary": "ArticleProductionStepComponent: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProductionStepComponent-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProductionStepComponent_GetAllGraphByValue_CE9851CBB8C9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleProductionStepComponent" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleProductionStepComponent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleProductionStepComponent" } } } } } } }, "/api/ArticleProductionStepComponent/GetByValue": { "post": { "tags": [ "ArticleProductionStepComponent" ], "summary": "ArticleProductionStepComponent: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProductionStepComponent-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProductionStepComponent_GetByValue_E27937E0ABE7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProductionStepComponent" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProductionStepComponent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProductionStepComponent" } } } } } } }, "/api/ArticleProductionStepComponent/GetLookup": { "post": { "tags": [ "ArticleProductionStepComponent" ], "summary": "ArticleProductionStepComponent: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProductionStepComponent-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProductionStepComponent_GetLookup_272DD483F1E4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ArticleProductionStepComponent/GetLookupByValue": { "post": { "tags": [ "ArticleProductionStepComponent" ], "summary": "ArticleProductionStepComponent: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProductionStepComponent-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProductionStepComponent_GetLookupByValue_A77318616B84", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ArticleProductionStepComponent/Page": { "get": { "tags": [ "ArticleProductionStepComponent" ], "summary": "ArticleProductionStepComponent: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProductionStepComponent-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProductionStepComponent_GetPage_EF5F6AD267DA", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleProductionStepComponent/PageAsc": { "get": { "tags": [ "ArticleProductionStepComponent" ], "summary": "ArticleProductionStepComponent: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProductionStepComponent-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProductionStepComponent_GetPageAsc_0CD98DF12B3F", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleProductionStepComponent/SearchByValue": { "post": { "tags": [ "ArticleProductionStepComponent" ], "summary": "ArticleProductionStepComponent: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProductionStepComponent-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProductionStepComponent_SearchByValue_5B440D2C3BA8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleProductionStepComponent" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleProductionStepComponent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleProductionStepComponent" } } } } } } }, "/api/ArticleProductionStepComponent/TryGetByValue": { "post": { "tags": [ "ArticleProductionStepComponent" ], "summary": "ArticleProductionStepComponent: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProductionStepComponent-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProductionStepComponent_TryGetByValue_1601B8D19C92", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProductionStepComponent" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProductionStepComponent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProductionStepComponent" } } } } } } }, "/api/ArticleProductionStepComponent/UpsertGraph": { "put": { "tags": [ "ArticleProductionStepComponent" ], "summary": "ArticleProductionStepComponent: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProductionStepComponent-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProductionStepComponent_UpsertGraph_799567E76C19", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProductionStepComponent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProductionStepComponent" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProductionStepComponent" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProductionStepComponent" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProductionStepComponent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProductionStepComponent" } } } } } } }, "/api/ArticleProductionStepComponent/UpsertGraphWithExtraFields": { "put": { "tags": [ "ArticleProductionStepComponent" ], "summary": "ArticleProductionStepComponent: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProductionStepComponent-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProductionStepComponent_UpsertGraphWithExtraFields_E80A63459E2C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleProductionStepComponent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleProductionStepComponent" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleProductionStepComponent" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleProductionStepComponent" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleProductionStepComponent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleProductionStepComponent" } } } } } } }, "/api/ArticleProductionStepComponentType": { "get": { "tags": [ "ArticleProductionStepComponentType" ], "summary": "ArticleProductionStepComponentType: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProductionStepComponentType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProductionStepComponentType_GetAll_38E9DA3DFFF7", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleProductionStepComponentType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleProductionStepComponentType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleProductionStepComponentType" } } } } } }, "post": { "tags": [ "ArticleProductionStepComponentType" ], "summary": "ArticleProductionStepComponentType: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProductionStepComponentType-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProductionStepComponentType_Post_8BE40D578F59", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProductionStepComponentType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProductionStepComponentType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProductionStepComponentType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProductionStepComponentType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProductionStepComponentType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProductionStepComponentType" } } } } } }, "put": { "tags": [ "ArticleProductionStepComponentType" ], "summary": "ArticleProductionStepComponentType: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProductionStepComponentType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProductionStepComponentType_Put_B9E7F8EB23A8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProductionStepComponentType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProductionStepComponentType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProductionStepComponentType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProductionStepComponentType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProductionStepComponentType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProductionStepComponentType" } } } } } } }, "/api/ArticleProductionStepComponentType/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "ArticleProductionStepComponentType" ], "summary": "ArticleProductionStepComponentType: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProductionStepComponentType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProductionStepComponentType_GetPageByValue_262DE9C9292C", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleProductionStepComponentType/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "ArticleProductionStepComponentType" ], "summary": "ArticleProductionStepComponentType: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProductionStepComponentType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProductionStepComponentType_GetPageByValue2_6F990D734FC5", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleProductionStepComponentType/DeleteByFilter": { "post": { "tags": [ "ArticleProductionStepComponentType" ], "summary": "ArticleProductionStepComponentType: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProductionStepComponentType-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProductionStepComponentType_DeleteByFilter_F03AE2888B25", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/ArticleProductionStepComponentType/GetAllByValue": { "post": { "tags": [ "ArticleProductionStepComponentType" ], "summary": "ArticleProductionStepComponentType: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProductionStepComponentType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProductionStepComponentType_GetAllByValue_70C47D0A9CFC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleProductionStepComponentType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleProductionStepComponentType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleProductionStepComponentType" } } } } } } }, "/api/ArticleProductionStepComponentType/GetAllGraphByValue": { "post": { "tags": [ "ArticleProductionStepComponentType" ], "summary": "ArticleProductionStepComponentType: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProductionStepComponentType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProductionStepComponentType_GetAllGraphByValue_469B1B951E38", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleProductionStepComponentType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleProductionStepComponentType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleProductionStepComponentType" } } } } } } }, "/api/ArticleProductionStepComponentType/GetByValue": { "post": { "tags": [ "ArticleProductionStepComponentType" ], "summary": "ArticleProductionStepComponentType: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProductionStepComponentType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProductionStepComponentType_GetByValue_A1C35EA39C10", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProductionStepComponentType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProductionStepComponentType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProductionStepComponentType" } } } } } } }, "/api/ArticleProductionStepComponentType/GetLookup": { "post": { "tags": [ "ArticleProductionStepComponentType" ], "summary": "ArticleProductionStepComponentType: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProductionStepComponentType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProductionStepComponentType_GetLookup_11D09DA838A6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ArticleProductionStepComponentType/GetLookupByValue": { "post": { "tags": [ "ArticleProductionStepComponentType" ], "summary": "ArticleProductionStepComponentType: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProductionStepComponentType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProductionStepComponentType_GetLookupByValue_3C9D200EDA9D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ArticleProductionStepComponentType/Page": { "get": { "tags": [ "ArticleProductionStepComponentType" ], "summary": "ArticleProductionStepComponentType: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProductionStepComponentType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProductionStepComponentType_GetPage_F717E54B34D1", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleProductionStepComponentType/PageAsc": { "get": { "tags": [ "ArticleProductionStepComponentType" ], "summary": "ArticleProductionStepComponentType: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProductionStepComponentType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProductionStepComponentType_GetPageAsc_569A665C29A5", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleProductionStepComponentType/SearchByValue": { "post": { "tags": [ "ArticleProductionStepComponentType" ], "summary": "ArticleProductionStepComponentType: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProductionStepComponentType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProductionStepComponentType_SearchByValue_78BC62132CAC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleProductionStepComponentType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleProductionStepComponentType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleProductionStepComponentType" } } } } } } }, "/api/ArticleProductionStepComponentType/TryGetByValue": { "post": { "tags": [ "ArticleProductionStepComponentType" ], "summary": "ArticleProductionStepComponentType: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProductionStepComponentType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProductionStepComponentType_TryGetByValue_A6EA56E5E582", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProductionStepComponentType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProductionStepComponentType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProductionStepComponentType" } } } } } } }, "/api/ArticleProductionStepComponentType/UpsertGraph": { "put": { "tags": [ "ArticleProductionStepComponentType" ], "summary": "ArticleProductionStepComponentType: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProductionStepComponentType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProductionStepComponentType_UpsertGraph_0399682E7D3E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProductionStepComponentType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProductionStepComponentType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProductionStepComponentType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProductionStepComponentType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProductionStepComponentType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProductionStepComponentType" } } } } } } }, "/api/ArticleProductionStepComponentType/UpsertGraphWithExtraFields": { "put": { "tags": [ "ArticleProductionStepComponentType" ], "summary": "ArticleProductionStepComponentType: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProductionStepComponentType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProductionStepComponentType_UpsertGraphWithExtraFields_3ECBAD03A5C1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleProductionStepComponentType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleProductionStepComponentType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleProductionStepComponentType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleProductionStepComponentType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleProductionStepComponentType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleProductionStepComponentType" } } } } } } }, "/api/ArticleProductionStepResource": { "get": { "tags": [ "ArticleProductionStepResource" ], "summary": "ArticleProductionStepResource: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProductionStepResource-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProductionStepResource_GetAll_50DB982409BB", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleProductionStepResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleProductionStepResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleProductionStepResource" } } } } } }, "post": { "tags": [ "ArticleProductionStepResource" ], "summary": "ArticleProductionStepResource: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProductionStepResource-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProductionStepResource_Post_7F4AA993F420", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProductionStepResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProductionStepResource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProductionStepResource" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProductionStepResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProductionStepResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProductionStepResource" } } } } } }, "put": { "tags": [ "ArticleProductionStepResource" ], "summary": "ArticleProductionStepResource: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProductionStepResource-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProductionStepResource_Put_7B0E1E577AAE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProductionStepResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProductionStepResource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProductionStepResource" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProductionStepResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProductionStepResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProductionStepResource" } } } } } } }, "/api/ArticleProductionStepResource/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "ArticleProductionStepResource" ], "summary": "ArticleProductionStepResource: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProductionStepResource-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProductionStepResource_GetPageByValue_9724EAC1059C", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleProductionStepResource/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "ArticleProductionStepResource" ], "summary": "ArticleProductionStepResource: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProductionStepResource-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProductionStepResource_GetPageByValue2_33188B0A6F0A", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleProductionStepResource/DeleteByFilter": { "post": { "tags": [ "ArticleProductionStepResource" ], "summary": "ArticleProductionStepResource: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProductionStepResource-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProductionStepResource_DeleteByFilter_4787FDBAB462", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/ArticleProductionStepResource/GetAllByValue": { "post": { "tags": [ "ArticleProductionStepResource" ], "summary": "ArticleProductionStepResource: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProductionStepResource-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProductionStepResource_GetAllByValue_5177EB036BB0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleProductionStepResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleProductionStepResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleProductionStepResource" } } } } } } }, "/api/ArticleProductionStepResource/GetAllGraphByValue": { "post": { "tags": [ "ArticleProductionStepResource" ], "summary": "ArticleProductionStepResource: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProductionStepResource-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProductionStepResource_GetAllGraphByValue_B41A8B28CD4C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleProductionStepResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleProductionStepResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleProductionStepResource" } } } } } } }, "/api/ArticleProductionStepResource/GetByValue": { "post": { "tags": [ "ArticleProductionStepResource" ], "summary": "ArticleProductionStepResource: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProductionStepResource-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProductionStepResource_GetByValue_9AD9417B657E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProductionStepResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProductionStepResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProductionStepResource" } } } } } } }, "/api/ArticleProductionStepResource/GetLookup": { "post": { "tags": [ "ArticleProductionStepResource" ], "summary": "ArticleProductionStepResource: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProductionStepResource-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProductionStepResource_GetLookup_DFB455C58A42", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ArticleProductionStepResource/GetLookupByValue": { "post": { "tags": [ "ArticleProductionStepResource" ], "summary": "ArticleProductionStepResource: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProductionStepResource-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProductionStepResource_GetLookupByValue_41F45A135619", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ArticleProductionStepResource/Page": { "get": { "tags": [ "ArticleProductionStepResource" ], "summary": "ArticleProductionStepResource: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProductionStepResource-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProductionStepResource_GetPage_DB76A8B4EADA", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleProductionStepResource/PageAsc": { "get": { "tags": [ "ArticleProductionStepResource" ], "summary": "ArticleProductionStepResource: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProductionStepResource-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProductionStepResource_GetPageAsc_EAC224FD37E2", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleProductionStepResource/SearchByValue": { "post": { "tags": [ "ArticleProductionStepResource" ], "summary": "ArticleProductionStepResource: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProductionStepResource-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProductionStepResource_SearchByValue_4B7B64BA8EAF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleProductionStepResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleProductionStepResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleProductionStepResource" } } } } } } }, "/api/ArticleProductionStepResource/TryGetByValue": { "post": { "tags": [ "ArticleProductionStepResource" ], "summary": "ArticleProductionStepResource: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProductionStepResource-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProductionStepResource_TryGetByValue_356F22875F1E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProductionStepResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProductionStepResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProductionStepResource" } } } } } } }, "/api/ArticleProductionStepResource/UpsertGraph": { "put": { "tags": [ "ArticleProductionStepResource" ], "summary": "ArticleProductionStepResource: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProductionStepResource-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProductionStepResource_UpsertGraph_7DF06A2B8585", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProductionStepResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProductionStepResource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProductionStepResource" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProductionStepResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProductionStepResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProductionStepResource" } } } } } } }, "/api/ArticleProductionStepResource/UpsertGraphWithExtraFields": { "put": { "tags": [ "ArticleProductionStepResource" ], "summary": "ArticleProductionStepResource: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleProductionStepResource-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleProductionStepResource_UpsertGraphWithExtraFields_783B46D08C9F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleProductionStepResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleProductionStepResource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleProductionStepResource" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleProductionStepResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleProductionStepResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleProductionStepResource" } } } } } } }, "/api/ArticleQuantity": { "get": { "tags": [ "ArticleQuantity" ], "summary": "ArticleQuantity: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleQuantity-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleQuantity_GetAll_8189023B1B9D", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleQuantity" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleQuantity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleQuantity" } } } } } }, "post": { "tags": [ "ArticleQuantity" ], "summary": "ArticleQuantity: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleQuantity-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleQuantity_Post_7F94C416003F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleQuantity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleQuantity" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleQuantity" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleQuantity" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleQuantity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleQuantity" } } } } } }, "put": { "tags": [ "ArticleQuantity" ], "summary": "ArticleQuantity: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleQuantity-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleQuantity_Put_B08E917FAB3C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleQuantity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleQuantity" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleQuantity" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleQuantity" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleQuantity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleQuantity" } } } } } } }, "/api/ArticleQuantity/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "ArticleQuantity" ], "summary": "ArticleQuantity: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleQuantity-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleQuantity_GetPageByValue_0CDBA6B19890", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleQuantity/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "ArticleQuantity" ], "summary": "ArticleQuantity: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleQuantity-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleQuantity_GetPageByValue2_01F62627A2BE", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleQuantity/DeleteByFilter": { "post": { "tags": [ "ArticleQuantity" ], "summary": "ArticleQuantity: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleQuantity-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleQuantity_DeleteByFilter_233440BA40AD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/ArticleQuantity/GetAllByValue": { "post": { "tags": [ "ArticleQuantity" ], "summary": "ArticleQuantity: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleQuantity-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleQuantity_GetAllByValue_4D2B03444AED", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleQuantity" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleQuantity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleQuantity" } } } } } } }, "/api/ArticleQuantity/GetAllGraphByValue": { "post": { "tags": [ "ArticleQuantity" ], "summary": "ArticleQuantity: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleQuantity-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleQuantity_GetAllGraphByValue_B4ABFA44149E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleQuantity" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleQuantity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleQuantity" } } } } } } }, "/api/ArticleQuantity/GetByValue": { "post": { "tags": [ "ArticleQuantity" ], "summary": "ArticleQuantity: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleQuantity-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleQuantity_GetByValue_2A6174496F65", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleQuantity" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleQuantity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleQuantity" } } } } } } }, "/api/ArticleQuantity/GetLookup": { "post": { "tags": [ "ArticleQuantity" ], "summary": "ArticleQuantity: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleQuantity-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleQuantity_GetLookup_4E3D009119C4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ArticleQuantity/GetLookupByValue": { "post": { "tags": [ "ArticleQuantity" ], "summary": "ArticleQuantity: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleQuantity-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleQuantity_GetLookupByValue_7E30794D51CE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ArticleQuantity/Page": { "get": { "tags": [ "ArticleQuantity" ], "summary": "ArticleQuantity: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleQuantity-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleQuantity_GetPage_73AA36903A5F", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleQuantity/PageAsc": { "get": { "tags": [ "ArticleQuantity" ], "summary": "ArticleQuantity: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleQuantity-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleQuantity_GetPageAsc_C5EE1731A319", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleQuantity/SearchByValue": { "post": { "tags": [ "ArticleQuantity" ], "summary": "ArticleQuantity: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleQuantity-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleQuantity_SearchByValue_704EDAE7F20A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleQuantity" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleQuantity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleQuantity" } } } } } } }, "/api/ArticleQuantity/TryGetByValue": { "post": { "tags": [ "ArticleQuantity" ], "summary": "ArticleQuantity: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleQuantity-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleQuantity_TryGetByValue_CEF5B207907B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleQuantity" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleQuantity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleQuantity" } } } } } } }, "/api/ArticleQuantity/UpsertGraph": { "put": { "tags": [ "ArticleQuantity" ], "summary": "ArticleQuantity: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleQuantity-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleQuantity_UpsertGraph_328BDE513DDB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleQuantity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleQuantity" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleQuantity" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleQuantity" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleQuantity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleQuantity" } } } } } } }, "/api/ArticleQuantity/UpsertGraphWithExtraFields": { "put": { "tags": [ "ArticleQuantity" ], "summary": "ArticleQuantity: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleQuantity-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleQuantity_UpsertGraphWithExtraFields_AD6E5F6315CA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleQuantity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleQuantity" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleQuantity" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleQuantity" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleQuantity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleQuantity" } } } } } } }, "/api/ArticleSalesPriceList": { "get": { "tags": [ "ArticleSalesPriceList" ], "summary": "ArticleSalesPriceList: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleSalesPriceList-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleSalesPriceList_GetAll_94629F0EBC03", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleSalesPriceList" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleSalesPriceList" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleSalesPriceList" } } } } } }, "post": { "tags": [ "ArticleSalesPriceList" ], "summary": "ArticleSalesPriceList: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleSalesPriceList-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleSalesPriceList_Post_4D7121BD465B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleSalesPriceList" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleSalesPriceList" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleSalesPriceList" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleSalesPriceList" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleSalesPriceList" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleSalesPriceList" } } } } } }, "put": { "tags": [ "ArticleSalesPriceList" ], "summary": "ArticleSalesPriceList: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleSalesPriceList-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleSalesPriceList_Put_480B61A6E118", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleSalesPriceList" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleSalesPriceList" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleSalesPriceList" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleSalesPriceList" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleSalesPriceList" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleSalesPriceList" } } } } } } }, "/api/ArticleSalesPriceList/{ArticleId}/PageFromViewByArticleId": { "get": { "tags": [ "ArticleSalesPriceList" ], "summary": "ArticleSalesPriceList: GetPageFromViewByArticleId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleSalesPriceList-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleSalesPriceList_GetPageFromViewByArticleId_EC24FF0A46D5", "parameters": [ { "name": "ArticleId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleSalesPriceList/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "ArticleSalesPriceList" ], "summary": "ArticleSalesPriceList: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleSalesPriceList-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleSalesPriceList_GetPageByValue_AA3DF2058886", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleSalesPriceList/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "ArticleSalesPriceList" ], "summary": "ArticleSalesPriceList: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleSalesPriceList-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleSalesPriceList_GetPageByValue2_5068EF990C45", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleSalesPriceList/DeleteByFilter": { "post": { "tags": [ "ArticleSalesPriceList" ], "summary": "ArticleSalesPriceList: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleSalesPriceList-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleSalesPriceList_DeleteByFilter_76CE179F156C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/ArticleSalesPriceList/GetAllByValue": { "post": { "tags": [ "ArticleSalesPriceList" ], "summary": "ArticleSalesPriceList: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleSalesPriceList-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleSalesPriceList_GetAllByValue_B0088BC9687B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleSalesPriceList" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleSalesPriceList" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleSalesPriceList" } } } } } } }, "/api/ArticleSalesPriceList/GetAllGraphByValue": { "post": { "tags": [ "ArticleSalesPriceList" ], "summary": "ArticleSalesPriceList: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleSalesPriceList-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleSalesPriceList_GetAllGraphByValue_8B293FEFEA46", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleSalesPriceList" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleSalesPriceList" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleSalesPriceList" } } } } } } }, "/api/ArticleSalesPriceList/GetByValue": { "post": { "tags": [ "ArticleSalesPriceList" ], "summary": "ArticleSalesPriceList: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleSalesPriceList-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleSalesPriceList_GetByValue_4CA17AE0436F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleSalesPriceList" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleSalesPriceList" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleSalesPriceList" } } } } } } }, "/api/ArticleSalesPriceList/GetLookup": { "post": { "tags": [ "ArticleSalesPriceList" ], "summary": "ArticleSalesPriceList: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleSalesPriceList-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleSalesPriceList_GetLookup_A7FD68DE412A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ArticleSalesPriceList/GetLookupByValue": { "post": { "tags": [ "ArticleSalesPriceList" ], "summary": "ArticleSalesPriceList: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleSalesPriceList-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleSalesPriceList_GetLookupByValue_0FAA037F9797", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ArticleSalesPriceList/Page": { "get": { "tags": [ "ArticleSalesPriceList" ], "summary": "ArticleSalesPriceList: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleSalesPriceList-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleSalesPriceList_GetPage_5275AAB74714", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleSalesPriceList/PageAsc": { "get": { "tags": [ "ArticleSalesPriceList" ], "summary": "ArticleSalesPriceList: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleSalesPriceList-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleSalesPriceList_GetPageAsc_1F15CBE053A9", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleSalesPriceList/SearchByValue": { "post": { "tags": [ "ArticleSalesPriceList" ], "summary": "ArticleSalesPriceList: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleSalesPriceList-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleSalesPriceList_SearchByValue_76CC5CD732A6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleSalesPriceList" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleSalesPriceList" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleSalesPriceList" } } } } } } }, "/api/ArticleSalesPriceList/TryGetByValue": { "post": { "tags": [ "ArticleSalesPriceList" ], "summary": "ArticleSalesPriceList: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleSalesPriceList-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleSalesPriceList_TryGetByValue_485A0BF3DB0B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleSalesPriceList" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleSalesPriceList" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleSalesPriceList" } } } } } } }, "/api/ArticleSalesPriceList/UpsertGraph": { "put": { "tags": [ "ArticleSalesPriceList" ], "summary": "ArticleSalesPriceList: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleSalesPriceList-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleSalesPriceList_UpsertGraph_8188A2FC0F97", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleSalesPriceList" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleSalesPriceList" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleSalesPriceList" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleSalesPriceList" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleSalesPriceList" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleSalesPriceList" } } } } } } }, "/api/ArticleSalesPriceList/UpsertGraphWithExtraFields": { "put": { "tags": [ "ArticleSalesPriceList" ], "summary": "ArticleSalesPriceList: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleSalesPriceList-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleSalesPriceList_UpsertGraphWithExtraFields_59201D7F4BA4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleSalesPriceList" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleSalesPriceList" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleSalesPriceList" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleSalesPriceList" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleSalesPriceList" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleSalesPriceList" } } } } } } }, "/api/ArticleSalesPriceListName": { "get": { "tags": [ "ArticleSalesPriceListName" ], "summary": "ArticleSalesPriceListName: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleSalesPriceListName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleSalesPriceListName_GetAll_4E83C2BBB291", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleSalesPriceListName" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleSalesPriceListName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleSalesPriceListName" } } } } } }, "post": { "tags": [ "ArticleSalesPriceListName" ], "summary": "ArticleSalesPriceListName: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleSalesPriceListName-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleSalesPriceListName_Post_DBE024BFC8BD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleSalesPriceListName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleSalesPriceListName" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleSalesPriceListName" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleSalesPriceListName" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleSalesPriceListName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleSalesPriceListName" } } } } } }, "put": { "tags": [ "ArticleSalesPriceListName" ], "summary": "ArticleSalesPriceListName: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleSalesPriceListName-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleSalesPriceListName_Put_CD63234A39CA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleSalesPriceListName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleSalesPriceListName" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleSalesPriceListName" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleSalesPriceListName" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleSalesPriceListName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleSalesPriceListName" } } } } } } }, "/api/ArticleSalesPriceListName/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "ArticleSalesPriceListName" ], "summary": "ArticleSalesPriceListName: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleSalesPriceListName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleSalesPriceListName_GetPageByValue_8D212BA771FD", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleSalesPriceListName/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "ArticleSalesPriceListName" ], "summary": "ArticleSalesPriceListName: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleSalesPriceListName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleSalesPriceListName_GetPageByValue2_F25C7D0C82B0", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleSalesPriceListName/DeleteByFilter": { "post": { "tags": [ "ArticleSalesPriceListName" ], "summary": "ArticleSalesPriceListName: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleSalesPriceListName-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleSalesPriceListName_DeleteByFilter_1C914048BCF2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/ArticleSalesPriceListName/GetAllByValue": { "post": { "tags": [ "ArticleSalesPriceListName" ], "summary": "ArticleSalesPriceListName: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleSalesPriceListName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleSalesPriceListName_GetAllByValue_7ACEFB9046C7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleSalesPriceListName" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleSalesPriceListName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleSalesPriceListName" } } } } } } }, "/api/ArticleSalesPriceListName/GetAllGraphByValue": { "post": { "tags": [ "ArticleSalesPriceListName" ], "summary": "ArticleSalesPriceListName: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleSalesPriceListName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleSalesPriceListName_GetAllGraphByValue_422C6E45B005", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleSalesPriceListName" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleSalesPriceListName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleSalesPriceListName" } } } } } } }, "/api/ArticleSalesPriceListName/GetByValue": { "post": { "tags": [ "ArticleSalesPriceListName" ], "summary": "ArticleSalesPriceListName: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleSalesPriceListName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleSalesPriceListName_GetByValue_5E0A31C0C92B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleSalesPriceListName" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleSalesPriceListName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleSalesPriceListName" } } } } } } }, "/api/ArticleSalesPriceListName/GetLookup": { "post": { "tags": [ "ArticleSalesPriceListName" ], "summary": "ArticleSalesPriceListName: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleSalesPriceListName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleSalesPriceListName_GetLookup_61C8A597463D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ArticleSalesPriceListName/GetLookupByValue": { "post": { "tags": [ "ArticleSalesPriceListName" ], "summary": "ArticleSalesPriceListName: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleSalesPriceListName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleSalesPriceListName_GetLookupByValue_84FDC9B23851", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ArticleSalesPriceListName/Page": { "get": { "tags": [ "ArticleSalesPriceListName" ], "summary": "ArticleSalesPriceListName: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleSalesPriceListName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleSalesPriceListName_GetPage_78D7AF76F6CC", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleSalesPriceListName/PageAsc": { "get": { "tags": [ "ArticleSalesPriceListName" ], "summary": "ArticleSalesPriceListName: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleSalesPriceListName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleSalesPriceListName_GetPageAsc_53E30D21CA55", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleSalesPriceListName/SearchByValue": { "post": { "tags": [ "ArticleSalesPriceListName" ], "summary": "ArticleSalesPriceListName: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleSalesPriceListName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleSalesPriceListName_SearchByValue_F331C1D55160", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleSalesPriceListName" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleSalesPriceListName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleSalesPriceListName" } } } } } } }, "/api/ArticleSalesPriceListName/TryGetByValue": { "post": { "tags": [ "ArticleSalesPriceListName" ], "summary": "ArticleSalesPriceListName: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleSalesPriceListName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleSalesPriceListName_TryGetByValue_2B173B542370", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleSalesPriceListName" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleSalesPriceListName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleSalesPriceListName" } } } } } } }, "/api/ArticleSalesPriceListName/UpsertGraph": { "put": { "tags": [ "ArticleSalesPriceListName" ], "summary": "ArticleSalesPriceListName: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleSalesPriceListName-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleSalesPriceListName_UpsertGraph_727133E2AC43", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleSalesPriceListName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleSalesPriceListName" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleSalesPriceListName" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleSalesPriceListName" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleSalesPriceListName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleSalesPriceListName" } } } } } } }, "/api/ArticleSalesPriceListName/UpsertGraphWithExtraFields": { "put": { "tags": [ "ArticleSalesPriceListName" ], "summary": "ArticleSalesPriceListName: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleSalesPriceListName-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleSalesPriceListName_UpsertGraphWithExtraFields_854775410413", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleSalesPriceListName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleSalesPriceListName" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleSalesPriceListName" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleSalesPriceListName" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleSalesPriceListName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleSalesPriceListName" } } } } } } }, "/api/ArticleSet": { "get": { "tags": [ "ArticleSet" ], "summary": "ArticleSet: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleSet-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleSet_GetAll_230E03A20299", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleSet" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleSet" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleSet" } } } } } }, "post": { "tags": [ "ArticleSet" ], "summary": "ArticleSet: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleSet-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleSet_Post_04D20FF1822C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleSet" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleSet" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleSet" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleSet" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleSet" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleSet" } } } } } }, "put": { "tags": [ "ArticleSet" ], "summary": "ArticleSet: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleSet-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleSet_Put_4B57B81A15D3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleSet" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleSet" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleSet" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleSet" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleSet" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleSet" } } } } } } }, "/api/ArticleSet/{ArticleId}/PageFromViewByArticleId": { "get": { "tags": [ "ArticleSet" ], "summary": "ArticleSet: GetPageFromViewByArticleId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleSet-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleSet_GetPageFromViewByArticleId_338533C7D048", "parameters": [ { "name": "ArticleId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleSet/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "ArticleSet" ], "summary": "ArticleSet: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleSet-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleSet_GetPageByValue_B46934E08FEF", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleSet/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "ArticleSet" ], "summary": "ArticleSet: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleSet-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleSet_GetPageByValue2_FF153B30B2B7", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleSet/DeleteByFilter": { "post": { "tags": [ "ArticleSet" ], "summary": "ArticleSet: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleSet-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleSet_DeleteByFilter_A82074896F01", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/ArticleSet/GetAllByValue": { "post": { "tags": [ "ArticleSet" ], "summary": "ArticleSet: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleSet-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleSet_GetAllByValue_4A2CEB23835E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleSet" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleSet" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleSet" } } } } } } }, "/api/ArticleSet/GetAllGraphByValue": { "post": { "tags": [ "ArticleSet" ], "summary": "ArticleSet: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleSet-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleSet_GetAllGraphByValue_4B00ADF268FD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleSet" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleSet" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleSet" } } } } } } }, "/api/ArticleSet/GetByValue": { "post": { "tags": [ "ArticleSet" ], "summary": "ArticleSet: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleSet-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleSet_GetByValue_FB10AF37861F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleSet" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleSet" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleSet" } } } } } } }, "/api/ArticleSet/GetLookup": { "post": { "tags": [ "ArticleSet" ], "summary": "ArticleSet: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleSet-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleSet_GetLookup_F317189F7847", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ArticleSet/GetLookupByValue": { "post": { "tags": [ "ArticleSet" ], "summary": "ArticleSet: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleSet-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleSet_GetLookupByValue_31A53571723F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ArticleSet/Page": { "get": { "tags": [ "ArticleSet" ], "summary": "ArticleSet: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleSet-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleSet_GetPage_2FE887EA924F", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleSet/PageAsc": { "get": { "tags": [ "ArticleSet" ], "summary": "ArticleSet: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleSet-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleSet_GetPageAsc_C6D06385AC6F", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleSet/SearchByValue": { "post": { "tags": [ "ArticleSet" ], "summary": "ArticleSet: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleSet-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleSet_SearchByValue_6CF8161BB062", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleSet" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleSet" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleSet" } } } } } } }, "/api/ArticleSet/TryGetByValue": { "post": { "tags": [ "ArticleSet" ], "summary": "ArticleSet: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleSet-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleSet_TryGetByValue_6040C18091E1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleSet" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleSet" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleSet" } } } } } } }, "/api/ArticleSet/UpsertGraph": { "put": { "tags": [ "ArticleSet" ], "summary": "ArticleSet: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleSet-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleSet_UpsertGraph_5025489C33FB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleSet" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleSet" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleSet" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleSet" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleSet" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleSet" } } } } } } }, "/api/ArticleSet/UpsertGraphWithExtraFields": { "put": { "tags": [ "ArticleSet" ], "summary": "ArticleSet: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleSet-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleSet_UpsertGraphWithExtraFields_E9546E90C9A5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleSet" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleSet" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleSet" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleSet" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleSet" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleSet" } } } } } } }, "/api/ArticleTemplate": { "get": { "tags": [ "ArticleTemplate" ], "summary": "ArticleTemplate: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleTemplate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleTemplate_GetAll_CF5E610564C9", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleTemplate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleTemplate" } } } } } }, "post": { "tags": [ "ArticleTemplate" ], "summary": "ArticleTemplate: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleTemplate-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleTemplate_Post_A634C10D1069", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleTemplate" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleTemplate" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleTemplate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleTemplate" } } } } } }, "put": { "tags": [ "ArticleTemplate" ], "summary": "ArticleTemplate: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleTemplate-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleTemplate_Put_F854CD1E44AE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleTemplate" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleTemplate" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleTemplate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleTemplate" } } } } } } }, "/api/ArticleTemplate/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "ArticleTemplate" ], "summary": "ArticleTemplate: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleTemplate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleTemplate_GetPageByValue_E326D2C6C74A", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleTemplate/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "ArticleTemplate" ], "summary": "ArticleTemplate: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleTemplate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleTemplate_GetPageByValue2_57D4B9573373", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleTemplate/DeleteByFilter": { "post": { "tags": [ "ArticleTemplate" ], "summary": "ArticleTemplate: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleTemplate-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleTemplate_DeleteByFilter_1F202910E158", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/ArticleTemplate/GetAllByValue": { "post": { "tags": [ "ArticleTemplate" ], "summary": "ArticleTemplate: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleTemplate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleTemplate_GetAllByValue_4D19751C2BCA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleTemplate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleTemplate" } } } } } } }, "/api/ArticleTemplate/GetAllGraphByValue": { "post": { "tags": [ "ArticleTemplate" ], "summary": "ArticleTemplate: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleTemplate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleTemplate_GetAllGraphByValue_93937C64CE40", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleTemplate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleTemplate" } } } } } } }, "/api/ArticleTemplate/GetByValue": { "post": { "tags": [ "ArticleTemplate" ], "summary": "ArticleTemplate: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleTemplate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleTemplate_GetByValue_55C4617C54D4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleTemplate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleTemplate" } } } } } } }, "/api/ArticleTemplate/GetLookup": { "post": { "tags": [ "ArticleTemplate" ], "summary": "ArticleTemplate: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleTemplate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleTemplate_GetLookup_7754BE8634EE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ArticleTemplate/GetLookupByValue": { "post": { "tags": [ "ArticleTemplate" ], "summary": "ArticleTemplate: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleTemplate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleTemplate_GetLookupByValue_B600275B5F71", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ArticleTemplate/Page": { "get": { "tags": [ "ArticleTemplate" ], "summary": "ArticleTemplate: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleTemplate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleTemplate_GetPage_AD94B6C3E0A9", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleTemplate/PageAsc": { "get": { "tags": [ "ArticleTemplate" ], "summary": "ArticleTemplate: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleTemplate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleTemplate_GetPageAsc_24751F8BAA6D", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleTemplate/SearchByValue": { "post": { "tags": [ "ArticleTemplate" ], "summary": "ArticleTemplate: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleTemplate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleTemplate_SearchByValue_E46E06451E56", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleTemplate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleTemplate" } } } } } } }, "/api/ArticleTemplate/TryGetByValue": { "post": { "tags": [ "ArticleTemplate" ], "summary": "ArticleTemplate: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleTemplate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleTemplate_TryGetByValue_9686C727964C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleTemplate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleTemplate" } } } } } } }, "/api/ArticleTemplate/UpsertGraph": { "put": { "tags": [ "ArticleTemplate" ], "summary": "ArticleTemplate: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleTemplate-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleTemplate_UpsertGraph_73AF3DEB6F21", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleTemplate" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleTemplate" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleTemplate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleTemplate" } } } } } } }, "/api/ArticleTemplate/UpsertGraphWithExtraFields": { "put": { "tags": [ "ArticleTemplate" ], "summary": "ArticleTemplate: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleTemplate-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleTemplate_UpsertGraphWithExtraFields_A15F47DD34E8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleTemplate" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleTemplate" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleTemplate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleTemplate" } } } } } } }, "/api/ArticleType": { "get": { "tags": [ "ArticleType" ], "summary": "ArticleType: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleType_GetAll_C73FC62E8019", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleType" } } } } } }, "post": { "tags": [ "ArticleType" ], "summary": "ArticleType: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleType-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleType_Post_F59ABAAE7BB6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleType" } } } } } }, "put": { "tags": [ "ArticleType" ], "summary": "ArticleType: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleType_Put_342270AAB032", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleType" } } } } } } }, "/api/ArticleType/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "ArticleType" ], "summary": "ArticleType: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleType_GetPageByValue_BB3329C8A801", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleType/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "ArticleType" ], "summary": "ArticleType: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleType_GetPageByValue2_C87A8974C258", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleType/DeleteByFilter": { "post": { "tags": [ "ArticleType" ], "summary": "ArticleType: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleType-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleType_DeleteByFilter_606AD5B11F8F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/ArticleType/GetAllByValue": { "post": { "tags": [ "ArticleType" ], "summary": "ArticleType: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleType_GetAllByValue_78C849A0FF32", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleType" } } } } } } }, "/api/ArticleType/GetAllGraphByValue": { "post": { "tags": [ "ArticleType" ], "summary": "ArticleType: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleType_GetAllGraphByValue_C609E41BA9F3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleType" } } } } } } }, "/api/ArticleType/GetByValue": { "post": { "tags": [ "ArticleType" ], "summary": "ArticleType: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleType_GetByValue_1C44C4F78F54", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleType" } } } } } } }, "/api/ArticleType/GetLookup": { "post": { "tags": [ "ArticleType" ], "summary": "ArticleType: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleType_GetLookup_AF39F2BECBC5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ArticleType/GetLookupByValue": { "post": { "tags": [ "ArticleType" ], "summary": "ArticleType: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleType_GetLookupByValue_D4E510FE4A76", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ArticleType/Page": { "get": { "tags": [ "ArticleType" ], "summary": "ArticleType: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleType_GetPage_0AB76A58C055", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleType/PageAsc": { "get": { "tags": [ "ArticleType" ], "summary": "ArticleType: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleType_GetPageAsc_5265EA0ECF81", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleType/SearchByValue": { "post": { "tags": [ "ArticleType" ], "summary": "ArticleType: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleType_SearchByValue_297235C1C7DF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleType" } } } } } } }, "/api/ArticleType/TryGetByValue": { "post": { "tags": [ "ArticleType" ], "summary": "ArticleType: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleType_TryGetByValue_017BDA391D35", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleType" } } } } } } }, "/api/ArticleType/UpsertGraph": { "put": { "tags": [ "ArticleType" ], "summary": "ArticleType: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleType_UpsertGraph_03C59EFDB11A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleType" } } } } } } }, "/api/ArticleType/UpsertGraphWithExtraFields": { "put": { "tags": [ "ArticleType" ], "summary": "ArticleType: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleType_UpsertGraphWithExtraFields_433C52745476", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleType" } } } } } } }, "/api/ArticleUoM": { "get": { "tags": [ "ArticleUoM" ], "summary": "ArticleUoM: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleUoM-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleUoM_GetAll_64D9554502D9", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleUoM" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleUoM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleUoM" } } } } } }, "post": { "tags": [ "ArticleUoM" ], "summary": "ArticleUoM: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleUoM-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleUoM_Post_21293A63382C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleUoM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleUoM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleUoM" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleUoM" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleUoM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleUoM" } } } } } }, "put": { "tags": [ "ArticleUoM" ], "summary": "ArticleUoM: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleUoM-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleUoM_Put_6774F529176B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleUoM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleUoM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleUoM" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleUoM" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleUoM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleUoM" } } } } } } }, "/api/ArticleUoM/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "ArticleUoM" ], "summary": "ArticleUoM: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleUoM-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleUoM_GetPageByValue_77C0AA4D5853", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleUoM/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "ArticleUoM" ], "summary": "ArticleUoM: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleUoM-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleUoM_GetPageByValue2_0626CD08369E", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleUoM/DeleteByFilter": { "post": { "tags": [ "ArticleUoM" ], "summary": "ArticleUoM: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleUoM-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleUoM_DeleteByFilter_D024C83F28CA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/ArticleUoM/GetAllByValue": { "post": { "tags": [ "ArticleUoM" ], "summary": "ArticleUoM: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleUoM-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleUoM_GetAllByValue_F9ABF2C1F258", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleUoM" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleUoM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleUoM" } } } } } } }, "/api/ArticleUoM/GetAllGraphByValue": { "post": { "tags": [ "ArticleUoM" ], "summary": "ArticleUoM: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleUoM-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleUoM_GetAllGraphByValue_88BE8893D4E3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleUoM" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleUoM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleUoM" } } } } } } }, "/api/ArticleUoM/GetByValue": { "post": { "tags": [ "ArticleUoM" ], "summary": "ArticleUoM: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleUoM-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleUoM_GetByValue_432DF9719455", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleUoM" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleUoM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleUoM" } } } } } } }, "/api/ArticleUoM/GetLookup": { "post": { "tags": [ "ArticleUoM" ], "summary": "ArticleUoM: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleUoM-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleUoM_GetLookup_6AF1AEDBF1EA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ArticleUoM/GetLookupByValue": { "post": { "tags": [ "ArticleUoM" ], "summary": "ArticleUoM: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleUoM-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleUoM_GetLookupByValue_DCF78FE7E25E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ArticleUoM/Page": { "get": { "tags": [ "ArticleUoM" ], "summary": "ArticleUoM: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleUoM-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleUoM_GetPage_EDACA4920494", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleUoM/PageAsc": { "get": { "tags": [ "ArticleUoM" ], "summary": "ArticleUoM: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleUoM-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleUoM_GetPageAsc_99CF43314FA9", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleUoM/SearchByValue": { "post": { "tags": [ "ArticleUoM" ], "summary": "ArticleUoM: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleUoM-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleUoM_SearchByValue_A4BC51D7EB0B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleUoM" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleUoM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleUoM" } } } } } } }, "/api/ArticleUoM/TryGetByValue": { "post": { "tags": [ "ArticleUoM" ], "summary": "ArticleUoM: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleUoM-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleUoM_TryGetByValue_03FD0E2E9925", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleUoM" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleUoM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleUoM" } } } } } } }, "/api/ArticleUoM/UpsertGraph": { "put": { "tags": [ "ArticleUoM" ], "summary": "ArticleUoM: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleUoM-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleUoM_UpsertGraph_7F363DC9817B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleUoM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleUoM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleUoM" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleUoM" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleUoM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleUoM" } } } } } } }, "/api/ArticleUoM/UpsertGraphWithExtraFields": { "put": { "tags": [ "ArticleUoM" ], "summary": "ArticleUoM: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleUoM-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleUoM_UpsertGraphWithExtraFields_C749CEC0D7A8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleUoM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleUoM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleUoM" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleUoM" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleUoM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleUoM" } } } } } } }, "/api/ArticleUoMConversion": { "get": { "tags": [ "ArticleUoMConversion" ], "summary": "ArticleUoMConversion: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleUoMConversion-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleUoMConversion_GetAll_40D57426B253", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleUoMConversion" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleUoMConversion" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleUoMConversion" } } } } } }, "post": { "tags": [ "ArticleUoMConversion" ], "summary": "ArticleUoMConversion: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleUoMConversion-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleUoMConversion_Post_A3FF0BB9877D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleUoMConversion" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleUoMConversion" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleUoMConversion" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleUoMConversion" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleUoMConversion" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleUoMConversion" } } } } } }, "put": { "tags": [ "ArticleUoMConversion" ], "summary": "ArticleUoMConversion: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleUoMConversion-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleUoMConversion_Put_C9643345540F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleUoMConversion" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleUoMConversion" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleUoMConversion" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleUoMConversion" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleUoMConversion" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleUoMConversion" } } } } } } }, "/api/ArticleUoMConversion/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "ArticleUoMConversion" ], "summary": "ArticleUoMConversion: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleUoMConversion-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleUoMConversion_GetPageByValue_304B417D2C14", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleUoMConversion/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "ArticleUoMConversion" ], "summary": "ArticleUoMConversion: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleUoMConversion-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleUoMConversion_GetPageByValue2_29F4DA8D8582", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleUoMConversion/DeleteByFilter": { "post": { "tags": [ "ArticleUoMConversion" ], "summary": "ArticleUoMConversion: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleUoMConversion-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleUoMConversion_DeleteByFilter_83D3C06D5529", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/ArticleUoMConversion/GetAllByValue": { "post": { "tags": [ "ArticleUoMConversion" ], "summary": "ArticleUoMConversion: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleUoMConversion-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleUoMConversion_GetAllByValue_D78B824AB945", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleUoMConversion" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleUoMConversion" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleUoMConversion" } } } } } } }, "/api/ArticleUoMConversion/GetAllGraphByValue": { "post": { "tags": [ "ArticleUoMConversion" ], "summary": "ArticleUoMConversion: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleUoMConversion-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleUoMConversion_GetAllGraphByValue_1A110F679AB1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleUoMConversion" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleUoMConversion" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleUoMConversion" } } } } } } }, "/api/ArticleUoMConversion/GetByValue": { "post": { "tags": [ "ArticleUoMConversion" ], "summary": "ArticleUoMConversion: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleUoMConversion-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleUoMConversion_GetByValue_2754EA3870C3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleUoMConversion" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleUoMConversion" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleUoMConversion" } } } } } } }, "/api/ArticleUoMConversion/GetLookup": { "post": { "tags": [ "ArticleUoMConversion" ], "summary": "ArticleUoMConversion: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleUoMConversion-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleUoMConversion_GetLookup_2B3B74C79FA1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ArticleUoMConversion/GetLookupByValue": { "post": { "tags": [ "ArticleUoMConversion" ], "summary": "ArticleUoMConversion: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleUoMConversion-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleUoMConversion_GetLookupByValue_B4B1ECBC4698", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ArticleUoMConversion/Page": { "get": { "tags": [ "ArticleUoMConversion" ], "summary": "ArticleUoMConversion: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleUoMConversion-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleUoMConversion_GetPage_116CC4295847", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleUoMConversion/PageAsc": { "get": { "tags": [ "ArticleUoMConversion" ], "summary": "ArticleUoMConversion: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleUoMConversion-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleUoMConversion_GetPageAsc_6671EF5604F2", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ArticleUoMConversion/SearchByValue": { "post": { "tags": [ "ArticleUoMConversion" ], "summary": "ArticleUoMConversion: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleUoMConversion-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleUoMConversion_SearchByValue_DCD6BF788B8A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleUoMConversion" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleUoMConversion" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleUoMConversion" } } } } } } }, "/api/ArticleUoMConversion/TryGetByValue": { "post": { "tags": [ "ArticleUoMConversion" ], "summary": "ArticleUoMConversion: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleUoMConversion-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleUoMConversion_TryGetByValue_84FD02DB8071", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleUoMConversion" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleUoMConversion" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleUoMConversion" } } } } } } }, "/api/ArticleUoMConversion/UpsertGraph": { "put": { "tags": [ "ArticleUoMConversion" ], "summary": "ArticleUoMConversion: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleUoMConversion-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleUoMConversion_UpsertGraph_59613F1A8842", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleUoMConversion" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleUoMConversion" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleUoMConversion" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleUoMConversion" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleUoMConversion" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleUoMConversion" } } } } } } }, "/api/ArticleUoMConversion/UpsertGraphWithExtraFields": { "put": { "tags": [ "ArticleUoMConversion" ], "summary": "ArticleUoMConversion: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ArticleUoMConversion-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ArticleUoMConversion_UpsertGraphWithExtraFields_BE54D0304D6B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleUoMConversion" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleUoMConversion" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleUoMConversion" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleUoMConversion" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleUoMConversion" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleUoMConversion" } } } } } } }, "/api/Attachment": { "get": { "tags": [ "Attachment" ], "summary": "Attachment: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Attachment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Attachment_GetAll_A4BEC9F474D9", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Attachment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Attachment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Attachment" } } } } } }, "post": { "tags": [ "Attachment" ], "summary": "Attachment: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Attachment-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Attachment_Post_F728D1D02593", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Attachment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Attachment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Attachment" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Attachment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Attachment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Attachment" } } } } } }, "put": { "tags": [ "Attachment" ], "summary": "Attachment: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Attachment-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Attachment_Put_90053C91FA0A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Attachment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Attachment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Attachment" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Attachment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Attachment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Attachment" } } } } } } }, "/api/Attachment/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "Attachment" ], "summary": "Attachment: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Attachment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Attachment_GetPageByValue_2CABCAC04BF5", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Attachment/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "Attachment" ], "summary": "Attachment: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Attachment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Attachment_GetPageByValue2_E2C2476ED572", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Attachment/DeleteByFilter": { "post": { "tags": [ "Attachment" ], "summary": "Attachment: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Attachment-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Attachment_DeleteByFilter_15CF956AFE80", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/Attachment/GetAllByValue": { "post": { "tags": [ "Attachment" ], "summary": "Attachment: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Attachment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Attachment_GetAllByValue_16253659CF13", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Attachment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Attachment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Attachment" } } } } } } }, "/api/Attachment/GetAllGraphByValue": { "post": { "tags": [ "Attachment" ], "summary": "Attachment: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Attachment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Attachment_GetAllGraphByValue_3473CC17EA56", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Attachment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Attachment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Attachment" } } } } } } }, "/api/Attachment/GetByValue": { "post": { "tags": [ "Attachment" ], "summary": "Attachment: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Attachment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Attachment_GetByValue_E4B46AD0CE5F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Attachment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Attachment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Attachment" } } } } } } }, "/api/Attachment/GetLookup": { "post": { "tags": [ "Attachment" ], "summary": "Attachment: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Attachment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Attachment_GetLookup_6284F3FA6F49", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/Attachment/GetLookupByValue": { "post": { "tags": [ "Attachment" ], "summary": "Attachment: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Attachment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Attachment_GetLookupByValue_784785163F85", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/Attachment/Page": { "get": { "tags": [ "Attachment" ], "summary": "Attachment: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Attachment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Attachment_GetPage_B2E240DB965A", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Attachment/PageAsc": { "get": { "tags": [ "Attachment" ], "summary": "Attachment: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Attachment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Attachment_GetPageAsc_16BE658E6F26", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Attachment/SearchByValue": { "post": { "tags": [ "Attachment" ], "summary": "Attachment: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Attachment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Attachment_SearchByValue_F1528382DA08", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.Attachment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.Attachment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.Attachment" } } } } } } }, "/api/Attachment/TryGetByValue": { "post": { "tags": [ "Attachment" ], "summary": "Attachment: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Attachment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Attachment_TryGetByValue_14ABA72A78CC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Attachment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Attachment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Attachment" } } } } } } }, "/api/Attachment/UpsertGraph": { "put": { "tags": [ "Attachment" ], "summary": "Attachment: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Attachment-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Attachment_UpsertGraph_7856C6E159C9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Attachment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Attachment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Attachment" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Attachment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Attachment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Attachment" } } } } } } }, "/api/Attachment/UpsertGraphWithExtraFields": { "put": { "tags": [ "Attachment" ], "summary": "Attachment: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Attachment-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Attachment_UpsertGraphWithExtraFields_9C0A0E39ECCC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Attachment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Attachment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Attachment" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Attachment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Attachment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Attachment" } } } } } } }, "/api/AttachmentFile": { "get": { "tags": [ "AttachmentFile" ], "summary": "AttachmentFile: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AttachmentFile-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AttachmentFile_GetAll_BF0E7EE7D5FB", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AttachmentFile" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AttachmentFile" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AttachmentFile" } } } } } }, "post": { "tags": [ "AttachmentFile" ], "summary": "AttachmentFile: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AttachmentFile-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AttachmentFile_Post_8B545E6D824A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AttachmentFile" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AttachmentFile" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AttachmentFile" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AttachmentFile" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AttachmentFile" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AttachmentFile" } } } } } }, "put": { "tags": [ "AttachmentFile" ], "summary": "AttachmentFile: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AttachmentFile-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AttachmentFile_Put_BFB37361AB37", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AttachmentFile" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AttachmentFile" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AttachmentFile" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AttachmentFile" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AttachmentFile" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AttachmentFile" } } } } } } }, "/api/AttachmentFile/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "AttachmentFile" ], "summary": "AttachmentFile: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AttachmentFile-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AttachmentFile_GetPageByValue_53AA36645D5F", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AttachmentFile/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "AttachmentFile" ], "summary": "AttachmentFile: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AttachmentFile-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AttachmentFile_GetPageByValue2_B7C9089C2427", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AttachmentFile/AttachmentFilePut": { "put": { "tags": [ "AttachmentFile" ], "summary": "AttachmentFile: PutAttachmentFile", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AttachmentFile-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AttachmentFile_PutAttachmentFile_6041C881E274", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AttachmentFileDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AttachmentFileDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AttachmentFileDto" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AttachmentFileDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AttachmentFileDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AttachmentFileDto" } } } } } } }, "/api/AttachmentFile/DeleteByFilter": { "post": { "tags": [ "AttachmentFile" ], "summary": "AttachmentFile: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AttachmentFile-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AttachmentFile_DeleteByFilter_9EAC4E233471", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/AttachmentFile/DownloadFile/{attachmentFileId}": { "get": { "tags": [ "AttachmentFile" ], "summary": "AttachmentFile: DownloadFile", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AttachmentFile-Read.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AttachmentFile_DownloadFile_554D1077A61C", "parameters": [ { "name": "attachmentFileId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AttachmentFile/GetAllByValue": { "post": { "tags": [ "AttachmentFile" ], "summary": "AttachmentFile: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AttachmentFile-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AttachmentFile_GetAllByValue_A0916E580116", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AttachmentFile" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AttachmentFile" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AttachmentFile" } } } } } } }, "/api/AttachmentFile/GetAllGraphByValue": { "post": { "tags": [ "AttachmentFile" ], "summary": "AttachmentFile: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AttachmentFile-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AttachmentFile_GetAllGraphByValue_BD59304B2698", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AttachmentFile" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AttachmentFile" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AttachmentFile" } } } } } } }, "/api/AttachmentFile/GetAttachmentFilesByValue": { "post": { "tags": [ "AttachmentFile" ], "summary": "AttachmentFile: GetAttachmentFilesByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AttachmentFile-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AttachmentFile_GetAttachmentFilesByValue_8EDC1BAB753C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AttachmentFileDto_GetByValueRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AttachmentFileDto_GetByValueRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AttachmentFileDto_GetByValueRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AttachmentFileDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AttachmentFileDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AttachmentFileDto" } } } } } } }, "/api/AttachmentFile/GetByValue": { "post": { "tags": [ "AttachmentFile" ], "summary": "AttachmentFile: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AttachmentFile-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AttachmentFile_GetByValue_26C02D284A0A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AttachmentFile" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AttachmentFile" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AttachmentFile" } } } } } } }, "/api/AttachmentFile/GetLookup": { "post": { "tags": [ "AttachmentFile" ], "summary": "AttachmentFile: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AttachmentFile-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AttachmentFile_GetLookup_1CF1C8983854", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/AttachmentFile/GetLookupByValue": { "post": { "tags": [ "AttachmentFile" ], "summary": "AttachmentFile: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AttachmentFile-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AttachmentFile_GetLookupByValue_9F7197EBD6FA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/AttachmentFile/Page": { "get": { "tags": [ "AttachmentFile" ], "summary": "AttachmentFile: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AttachmentFile-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AttachmentFile_GetPage_62F58B44676D", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AttachmentFile/PageAsc": { "get": { "tags": [ "AttachmentFile" ], "summary": "AttachmentFile: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AttachmentFile-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AttachmentFile_GetPageAsc_6F5DBFBB71CF", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AttachmentFile/RequeueOcr/{attachmentFileOcrId}": { "post": { "tags": [ "AttachmentFile" ], "summary": "AttachmentFile: RequeueOcr", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AttachmentFile-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AttachmentFile_RequeueOcr_47B40710B54D", "parameters": [ { "name": "attachmentFileOcrId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/AttachmentFile/SearchByValue": { "post": { "tags": [ "AttachmentFile" ], "summary": "AttachmentFile: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AttachmentFile-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AttachmentFile_SearchByValue_2B1B1A4919C3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AttachmentFile" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AttachmentFile" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AttachmentFile" } } } } } } }, "/api/AttachmentFile/TryGetByValue": { "post": { "tags": [ "AttachmentFile" ], "summary": "AttachmentFile: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AttachmentFile-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AttachmentFile_TryGetByValue_3FA51A30A6C2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AttachmentFile" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AttachmentFile" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AttachmentFile" } } } } } } }, "/api/AttachmentFile/UploadChunkFile/{attachmentId}": { "post": { "tags": [ "AttachmentFile" ], "summary": "AttachmentFile: UploadChunkFile", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AttachmentFile-Create.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AttachmentFile_UploadChunkFile_94FE05A9E1B0", "parameters": [ { "name": "attachmentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "fileChunk": { "type": "string", "format": "binary" } } }, "encoding": { "fileChunk": { "style": "form" } } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/AttachmentFile/UpsertGraph": { "put": { "tags": [ "AttachmentFile" ], "summary": "AttachmentFile: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AttachmentFile-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AttachmentFile_UpsertGraph_80C918EF9D08", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AttachmentFile" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AttachmentFile" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AttachmentFile" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AttachmentFile" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AttachmentFile" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AttachmentFile" } } } } } } }, "/api/AttachmentFile/UpsertGraphWithExtraFields": { "put": { "tags": [ "AttachmentFile" ], "summary": "AttachmentFile: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AttachmentFile-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AttachmentFile_UpsertGraphWithExtraFields_1D4614E8E9D1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AttachmentFile" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AttachmentFile" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AttachmentFile" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AttachmentFile" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AttachmentFile" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AttachmentFile" } } } } } } }, "/api/AttachmentStatus": { "get": { "tags": [ "AttachmentStatus" ], "summary": "AttachmentStatus: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AttachmentStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AttachmentStatus_GetAll_D6C901B2E98C", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AttachmentStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AttachmentStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AttachmentStatus" } } } } } }, "post": { "tags": [ "AttachmentStatus" ], "summary": "AttachmentStatus: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AttachmentStatus-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AttachmentStatus_Post_F2DBE4A3CD95", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AttachmentStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AttachmentStatus" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AttachmentStatus" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AttachmentStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AttachmentStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AttachmentStatus" } } } } } }, "put": { "tags": [ "AttachmentStatus" ], "summary": "AttachmentStatus: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AttachmentStatus-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AttachmentStatus_Put_1FB2225365D3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AttachmentStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AttachmentStatus" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AttachmentStatus" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AttachmentStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AttachmentStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AttachmentStatus" } } } } } } }, "/api/AttachmentStatus/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "AttachmentStatus" ], "summary": "AttachmentStatus: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AttachmentStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AttachmentStatus_GetPageByValue_DD8CF75FC660", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AttachmentStatus/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "AttachmentStatus" ], "summary": "AttachmentStatus: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AttachmentStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AttachmentStatus_GetPageByValue2_93EF0CE2450C", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AttachmentStatus/DeleteByFilter": { "post": { "tags": [ "AttachmentStatus" ], "summary": "AttachmentStatus: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AttachmentStatus-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AttachmentStatus_DeleteByFilter_8C5D71F202B0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/AttachmentStatus/GetAllByValue": { "post": { "tags": [ "AttachmentStatus" ], "summary": "AttachmentStatus: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AttachmentStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AttachmentStatus_GetAllByValue_496ECF0A6BE3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AttachmentStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AttachmentStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AttachmentStatus" } } } } } } }, "/api/AttachmentStatus/GetAllGraphByValue": { "post": { "tags": [ "AttachmentStatus" ], "summary": "AttachmentStatus: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AttachmentStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AttachmentStatus_GetAllGraphByValue_1FBF4B1BF885", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AttachmentStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AttachmentStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AttachmentStatus" } } } } } } }, "/api/AttachmentStatus/GetByValue": { "post": { "tags": [ "AttachmentStatus" ], "summary": "AttachmentStatus: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AttachmentStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AttachmentStatus_GetByValue_95861FF29A92", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AttachmentStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AttachmentStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AttachmentStatus" } } } } } } }, "/api/AttachmentStatus/GetLookup": { "post": { "tags": [ "AttachmentStatus" ], "summary": "AttachmentStatus: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AttachmentStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AttachmentStatus_GetLookup_40DE7B37916C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/AttachmentStatus/GetLookupByValue": { "post": { "tags": [ "AttachmentStatus" ], "summary": "AttachmentStatus: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AttachmentStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AttachmentStatus_GetLookupByValue_79785CC13D39", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/AttachmentStatus/Page": { "get": { "tags": [ "AttachmentStatus" ], "summary": "AttachmentStatus: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AttachmentStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AttachmentStatus_GetPage_F7D23C6FB323", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AttachmentStatus/PageAsc": { "get": { "tags": [ "AttachmentStatus" ], "summary": "AttachmentStatus: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AttachmentStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AttachmentStatus_GetPageAsc_842B4F2CFF6A", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AttachmentStatus/SearchByValue": { "post": { "tags": [ "AttachmentStatus" ], "summary": "AttachmentStatus: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AttachmentStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AttachmentStatus_SearchByValue_1867B2577DB2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AttachmentStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AttachmentStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AttachmentStatus" } } } } } } }, "/api/AttachmentStatus/TryGetByValue": { "post": { "tags": [ "AttachmentStatus" ], "summary": "AttachmentStatus: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AttachmentStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AttachmentStatus_TryGetByValue_17FA4B1C833B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AttachmentStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AttachmentStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AttachmentStatus" } } } } } } }, "/api/AttachmentStatus/UpsertGraph": { "put": { "tags": [ "AttachmentStatus" ], "summary": "AttachmentStatus: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AttachmentStatus-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AttachmentStatus_UpsertGraph_C8F6DFFE0668", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AttachmentStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AttachmentStatus" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AttachmentStatus" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AttachmentStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AttachmentStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AttachmentStatus" } } } } } } }, "/api/AttachmentStatus/UpsertGraphWithExtraFields": { "put": { "tags": [ "AttachmentStatus" ], "summary": "AttachmentStatus: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AttachmentStatus-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AttachmentStatus_UpsertGraphWithExtraFields_1710D927377C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AttachmentStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AttachmentStatus" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AttachmentStatus" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AttachmentStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AttachmentStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AttachmentStatus" } } } } } } }, "/api/AuthorizationPage": { "get": { "tags": [ "AuthorizationPage" ], "summary": "AuthorizationPage: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AuthorizationPage-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AuthorizationPage_GetAll_4945426C2D38", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AuthorizationPage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AuthorizationPage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AuthorizationPage" } } } } } }, "post": { "tags": [ "AuthorizationPage" ], "summary": "AuthorizationPage: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AuthorizationPage-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AuthorizationPage_Post_2EB6F301FBB9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AuthorizationPage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AuthorizationPage" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AuthorizationPage" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AuthorizationPage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AuthorizationPage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AuthorizationPage" } } } } } }, "put": { "tags": [ "AuthorizationPage" ], "summary": "AuthorizationPage: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AuthorizationPage-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AuthorizationPage_Put_9E8FD5A4096C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AuthorizationPage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AuthorizationPage" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AuthorizationPage" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AuthorizationPage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AuthorizationPage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AuthorizationPage" } } } } } } }, "/api/AuthorizationPage/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "AuthorizationPage" ], "summary": "AuthorizationPage: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AuthorizationPage-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AuthorizationPage_GetPageByValue_5A3947512D02", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AuthorizationPage/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "AuthorizationPage" ], "summary": "AuthorizationPage: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AuthorizationPage-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AuthorizationPage_GetPageByValue2_B820241D0BFC", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AuthorizationPage/DeleteByFilter": { "post": { "tags": [ "AuthorizationPage" ], "summary": "AuthorizationPage: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AuthorizationPage-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AuthorizationPage_DeleteByFilter_9A6C8CE4AC2E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/AuthorizationPage/GetAllByValue": { "post": { "tags": [ "AuthorizationPage" ], "summary": "AuthorizationPage: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AuthorizationPage-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AuthorizationPage_GetAllByValue_0E300FBB15D3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AuthorizationPage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AuthorizationPage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AuthorizationPage" } } } } } } }, "/api/AuthorizationPage/GetAllGraphByValue": { "post": { "tags": [ "AuthorizationPage" ], "summary": "AuthorizationPage: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AuthorizationPage-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AuthorizationPage_GetAllGraphByValue_71CB2EEB4D5E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AuthorizationPage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AuthorizationPage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AuthorizationPage" } } } } } } }, "/api/AuthorizationPage/GetByValue": { "post": { "tags": [ "AuthorizationPage" ], "summary": "AuthorizationPage: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AuthorizationPage-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AuthorizationPage_GetByValue_C65B3A077E35", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AuthorizationPage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AuthorizationPage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AuthorizationPage" } } } } } } }, "/api/AuthorizationPage/GetLookup": { "post": { "tags": [ "AuthorizationPage" ], "summary": "AuthorizationPage: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AuthorizationPage-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AuthorizationPage_GetLookup_6A7F5D6AE2B3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/AuthorizationPage/GetLookupByValue": { "post": { "tags": [ "AuthorizationPage" ], "summary": "AuthorizationPage: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AuthorizationPage-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AuthorizationPage_GetLookupByValue_91647DB869D4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/AuthorizationPage/Page": { "get": { "tags": [ "AuthorizationPage" ], "summary": "AuthorizationPage: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AuthorizationPage-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AuthorizationPage_GetPage_8073312A5131", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AuthorizationPage/PageAsc": { "get": { "tags": [ "AuthorizationPage" ], "summary": "AuthorizationPage: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AuthorizationPage-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AuthorizationPage_GetPageAsc_98E8666F01D9", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AuthorizationPage/SearchByValue": { "post": { "tags": [ "AuthorizationPage" ], "summary": "AuthorizationPage: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AuthorizationPage-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AuthorizationPage_SearchByValue_1DD31CF82BB3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AuthorizationPage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AuthorizationPage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AuthorizationPage" } } } } } } }, "/api/AuthorizationPage/TryGetByValue": { "post": { "tags": [ "AuthorizationPage" ], "summary": "AuthorizationPage: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AuthorizationPage-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AuthorizationPage_TryGetByValue_08DFC35BEF6D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AuthorizationPage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AuthorizationPage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AuthorizationPage" } } } } } } }, "/api/AuthorizationPage/UpsertGraph": { "put": { "tags": [ "AuthorizationPage" ], "summary": "AuthorizationPage: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AuthorizationPage-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AuthorizationPage_UpsertGraph_35E1AE01BED9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AuthorizationPage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AuthorizationPage" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AuthorizationPage" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AuthorizationPage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AuthorizationPage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AuthorizationPage" } } } } } } }, "/api/AuthorizationPage/UpsertGraphWithExtraFields": { "put": { "tags": [ "AuthorizationPage" ], "summary": "AuthorizationPage: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AuthorizationPage-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AuthorizationPage_UpsertGraphWithExtraFields_F073B6048C6D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AuthorizationPage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AuthorizationPage" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AuthorizationPage" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AuthorizationPage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AuthorizationPage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AuthorizationPage" } } } } } } }, "/api/AuthorizationWebApi": { "get": { "tags": [ "AuthorizationWebApi" ], "summary": "AuthorizationWebApi: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AuthorizationWebApi-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AuthorizationWebApi_GetAll_3DB3CD7BF85D", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AuthorizationWebApi" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AuthorizationWebApi" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AuthorizationWebApi" } } } } } }, "post": { "tags": [ "AuthorizationWebApi" ], "summary": "AuthorizationWebApi: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AuthorizationWebApi-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AuthorizationWebApi_Post_5F71EF3FB39C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AuthorizationWebApi" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AuthorizationWebApi" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AuthorizationWebApi" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AuthorizationWebApi" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AuthorizationWebApi" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AuthorizationWebApi" } } } } } }, "put": { "tags": [ "AuthorizationWebApi" ], "summary": "AuthorizationWebApi: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AuthorizationWebApi-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AuthorizationWebApi_Put_3E272A023251", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AuthorizationWebApi" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AuthorizationWebApi" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AuthorizationWebApi" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AuthorizationWebApi" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AuthorizationWebApi" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AuthorizationWebApi" } } } } } } }, "/api/AuthorizationWebApi/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "AuthorizationWebApi" ], "summary": "AuthorizationWebApi: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AuthorizationWebApi-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AuthorizationWebApi_GetPageByValue_335EA518D89C", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AuthorizationWebApi/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "AuthorizationWebApi" ], "summary": "AuthorizationWebApi: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AuthorizationWebApi-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AuthorizationWebApi_GetPageByValue2_CD6AE36AE2D7", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AuthorizationWebApi/DeleteByFilter": { "post": { "tags": [ "AuthorizationWebApi" ], "summary": "AuthorizationWebApi: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AuthorizationWebApi-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AuthorizationWebApi_DeleteByFilter_A620FFD9483C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/AuthorizationWebApi/GetAllByValue": { "post": { "tags": [ "AuthorizationWebApi" ], "summary": "AuthorizationWebApi: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AuthorizationWebApi-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AuthorizationWebApi_GetAllByValue_5F8E2AA8A150", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AuthorizationWebApi" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AuthorizationWebApi" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AuthorizationWebApi" } } } } } } }, "/api/AuthorizationWebApi/GetAllGraphByValue": { "post": { "tags": [ "AuthorizationWebApi" ], "summary": "AuthorizationWebApi: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AuthorizationWebApi-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AuthorizationWebApi_GetAllGraphByValue_987F26BEE77D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AuthorizationWebApi" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AuthorizationWebApi" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AuthorizationWebApi" } } } } } } }, "/api/AuthorizationWebApi/GetByValue": { "post": { "tags": [ "AuthorizationWebApi" ], "summary": "AuthorizationWebApi: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AuthorizationWebApi-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AuthorizationWebApi_GetByValue_EB2DC443BDDC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AuthorizationWebApi" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AuthorizationWebApi" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AuthorizationWebApi" } } } } } } }, "/api/AuthorizationWebApi/GetLookup": { "post": { "tags": [ "AuthorizationWebApi" ], "summary": "AuthorizationWebApi: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AuthorizationWebApi-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AuthorizationWebApi_GetLookup_7B786D71052E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/AuthorizationWebApi/GetLookupByValue": { "post": { "tags": [ "AuthorizationWebApi" ], "summary": "AuthorizationWebApi: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AuthorizationWebApi-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AuthorizationWebApi_GetLookupByValue_7641098F15C8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/AuthorizationWebApi/Page": { "get": { "tags": [ "AuthorizationWebApi" ], "summary": "AuthorizationWebApi: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AuthorizationWebApi-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AuthorizationWebApi_GetPage_75329BE9EB8B", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AuthorizationWebApi/PageAsc": { "get": { "tags": [ "AuthorizationWebApi" ], "summary": "AuthorizationWebApi: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AuthorizationWebApi-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AuthorizationWebApi_GetPageAsc_AF29FD8D3027", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/AuthorizationWebApi/SearchByValue": { "post": { "tags": [ "AuthorizationWebApi" ], "summary": "AuthorizationWebApi: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AuthorizationWebApi-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AuthorizationWebApi_SearchByValue_ABA60EE6F1E5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AuthorizationWebApi" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AuthorizationWebApi" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AuthorizationWebApi" } } } } } } }, "/api/AuthorizationWebApi/TryGetByValue": { "post": { "tags": [ "AuthorizationWebApi" ], "summary": "AuthorizationWebApi: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AuthorizationWebApi-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AuthorizationWebApi_TryGetByValue_B07DC43A6209", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AuthorizationWebApi" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AuthorizationWebApi" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AuthorizationWebApi" } } } } } } }, "/api/AuthorizationWebApi/UpsertGraph": { "put": { "tags": [ "AuthorizationWebApi" ], "summary": "AuthorizationWebApi: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AuthorizationWebApi-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AuthorizationWebApi_UpsertGraph_082B2F6DBF06", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AuthorizationWebApi" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AuthorizationWebApi" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AuthorizationWebApi" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AuthorizationWebApi" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AuthorizationWebApi" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AuthorizationWebApi" } } } } } } }, "/api/AuthorizationWebApi/UpsertGraphWithExtraFields": { "put": { "tags": [ "AuthorizationWebApi" ], "summary": "AuthorizationWebApi: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: AuthorizationWebApi-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "AuthorizationWebApi_UpsertGraphWithExtraFields_1F45F2CCD535", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AuthorizationWebApi" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AuthorizationWebApi" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AuthorizationWebApi" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AuthorizationWebApi" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AuthorizationWebApi" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AuthorizationWebApi" } } } } } } }, "/api/Bulletin": { "get": { "tags": [ "Bulletin" ], "summary": "Bulletin: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Bulletin-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Bulletin_GetAll_ABB277215B14", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Bulletin" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Bulletin" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Bulletin" } } } } } }, "post": { "tags": [ "Bulletin" ], "summary": "Bulletin: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Bulletin-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Bulletin_Post_B11E5FD64757", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Bulletin" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Bulletin" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Bulletin" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Bulletin" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Bulletin" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Bulletin" } } } } } }, "put": { "tags": [ "Bulletin" ], "summary": "Bulletin: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Bulletin-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Bulletin_Put_082FA7071330", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Bulletin" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Bulletin" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Bulletin" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Bulletin" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Bulletin" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Bulletin" } } } } } } }, "/api/Bulletin/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "Bulletin" ], "summary": "Bulletin: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Bulletin-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Bulletin_GetPageByValue_8F52FCBB864C", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Bulletin/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "Bulletin" ], "summary": "Bulletin: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Bulletin-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Bulletin_GetPageByValue2_DBBD3E36E244", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Bulletin/DeleteByFilter": { "post": { "tags": [ "Bulletin" ], "summary": "Bulletin: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Bulletin-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Bulletin_DeleteByFilter_E378E4F68DAA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/Bulletin/GetAllByValue": { "post": { "tags": [ "Bulletin" ], "summary": "Bulletin: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Bulletin-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Bulletin_GetAllByValue_08628BF62493", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Bulletin" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Bulletin" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Bulletin" } } } } } } }, "/api/Bulletin/GetAllGraphByValue": { "post": { "tags": [ "Bulletin" ], "summary": "Bulletin: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Bulletin-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Bulletin_GetAllGraphByValue_BDFB06030D25", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Bulletin" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Bulletin" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Bulletin" } } } } } } }, "/api/Bulletin/GetByValue": { "post": { "tags": [ "Bulletin" ], "summary": "Bulletin: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Bulletin-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Bulletin_GetByValue_1794FE746148", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Bulletin" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Bulletin" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Bulletin" } } } } } } }, "/api/Bulletin/GetLookup": { "post": { "tags": [ "Bulletin" ], "summary": "Bulletin: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Bulletin-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Bulletin_GetLookup_7CB128AA1D23", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/Bulletin/GetLookupByValue": { "post": { "tags": [ "Bulletin" ], "summary": "Bulletin: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Bulletin-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Bulletin_GetLookupByValue_98D4CF6112EF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/Bulletin/Page": { "get": { "tags": [ "Bulletin" ], "summary": "Bulletin: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Bulletin-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Bulletin_GetPage_E9560754EB84", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Bulletin/PageAsc": { "get": { "tags": [ "Bulletin" ], "summary": "Bulletin: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Bulletin-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Bulletin_GetPageAsc_5ACC264D2270", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Bulletin/PageBulletinsByParent/{CategoryId}/{IncludeSubNodes}/{UnreadByCurrentUserOnly}": { "get": { "tags": [ "Bulletin" ], "summary": "Bulletin: GetPageBulletinsByParent", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Bulletin-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Bulletin_GetPageBulletinsByParent_B1E543449572", "parameters": [ { "name": "CategoryId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "IncludeSubNodes", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "UnreadByCurrentUserOnly", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Bulletin/SearchByValue": { "post": { "tags": [ "Bulletin" ], "summary": "Bulletin: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Bulletin-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Bulletin_SearchByValue_BA01280B8442", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.Bulletin" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.Bulletin" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.Bulletin" } } } } } } }, "/api/Bulletin/TryGetByValue": { "post": { "tags": [ "Bulletin" ], "summary": "Bulletin: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Bulletin-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Bulletin_TryGetByValue_7658B4EAAC22", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Bulletin" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Bulletin" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Bulletin" } } } } } } }, "/api/Bulletin/UpsertGraph": { "put": { "tags": [ "Bulletin" ], "summary": "Bulletin: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Bulletin-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Bulletin_UpsertGraph_3A9E2C376BC8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Bulletin" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Bulletin" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Bulletin" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Bulletin" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Bulletin" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Bulletin" } } } } } } }, "/api/Bulletin/UpsertGraphWithExtraFields": { "put": { "tags": [ "Bulletin" ], "summary": "Bulletin: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Bulletin-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Bulletin_UpsertGraphWithExtraFields_D1B75C3AD928", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Bulletin" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Bulletin" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Bulletin" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Bulletin" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Bulletin" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Bulletin" } } } } } } }, "/api/BulletinCategory": { "get": { "tags": [ "BulletinCategory" ], "summary": "BulletinCategory: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: BulletinCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "BulletinCategory_GetAll_C3CAE9BA3EBD", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.BulletinCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.BulletinCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.BulletinCategory" } } } } } }, "post": { "tags": [ "BulletinCategory" ], "summary": "BulletinCategory: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: BulletinCategory-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "BulletinCategory_Post_8C5133E30EEB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.BulletinCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.BulletinCategory" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.BulletinCategory" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.BulletinCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.BulletinCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.BulletinCategory" } } } } } }, "put": { "tags": [ "BulletinCategory" ], "summary": "BulletinCategory: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: BulletinCategory-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "BulletinCategory_Put_72F66DA2EE66", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.BulletinCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.BulletinCategory" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.BulletinCategory" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.BulletinCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.BulletinCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.BulletinCategory" } } } } } } }, "/api/BulletinCategory/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "BulletinCategory" ], "summary": "BulletinCategory: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: BulletinCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "BulletinCategory_GetPageByValue_EDA53A9FA2F2", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/BulletinCategory/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "BulletinCategory" ], "summary": "BulletinCategory: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: BulletinCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "BulletinCategory_GetPageByValue2_A7523A60A3AC", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/BulletinCategory/DeleteByFilter": { "post": { "tags": [ "BulletinCategory" ], "summary": "BulletinCategory: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: BulletinCategory-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "BulletinCategory_DeleteByFilter_7F3B6C227EA5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/BulletinCategory/GetAllByValue": { "post": { "tags": [ "BulletinCategory" ], "summary": "BulletinCategory: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: BulletinCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "BulletinCategory_GetAllByValue_199B4F053A4C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.BulletinCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.BulletinCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.BulletinCategory" } } } } } } }, "/api/BulletinCategory/GetAllGraphByValue": { "post": { "tags": [ "BulletinCategory" ], "summary": "BulletinCategory: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: BulletinCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "BulletinCategory_GetAllGraphByValue_72800898BB41", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.BulletinCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.BulletinCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.BulletinCategory" } } } } } } }, "/api/BulletinCategory/GetByValue": { "post": { "tags": [ "BulletinCategory" ], "summary": "BulletinCategory: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: BulletinCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "BulletinCategory_GetByValue_47DB4DFA5E09", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.BulletinCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.BulletinCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.BulletinCategory" } } } } } } }, "/api/BulletinCategory/GetLookup": { "post": { "tags": [ "BulletinCategory" ], "summary": "BulletinCategory: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: BulletinCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "BulletinCategory_GetLookup_12A85A34A998", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/BulletinCategory/GetLookupByValue": { "post": { "tags": [ "BulletinCategory" ], "summary": "BulletinCategory: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: BulletinCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "BulletinCategory_GetLookupByValue_59636AE2D23E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/BulletinCategory/Page": { "get": { "tags": [ "BulletinCategory" ], "summary": "BulletinCategory: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: BulletinCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "BulletinCategory_GetPage_9CA985040FB0", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/BulletinCategory/PageAsc": { "get": { "tags": [ "BulletinCategory" ], "summary": "BulletinCategory: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: BulletinCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "BulletinCategory_GetPageAsc_03005433B2E8", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/BulletinCategory/PageBulletinCategorysByParent/{ParentId}/{IncludeSubNodes}/{TopParentsOnly}": { "get": { "tags": [ "BulletinCategory" ], "summary": "BulletinCategory: GetPageBulletinCategorysByParent", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: BulletinCategory-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "BulletinCategory_GetPageBulletinCategorysByParent_5AD712C10CC1", "parameters": [ { "name": "ParentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "IncludeSubNodes", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "TopParentsOnly", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/BulletinCategory/SearchByValue": { "post": { "tags": [ "BulletinCategory" ], "summary": "BulletinCategory: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: BulletinCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "BulletinCategory_SearchByValue_199A594E13A5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.BulletinCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.BulletinCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.BulletinCategory" } } } } } } }, "/api/BulletinCategory/TryGetByValue": { "post": { "tags": [ "BulletinCategory" ], "summary": "BulletinCategory: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: BulletinCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "BulletinCategory_TryGetByValue_1B899C5100DE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.BulletinCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.BulletinCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.BulletinCategory" } } } } } } }, "/api/BulletinCategory/UpsertGraph": { "put": { "tags": [ "BulletinCategory" ], "summary": "BulletinCategory: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: BulletinCategory-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "BulletinCategory_UpsertGraph_4EC7BD3F5A1F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.BulletinCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.BulletinCategory" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.BulletinCategory" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.BulletinCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.BulletinCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.BulletinCategory" } } } } } } }, "/api/BulletinCategory/UpsertGraphWithExtraFields": { "put": { "tags": [ "BulletinCategory" ], "summary": "BulletinCategory: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: BulletinCategory-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "BulletinCategory_UpsertGraphWithExtraFields_58F2C8847F30", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.BulletinCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.BulletinCategory" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.BulletinCategory" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.BulletinCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.BulletinCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.BulletinCategory" } } } } } } }, "/api/BulletinRead": { "get": { "tags": [ "BulletinRead" ], "summary": "BulletinRead: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: BulletinRead-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "BulletinRead_GetAll_34AED5DD3B6D", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.BulletinRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.BulletinRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.BulletinRead" } } } } } }, "post": { "tags": [ "BulletinRead" ], "summary": "BulletinRead: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: BulletinRead-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "BulletinRead_Post_ABC100CDA514", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.BulletinRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.BulletinRead" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.BulletinRead" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.BulletinRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.BulletinRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.BulletinRead" } } } } } }, "put": { "tags": [ "BulletinRead" ], "summary": "BulletinRead: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: BulletinRead-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "BulletinRead_Put_7DB2DEC1CB26", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.BulletinRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.BulletinRead" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.BulletinRead" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.BulletinRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.BulletinRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.BulletinRead" } } } } } } }, "/api/BulletinRead/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "BulletinRead" ], "summary": "BulletinRead: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: BulletinRead-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "BulletinRead_GetPageByValue_035E3700E7A0", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/BulletinRead/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "BulletinRead" ], "summary": "BulletinRead: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: BulletinRead-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "BulletinRead_GetPageByValue2_4B85828C4E22", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/BulletinRead/DeleteByFilter": { "post": { "tags": [ "BulletinRead" ], "summary": "BulletinRead: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: BulletinRead-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "BulletinRead_DeleteByFilter_4520E6C8918B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/BulletinRead/GetAllByValue": { "post": { "tags": [ "BulletinRead" ], "summary": "BulletinRead: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: BulletinRead-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "BulletinRead_GetAllByValue_38F654A878F3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.BulletinRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.BulletinRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.BulletinRead" } } } } } } }, "/api/BulletinRead/GetAllGraphByValue": { "post": { "tags": [ "BulletinRead" ], "summary": "BulletinRead: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: BulletinRead-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "BulletinRead_GetAllGraphByValue_418B1C67069B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.BulletinRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.BulletinRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.BulletinRead" } } } } } } }, "/api/BulletinRead/GetByValue": { "post": { "tags": [ "BulletinRead" ], "summary": "BulletinRead: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: BulletinRead-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "BulletinRead_GetByValue_BAE1368C0BD9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.BulletinRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.BulletinRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.BulletinRead" } } } } } } }, "/api/BulletinRead/GetLookup": { "post": { "tags": [ "BulletinRead" ], "summary": "BulletinRead: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: BulletinRead-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "BulletinRead_GetLookup_644F31F8485E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/BulletinRead/GetLookupByValue": { "post": { "tags": [ "BulletinRead" ], "summary": "BulletinRead: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: BulletinRead-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "BulletinRead_GetLookupByValue_6159AE7654EF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/BulletinRead/Page": { "get": { "tags": [ "BulletinRead" ], "summary": "BulletinRead: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: BulletinRead-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "BulletinRead_GetPage_A99B0E55996A", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/BulletinRead/PageAsc": { "get": { "tags": [ "BulletinRead" ], "summary": "BulletinRead: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: BulletinRead-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "BulletinRead_GetPageAsc_7729AC066032", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/BulletinRead/SearchByValue": { "post": { "tags": [ "BulletinRead" ], "summary": "BulletinRead: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: BulletinRead-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "BulletinRead_SearchByValue_3357770A6EC6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.BulletinRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.BulletinRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.BulletinRead" } } } } } } }, "/api/BulletinRead/TryGetByValue": { "post": { "tags": [ "BulletinRead" ], "summary": "BulletinRead: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: BulletinRead-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "BulletinRead_TryGetByValue_0CF2148BE571", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.BulletinRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.BulletinRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.BulletinRead" } } } } } } }, "/api/BulletinRead/UpsertGraph": { "put": { "tags": [ "BulletinRead" ], "summary": "BulletinRead: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: BulletinRead-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "BulletinRead_UpsertGraph_EC1947622BE9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.BulletinRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.BulletinRead" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.BulletinRead" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.BulletinRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.BulletinRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.BulletinRead" } } } } } } }, "/api/BulletinRead/UpsertGraphWithExtraFields": { "put": { "tags": [ "BulletinRead" ], "summary": "BulletinRead: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: BulletinRead-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "BulletinRead_UpsertGraphWithExtraFields_8480FA0DBE18", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.BulletinRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.BulletinRead" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.BulletinRead" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.BulletinRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.BulletinRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.BulletinRead" } } } } } } }, "/api/CalendarAppointment": { "get": { "tags": [ "CalendarAppointment" ], "summary": "CalendarAppointment: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarAppointment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarAppointment_GetAll_E041FDF494D1", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CalendarAppointment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CalendarAppointment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CalendarAppointment" } } } } } }, "post": { "tags": [ "CalendarAppointment" ], "summary": "CalendarAppointment: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarAppointment-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarAppointment_Post_29A1D5938AB8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarAppointment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarAppointment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarAppointment" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarAppointment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarAppointment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarAppointment" } } } } } }, "put": { "tags": [ "CalendarAppointment" ], "summary": "CalendarAppointment: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarAppointment-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarAppointment_Put_32C5EE2CD174", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarAppointment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarAppointment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarAppointment" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarAppointment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarAppointment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarAppointment" } } } } } } }, "/api/CalendarAppointment/{id}/AttendeeCount": { "get": { "tags": [ "CalendarAppointment" ], "summary": "CalendarAppointment: GetAttendeeCount", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarAppointment-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarAppointment_GetAttendeeCount_9E65CF7972D9", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/CalendarAppointment/{id}/Attendees": { "get": { "tags": [ "CalendarAppointment" ], "summary": "CalendarAppointment: GetAttendees", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarAppointment-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarAppointment_GetAttendees_06F9DEE29DED", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dto.CalendarInviteeSelectionDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dto.CalendarInviteeSelectionDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dto.CalendarInviteeSelectionDto" } } } } } } }, "/api/CalendarAppointment/{id}/AttendeeTracking": { "get": { "tags": [ "CalendarAppointment" ], "summary": "CalendarAppointment: GetAttendeeTracking", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarAppointment-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarAppointment_GetAttendeeTracking_37EBBB570C23", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Dto.CalendarAttendeeTrackingDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Dto.CalendarAttendeeTrackingDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Dto.CalendarAttendeeTrackingDto" } } } } } } }, "/api/CalendarAppointment/{id}/Delete": { "delete": { "tags": [ "CalendarAppointment" ], "summary": "CalendarAppointment: DeleteCalendarAppointment", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarAppointment-Delete.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarAppointment_DeleteCalendarAppointment_0DEF66BBEAC0", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "notifyAttendees", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "recurrenceId", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "cancellationMessage", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarAppointment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarAppointment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarAppointment" } } } } } } }, "/api/CalendarAppointment/{id}/Dismiss": { "post": { "tags": [ "CalendarAppointment" ], "summary": "CalendarAppointment: DismissReminder", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarAppointment-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarAppointment_DismissReminder_36140090DA7E", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/CalendarAppointment/{id}/MarkDone": { "post": { "tags": [ "CalendarAppointment" ], "summary": "CalendarAppointment: MarkReminderDone", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarAppointment-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarAppointment_MarkReminderDone_C4B66FB6BFBE", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/CalendarAppointment/{id}/RespondInvite/{response}": { "post": { "tags": [ "CalendarAppointment" ], "summary": "CalendarAppointment: RespondToInvitation", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarAppointment-Create.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarAppointment_RespondToInvitation_04DD17A43A78", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "response", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dto.EmailCalendarInviteStatusDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dto.EmailCalendarInviteStatusDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dto.EmailCalendarInviteStatusDto" } } } } } } }, "/api/CalendarAppointment/{id}/Snooze/{minutes}": { "post": { "tags": [ "CalendarAppointment" ], "summary": "CalendarAppointment: SnoozeReminder", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarAppointment-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarAppointment_SnoozeReminder_9C14953AC267", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "minutes", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Nullable_Of_System.DateTimeOffset" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Nullable_Of_System.DateTimeOffset" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Nullable_Of_System.DateTimeOffset" } } } } } } }, "/api/CalendarAppointment/{id}/Update": { "put": { "tags": [ "CalendarAppointment" ], "summary": "CalendarAppointment: UpdateCalendarAppointment", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarAppointment-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarAppointment_UpdateCalendarAppointment_711D2D611B20", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "notifyAttendees", "in": "query", "schema": { "type": "boolean", "default": false } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarAppointment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarAppointment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarAppointment" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarAppointment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarAppointment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarAppointment" } } } } } } }, "/api/CalendarAppointment/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "CalendarAppointment" ], "summary": "CalendarAppointment: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarAppointment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarAppointment_GetPageByValue_74CF0B8305DA", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CalendarAppointment/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "CalendarAppointment" ], "summary": "CalendarAppointment: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarAppointment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarAppointment_GetPageByValue2_F87F9DD80B8C", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CalendarAppointment/{showPast}/{showForeign}/{showDone}/PageFiltered": { "get": { "tags": [ "CalendarAppointment" ], "summary": "CalendarAppointment: GetPageFiltered", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarAppointment-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarAppointment_GetPageFiltered_87E1AA5AE46F", "parameters": [ { "name": "showPast", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "showForeign", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "showDone", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CalendarAppointment/CancelInvitees": { "post": { "tags": [ "CalendarAppointment" ], "summary": "CalendarAppointment: CancelInvitees", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarAppointment-Create.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarAppointment_CancelInvitees_68A720F7FE80", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Dto.CalendarCancelInviteesDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Dto.CalendarCancelInviteesDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Dto.CalendarCancelInviteesDto" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dto.CalendarInvitationResultDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dto.CalendarInvitationResultDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dto.CalendarInvitationResultDto" } } } } } } }, "/api/CalendarAppointment/CreateInvitationEmail": { "post": { "tags": [ "CalendarAppointment" ], "summary": "CalendarAppointment: CreateInvitationEmail", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarAppointment-Create.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarAppointment_CreateInvitationEmail_6ED253E64B64", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Dto.CalendarInvitationDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Dto.CalendarInvitationDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Dto.CalendarInvitationDto" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/CalendarAppointment/DeleteByFilter": { "post": { "tags": [ "CalendarAppointment" ], "summary": "CalendarAppointment: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarAppointment-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarAppointment_DeleteByFilter_7A21560EC488", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/CalendarAppointment/DueReminders": { "get": { "tags": [ "CalendarAppointment" ], "summary": "CalendarAppointment: GetDueReminders", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarAppointment-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarAppointment_GetDueReminders_88CC12F607A2", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CalendarAppointment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CalendarAppointment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CalendarAppointment" } } } } } } }, "/api/CalendarAppointment/GetAllByValue": { "post": { "tags": [ "CalendarAppointment" ], "summary": "CalendarAppointment: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarAppointment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarAppointment_GetAllByValue_237B04A9EDBE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CalendarAppointment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CalendarAppointment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CalendarAppointment" } } } } } } }, "/api/CalendarAppointment/GetAllGraphByValue": { "post": { "tags": [ "CalendarAppointment" ], "summary": "CalendarAppointment: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarAppointment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarAppointment_GetAllGraphByValue_5858BCE27DC4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CalendarAppointment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CalendarAppointment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CalendarAppointment" } } } } } } }, "/api/CalendarAppointment/GetByValue": { "post": { "tags": [ "CalendarAppointment" ], "summary": "CalendarAppointment: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarAppointment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarAppointment_GetByValue_231C4E461976", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarAppointment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarAppointment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarAppointment" } } } } } } }, "/api/CalendarAppointment/GetCalendars": { "get": { "tags": [ "CalendarAppointment" ], "summary": "CalendarAppointment: GetCalendars", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarAppointment-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarAppointment_GetCalendars_A76D2B398707", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarAppointment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarAppointment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarAppointment" } } } } } } }, "/api/CalendarAppointment/GetCalendarsByDateRange/{startDate}/{endDate}": { "get": { "tags": [ "CalendarAppointment" ], "summary": "CalendarAppointment: GetCalendarsByDateRange", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarAppointment-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarAppointment_GetCalendarsByDateRange_ED07E33F1412", "parameters": [ { "name": "startDate", "in": "path", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "endDate", "in": "path", "required": true, "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CalendarAppointment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CalendarAppointment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CalendarAppointment" } } } } } } }, "/api/CalendarAppointment/GetLookup": { "post": { "tags": [ "CalendarAppointment" ], "summary": "CalendarAppointment: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarAppointment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarAppointment_GetLookup_2D46AF8887CC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/CalendarAppointment/GetLookupByValue": { "post": { "tags": [ "CalendarAppointment" ], "summary": "CalendarAppointment: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarAppointment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarAppointment_GetLookupByValue_C5EA88DF8C95", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/CalendarAppointment/ImportIcs": { "post": { "tags": [ "CalendarAppointment" ], "summary": "CalendarAppointment: ImportIcs", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarAppointment-Create.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarAppointment_ImportIcs_C2CD6FE603A7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Dto.CalendarIcsImportRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Dto.CalendarIcsImportRequestDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Dto.CalendarIcsImportRequestDto" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dto.CalendarIcsImportResultDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dto.CalendarIcsImportResultDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dto.CalendarIcsImportResultDto" } } } } } } }, "/api/CalendarAppointment/Page": { "get": { "tags": [ "CalendarAppointment" ], "summary": "CalendarAppointment: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarAppointment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarAppointment_GetPage_7F0B5F21ED7B", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CalendarAppointment/PageAsc": { "get": { "tags": [ "CalendarAppointment" ], "summary": "CalendarAppointment: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarAppointment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarAppointment_GetPageAsc_FD60893C605E", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CalendarAppointment/Search": { "get": { "tags": [ "CalendarAppointment" ], "summary": "CalendarAppointment: Search", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarAppointment-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarAppointment_Search_2DADF17A8096", "parameters": [ { "name": "searchTerm", "in": "query", "schema": { "type": "string" } }, { "name": "maxResults", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 50 } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CalendarAppointment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CalendarAppointment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CalendarAppointment" } } } } } } }, "/api/CalendarAppointment/SearchByValue": { "post": { "tags": [ "CalendarAppointment" ], "summary": "CalendarAppointment: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarAppointment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarAppointment_SearchByValue_A15FE79111A2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CalendarAppointment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CalendarAppointment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CalendarAppointment" } } } } } } }, "/api/CalendarAppointment/SendInvitation": { "post": { "tags": [ "CalendarAppointment" ], "summary": "CalendarAppointment: SendInvitation", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarAppointment-Create.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarAppointment_SendInvitation_F0C9423D81BD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Dto.CalendarInvitationDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Dto.CalendarInvitationDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Dto.CalendarInvitationDto" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dto.CalendarInvitationResultDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dto.CalendarInvitationResultDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dto.CalendarInvitationResultDto" } } } } } } }, "/api/CalendarAppointment/TryGetByValue": { "post": { "tags": [ "CalendarAppointment" ], "summary": "CalendarAppointment: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarAppointment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarAppointment_TryGetByValue_80F309E65F44", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarAppointment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarAppointment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarAppointment" } } } } } } }, "/api/CalendarAppointment/UpsertGraph": { "put": { "tags": [ "CalendarAppointment" ], "summary": "CalendarAppointment: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarAppointment-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarAppointment_UpsertGraph_F1B0C9F1360B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarAppointment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarAppointment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarAppointment" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarAppointment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarAppointment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarAppointment" } } } } } } }, "/api/CalendarAppointment/UpsertGraphWithExtraFields": { "put": { "tags": [ "CalendarAppointment" ], "summary": "CalendarAppointment: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarAppointment-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarAppointment_UpsertGraphWithExtraFields_7D2DE5ED5099", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CalendarAppointment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CalendarAppointment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CalendarAppointment" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CalendarAppointment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CalendarAppointment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CalendarAppointment" } } } } } } }, "/api/CalendarAppointmentAttachment": { "get": { "tags": [ "CalendarAppointmentAttachment" ], "summary": "CalendarAppointmentAttachment: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarAppointmentAttachment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarAppointmentAttachment_GetAll_DC2B2D32FA22", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CalendarAppointmentAttachment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CalendarAppointmentAttachment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CalendarAppointmentAttachment" } } } } } }, "post": { "tags": [ "CalendarAppointmentAttachment" ], "summary": "CalendarAppointmentAttachment: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarAppointmentAttachment-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarAppointmentAttachment_Post_A993A9B4192E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarAppointmentAttachment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarAppointmentAttachment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarAppointmentAttachment" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarAppointmentAttachment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarAppointmentAttachment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarAppointmentAttachment" } } } } } }, "put": { "tags": [ "CalendarAppointmentAttachment" ], "summary": "CalendarAppointmentAttachment: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarAppointmentAttachment-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarAppointmentAttachment_Put_8B50D3AEE4B3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarAppointmentAttachment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarAppointmentAttachment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarAppointmentAttachment" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarAppointmentAttachment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarAppointmentAttachment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarAppointmentAttachment" } } } } } } }, "/api/CalendarAppointmentAttachment/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "CalendarAppointmentAttachment" ], "summary": "CalendarAppointmentAttachment: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarAppointmentAttachment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarAppointmentAttachment_GetPageByValue_B0E5347E09FB", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CalendarAppointmentAttachment/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "CalendarAppointmentAttachment" ], "summary": "CalendarAppointmentAttachment: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarAppointmentAttachment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarAppointmentAttachment_GetPageByValue2_D47FB9893B76", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CalendarAppointmentAttachment/DeleteAttachment/{CalendarAppointmentAttachmentId}": { "delete": { "tags": [ "CalendarAppointmentAttachment" ], "summary": "CalendarAppointmentAttachment: DeleteAttachment", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarAppointmentAttachment-Delete.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarAppointmentAttachment_DeleteAttachment_525B3A16FF37", "parameters": [ { "name": "CalendarAppointmentAttachmentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/CalendarAppointmentAttachment/DeleteByFilter": { "post": { "tags": [ "CalendarAppointmentAttachment" ], "summary": "CalendarAppointmentAttachment: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarAppointmentAttachment-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarAppointmentAttachment_DeleteByFilter_83ED91E3A258", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/CalendarAppointmentAttachment/DownloadCalendarAppointmentAttachment/{CalendarAppointmentAttachmentId}": { "get": { "tags": [ "CalendarAppointmentAttachment" ], "summary": "CalendarAppointmentAttachment: DownloadCalendarAppointmentAttachment", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarAppointmentAttachment-Read.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarAppointmentAttachment_DownloadCalendarAppointmentAttachment_FBC56A2FE36E", "parameters": [ { "name": "CalendarAppointmentAttachmentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CalendarAppointmentAttachment/GetAllByValue": { "post": { "tags": [ "CalendarAppointmentAttachment" ], "summary": "CalendarAppointmentAttachment: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarAppointmentAttachment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarAppointmentAttachment_GetAllByValue_4395572A81B9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CalendarAppointmentAttachment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CalendarAppointmentAttachment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CalendarAppointmentAttachment" } } } } } } }, "/api/CalendarAppointmentAttachment/GetAllGraphByValue": { "post": { "tags": [ "CalendarAppointmentAttachment" ], "summary": "CalendarAppointmentAttachment: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarAppointmentAttachment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarAppointmentAttachment_GetAllGraphByValue_93834841254F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CalendarAppointmentAttachment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CalendarAppointmentAttachment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CalendarAppointmentAttachment" } } } } } } }, "/api/CalendarAppointmentAttachment/GetAttachments/{CalendarAppointmentId}": { "get": { "tags": [ "CalendarAppointmentAttachment" ], "summary": "CalendarAppointmentAttachment: GetAttachments", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarAppointmentAttachment-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarAppointmentAttachment_GetAttachments_F12476D19587", "parameters": [ { "name": "CalendarAppointmentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Dto.CalendarAttachmentDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Dto.CalendarAttachmentDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Dto.CalendarAttachmentDto" } } } } } } }, "/api/CalendarAppointmentAttachment/GetByValue": { "post": { "tags": [ "CalendarAppointmentAttachment" ], "summary": "CalendarAppointmentAttachment: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarAppointmentAttachment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarAppointmentAttachment_GetByValue_8D0F4635CAE2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarAppointmentAttachment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarAppointmentAttachment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarAppointmentAttachment" } } } } } } }, "/api/CalendarAppointmentAttachment/GetLookup": { "post": { "tags": [ "CalendarAppointmentAttachment" ], "summary": "CalendarAppointmentAttachment: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarAppointmentAttachment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarAppointmentAttachment_GetLookup_ABBEE7DB7D31", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/CalendarAppointmentAttachment/GetLookupByValue": { "post": { "tags": [ "CalendarAppointmentAttachment" ], "summary": "CalendarAppointmentAttachment: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarAppointmentAttachment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarAppointmentAttachment_GetLookupByValue_741B94BA83C5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/CalendarAppointmentAttachment/Page": { "get": { "tags": [ "CalendarAppointmentAttachment" ], "summary": "CalendarAppointmentAttachment: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarAppointmentAttachment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarAppointmentAttachment_GetPage_AA86D2675C26", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CalendarAppointmentAttachment/PageAsc": { "get": { "tags": [ "CalendarAppointmentAttachment" ], "summary": "CalendarAppointmentAttachment: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarAppointmentAttachment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarAppointmentAttachment_GetPageAsc_FF1CAA0D7B3E", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CalendarAppointmentAttachment/SearchByValue": { "post": { "tags": [ "CalendarAppointmentAttachment" ], "summary": "CalendarAppointmentAttachment: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarAppointmentAttachment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarAppointmentAttachment_SearchByValue_221BC56C0DAA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CalendarAppointmentAttachment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CalendarAppointmentAttachment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CalendarAppointmentAttachment" } } } } } } }, "/api/CalendarAppointmentAttachment/TryGetByValue": { "post": { "tags": [ "CalendarAppointmentAttachment" ], "summary": "CalendarAppointmentAttachment: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarAppointmentAttachment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarAppointmentAttachment_TryGetByValue_E459FE0F049D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarAppointmentAttachment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarAppointmentAttachment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarAppointmentAttachment" } } } } } } }, "/api/CalendarAppointmentAttachment/UploadChunkFile/{CalendarAppointmentId}": { "post": { "tags": [ "CalendarAppointmentAttachment" ], "summary": "CalendarAppointmentAttachment: UploadChunkFile", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarAppointmentAttachment-Create.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarAppointmentAttachment_UploadChunkFile_7EC6946C10D7", "parameters": [ { "name": "CalendarAppointmentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "fileChunk": { "type": "string", "format": "binary" } } }, "encoding": { "fileChunk": { "style": "form" } } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/CalendarAppointmentAttachment/UpsertGraph": { "put": { "tags": [ "CalendarAppointmentAttachment" ], "summary": "CalendarAppointmentAttachment: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarAppointmentAttachment-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarAppointmentAttachment_UpsertGraph_1ECC9B499218", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarAppointmentAttachment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarAppointmentAttachment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarAppointmentAttachment" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarAppointmentAttachment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarAppointmentAttachment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarAppointmentAttachment" } } } } } } }, "/api/CalendarAppointmentAttachment/UpsertGraphWithExtraFields": { "put": { "tags": [ "CalendarAppointmentAttachment" ], "summary": "CalendarAppointmentAttachment: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarAppointmentAttachment-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarAppointmentAttachment_UpsertGraphWithExtraFields_57B98A2AFEB3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CalendarAppointmentAttachment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CalendarAppointmentAttachment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CalendarAppointmentAttachment" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CalendarAppointmentAttachment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CalendarAppointmentAttachment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CalendarAppointmentAttachment" } } } } } } }, "/api/CalendarAppointmentCategory": { "get": { "tags": [ "CalendarAppointmentCategory" ], "summary": "CalendarAppointmentCategory: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarAppointmentCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarAppointmentCategory_GetAll_CB861872EB73", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CalendarAppointmentCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CalendarAppointmentCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CalendarAppointmentCategory" } } } } } }, "post": { "tags": [ "CalendarAppointmentCategory" ], "summary": "CalendarAppointmentCategory: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarAppointmentCategory-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarAppointmentCategory_Post_F1F35F32165F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarAppointmentCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarAppointmentCategory" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarAppointmentCategory" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarAppointmentCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarAppointmentCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarAppointmentCategory" } } } } } }, "put": { "tags": [ "CalendarAppointmentCategory" ], "summary": "CalendarAppointmentCategory: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarAppointmentCategory-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarAppointmentCategory_Put_8C4A2EABB0BC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarAppointmentCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarAppointmentCategory" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarAppointmentCategory" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarAppointmentCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarAppointmentCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarAppointmentCategory" } } } } } } }, "/api/CalendarAppointmentCategory/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "CalendarAppointmentCategory" ], "summary": "CalendarAppointmentCategory: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarAppointmentCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarAppointmentCategory_GetPageByValue_9ABF21A0F665", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CalendarAppointmentCategory/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "CalendarAppointmentCategory" ], "summary": "CalendarAppointmentCategory: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarAppointmentCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarAppointmentCategory_GetPageByValue2_0DDBE9A2E14E", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CalendarAppointmentCategory/DeleteByFilter": { "post": { "tags": [ "CalendarAppointmentCategory" ], "summary": "CalendarAppointmentCategory: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarAppointmentCategory-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarAppointmentCategory_DeleteByFilter_ECCCFEC6AF7F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/CalendarAppointmentCategory/GetAllByValue": { "post": { "tags": [ "CalendarAppointmentCategory" ], "summary": "CalendarAppointmentCategory: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarAppointmentCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarAppointmentCategory_GetAllByValue_7B35198837E1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CalendarAppointmentCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CalendarAppointmentCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CalendarAppointmentCategory" } } } } } } }, "/api/CalendarAppointmentCategory/GetAllGraphByValue": { "post": { "tags": [ "CalendarAppointmentCategory" ], "summary": "CalendarAppointmentCategory: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarAppointmentCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarAppointmentCategory_GetAllGraphByValue_D09FA6FF09C9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CalendarAppointmentCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CalendarAppointmentCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CalendarAppointmentCategory" } } } } } } }, "/api/CalendarAppointmentCategory/GetByValue": { "post": { "tags": [ "CalendarAppointmentCategory" ], "summary": "CalendarAppointmentCategory: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarAppointmentCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarAppointmentCategory_GetByValue_FB5F1685ABC9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarAppointmentCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarAppointmentCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarAppointmentCategory" } } } } } } }, "/api/CalendarAppointmentCategory/GetLookup": { "post": { "tags": [ "CalendarAppointmentCategory" ], "summary": "CalendarAppointmentCategory: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarAppointmentCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarAppointmentCategory_GetLookup_D0A3CDE561CB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/CalendarAppointmentCategory/GetLookupByValue": { "post": { "tags": [ "CalendarAppointmentCategory" ], "summary": "CalendarAppointmentCategory: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarAppointmentCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarAppointmentCategory_GetLookupByValue_ED136E925FF6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/CalendarAppointmentCategory/Page": { "get": { "tags": [ "CalendarAppointmentCategory" ], "summary": "CalendarAppointmentCategory: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarAppointmentCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarAppointmentCategory_GetPage_AB7B1F4F4BE5", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CalendarAppointmentCategory/PageAsc": { "get": { "tags": [ "CalendarAppointmentCategory" ], "summary": "CalendarAppointmentCategory: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarAppointmentCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarAppointmentCategory_GetPageAsc_C239D46FCFE9", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CalendarAppointmentCategory/SearchByValue": { "post": { "tags": [ "CalendarAppointmentCategory" ], "summary": "CalendarAppointmentCategory: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarAppointmentCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarAppointmentCategory_SearchByValue_F5A132D0F491", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CalendarAppointmentCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CalendarAppointmentCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CalendarAppointmentCategory" } } } } } } }, "/api/CalendarAppointmentCategory/TryGetByValue": { "post": { "tags": [ "CalendarAppointmentCategory" ], "summary": "CalendarAppointmentCategory: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarAppointmentCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarAppointmentCategory_TryGetByValue_425D12F405FB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarAppointmentCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarAppointmentCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarAppointmentCategory" } } } } } } }, "/api/CalendarAppointmentCategory/UpsertGraph": { "put": { "tags": [ "CalendarAppointmentCategory" ], "summary": "CalendarAppointmentCategory: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarAppointmentCategory-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarAppointmentCategory_UpsertGraph_2DB57FE9BB61", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarAppointmentCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarAppointmentCategory" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarAppointmentCategory" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarAppointmentCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarAppointmentCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarAppointmentCategory" } } } } } } }, "/api/CalendarAppointmentCategory/UpsertGraphWithExtraFields": { "put": { "tags": [ "CalendarAppointmentCategory" ], "summary": "CalendarAppointmentCategory: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarAppointmentCategory-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarAppointmentCategory_UpsertGraphWithExtraFields_22EFDC1716A2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CalendarAppointmentCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CalendarAppointmentCategory" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CalendarAppointmentCategory" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CalendarAppointmentCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CalendarAppointmentCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CalendarAppointmentCategory" } } } } } } }, "/api/CalendarHoliday": { "get": { "tags": [ "CalendarHoliday" ], "summary": "CalendarHoliday: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarHoliday-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarHoliday_GetAll_882CAB9B924C", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CalendarHoliday" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CalendarHoliday" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CalendarHoliday" } } } } } }, "post": { "tags": [ "CalendarHoliday" ], "summary": "CalendarHoliday: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarHoliday-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarHoliday_Post_ED492E2FDDF3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarHoliday" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarHoliday" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarHoliday" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarHoliday" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarHoliday" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarHoliday" } } } } } }, "put": { "tags": [ "CalendarHoliday" ], "summary": "CalendarHoliday: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarHoliday-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarHoliday_Put_A35783BABD46", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarHoliday" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarHoliday" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarHoliday" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarHoliday" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarHoliday" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarHoliday" } } } } } } }, "/api/CalendarHoliday/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "CalendarHoliday" ], "summary": "CalendarHoliday: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarHoliday-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarHoliday_GetPageByValue_A3BF4F2AA15E", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CalendarHoliday/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "CalendarHoliday" ], "summary": "CalendarHoliday: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarHoliday-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarHoliday_GetPageByValue2_9952B0F35AFA", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CalendarHoliday/DeleteByFilter": { "post": { "tags": [ "CalendarHoliday" ], "summary": "CalendarHoliday: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarHoliday-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarHoliday_DeleteByFilter_61A0AD443317", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/CalendarHoliday/GetAllByValue": { "post": { "tags": [ "CalendarHoliday" ], "summary": "CalendarHoliday: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarHoliday-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarHoliday_GetAllByValue_4AB62BCB9A79", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CalendarHoliday" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CalendarHoliday" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CalendarHoliday" } } } } } } }, "/api/CalendarHoliday/GetAllGraphByValue": { "post": { "tags": [ "CalendarHoliday" ], "summary": "CalendarHoliday: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarHoliday-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarHoliday_GetAllGraphByValue_99865F17B4FF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CalendarHoliday" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CalendarHoliday" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CalendarHoliday" } } } } } } }, "/api/CalendarHoliday/GetByValue": { "post": { "tags": [ "CalendarHoliday" ], "summary": "CalendarHoliday: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarHoliday-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarHoliday_GetByValue_9EFEE58A12B3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarHoliday" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarHoliday" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarHoliday" } } } } } } }, "/api/CalendarHoliday/GetLookup": { "post": { "tags": [ "CalendarHoliday" ], "summary": "CalendarHoliday: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarHoliday-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarHoliday_GetLookup_D0E5BDF42373", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/CalendarHoliday/GetLookupByValue": { "post": { "tags": [ "CalendarHoliday" ], "summary": "CalendarHoliday: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarHoliday-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarHoliday_GetLookupByValue_3B078038336E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/CalendarHoliday/Page": { "get": { "tags": [ "CalendarHoliday" ], "summary": "CalendarHoliday: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarHoliday-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarHoliday_GetPage_CA638E0C2180", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CalendarHoliday/PageAsc": { "get": { "tags": [ "CalendarHoliday" ], "summary": "CalendarHoliday: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarHoliday-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarHoliday_GetPageAsc_73199E42B7DE", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CalendarHoliday/SearchByValue": { "post": { "tags": [ "CalendarHoliday" ], "summary": "CalendarHoliday: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarHoliday-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarHoliday_SearchByValue_791D396D488F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CalendarHoliday" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CalendarHoliday" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CalendarHoliday" } } } } } } }, "/api/CalendarHoliday/TryGetByValue": { "post": { "tags": [ "CalendarHoliday" ], "summary": "CalendarHoliday: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarHoliday-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarHoliday_TryGetByValue_6F58E29B5D7B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarHoliday" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarHoliday" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarHoliday" } } } } } } }, "/api/CalendarHoliday/UpsertGraph": { "put": { "tags": [ "CalendarHoliday" ], "summary": "CalendarHoliday: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarHoliday-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarHoliday_UpsertGraph_AFCDBC6FF601", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarHoliday" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarHoliday" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarHoliday" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarHoliday" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarHoliday" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarHoliday" } } } } } } }, "/api/CalendarHoliday/UpsertGraphWithExtraFields": { "put": { "tags": [ "CalendarHoliday" ], "summary": "CalendarHoliday: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarHoliday-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarHoliday_UpsertGraphWithExtraFields_433C1E3BFEBB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CalendarHoliday" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CalendarHoliday" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CalendarHoliday" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CalendarHoliday" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CalendarHoliday" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CalendarHoliday" } } } } } } }, "/api/CalendarName": { "get": { "tags": [ "CalendarName" ], "summary": "CalendarName: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarName_GetAll_9E06AC639720", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CalendarName" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CalendarName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CalendarName" } } } } } }, "post": { "tags": [ "CalendarName" ], "summary": "CalendarName: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarName-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarName_Post_C4DA2E8DE2D3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarName" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarName" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarName" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarName" } } } } } }, "put": { "tags": [ "CalendarName" ], "summary": "CalendarName: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarName-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarName_Put_58E4A7F90F6D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarName" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarName" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarName" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarName" } } } } } } }, "/api/CalendarName/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "CalendarName" ], "summary": "CalendarName: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarName_GetPageByValue_97C45903BC13", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CalendarName/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "CalendarName" ], "summary": "CalendarName: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarName_GetPageByValue2_B0950C4E176A", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CalendarName/DeleteByFilter": { "post": { "tags": [ "CalendarName" ], "summary": "CalendarName: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarName-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarName_DeleteByFilter_9FA88FCBD622", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/CalendarName/GetAllByValue": { "post": { "tags": [ "CalendarName" ], "summary": "CalendarName: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarName_GetAllByValue_3EDDCA215109", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CalendarName" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CalendarName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CalendarName" } } } } } } }, "/api/CalendarName/GetAllGraphByValue": { "post": { "tags": [ "CalendarName" ], "summary": "CalendarName: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarName_GetAllGraphByValue_3865C207E358", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CalendarName" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CalendarName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CalendarName" } } } } } } }, "/api/CalendarName/GetByValue": { "post": { "tags": [ "CalendarName" ], "summary": "CalendarName: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarName_GetByValue_E6AB61B6220C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarName" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarName" } } } } } } }, "/api/CalendarName/GetLookup": { "post": { "tags": [ "CalendarName" ], "summary": "CalendarName: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarName_GetLookup_FCAD69521726", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/CalendarName/GetLookupByValue": { "post": { "tags": [ "CalendarName" ], "summary": "CalendarName: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarName_GetLookupByValue_36727203A79F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/CalendarName/Page": { "get": { "tags": [ "CalendarName" ], "summary": "CalendarName: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarName_GetPage_1AC2D90A4A83", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CalendarName/PageAsc": { "get": { "tags": [ "CalendarName" ], "summary": "CalendarName: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarName_GetPageAsc_054E20CA09DB", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CalendarName/SearchByValue": { "post": { "tags": [ "CalendarName" ], "summary": "CalendarName: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarName_SearchByValue_996F3E72F55B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CalendarName" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CalendarName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CalendarName" } } } } } } }, "/api/CalendarName/TryGetByValue": { "post": { "tags": [ "CalendarName" ], "summary": "CalendarName: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarName_TryGetByValue_C72D6AAA5F86", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarName" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarName" } } } } } } }, "/api/CalendarName/UpsertGraph": { "put": { "tags": [ "CalendarName" ], "summary": "CalendarName: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarName-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarName_UpsertGraph_85D305C49422", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarName" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarName" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarName" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarName" } } } } } } }, "/api/CalendarName/UpsertGraphWithExtraFields": { "put": { "tags": [ "CalendarName" ], "summary": "CalendarName: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarName-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarName_UpsertGraphWithExtraFields_030178AC67D4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CalendarName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CalendarName" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CalendarName" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CalendarName" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CalendarName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CalendarName" } } } } } } }, "/api/CalendarWeekDay": { "get": { "tags": [ "CalendarWeekDay" ], "summary": "CalendarWeekDay: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarWeekDay-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarWeekDay_GetAll_5F96A5352E47", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CalendarWeekDay" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CalendarWeekDay" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CalendarWeekDay" } } } } } }, "post": { "tags": [ "CalendarWeekDay" ], "summary": "CalendarWeekDay: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarWeekDay-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarWeekDay_Post_A31DF6CA152C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarWeekDay" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarWeekDay" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarWeekDay" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarWeekDay" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarWeekDay" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarWeekDay" } } } } } }, "put": { "tags": [ "CalendarWeekDay" ], "summary": "CalendarWeekDay: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarWeekDay-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarWeekDay_Put_4E9BC76D88BC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarWeekDay" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarWeekDay" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarWeekDay" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarWeekDay" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarWeekDay" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarWeekDay" } } } } } } }, "/api/CalendarWeekDay/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "CalendarWeekDay" ], "summary": "CalendarWeekDay: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarWeekDay-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarWeekDay_GetPageByValue_AAA39D9C13F5", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CalendarWeekDay/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "CalendarWeekDay" ], "summary": "CalendarWeekDay: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarWeekDay-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarWeekDay_GetPageByValue2_D7BE31985F32", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CalendarWeekDay/DeleteByFilter": { "post": { "tags": [ "CalendarWeekDay" ], "summary": "CalendarWeekDay: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarWeekDay-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarWeekDay_DeleteByFilter_63F77EE17042", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/CalendarWeekDay/GetAllByValue": { "post": { "tags": [ "CalendarWeekDay" ], "summary": "CalendarWeekDay: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarWeekDay-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarWeekDay_GetAllByValue_0FEAB9405723", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CalendarWeekDay" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CalendarWeekDay" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CalendarWeekDay" } } } } } } }, "/api/CalendarWeekDay/GetAllGraphByValue": { "post": { "tags": [ "CalendarWeekDay" ], "summary": "CalendarWeekDay: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarWeekDay-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarWeekDay_GetAllGraphByValue_A716CA8D0C34", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CalendarWeekDay" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CalendarWeekDay" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CalendarWeekDay" } } } } } } }, "/api/CalendarWeekDay/GetByValue": { "post": { "tags": [ "CalendarWeekDay" ], "summary": "CalendarWeekDay: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarWeekDay-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarWeekDay_GetByValue_450296EFA7E6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarWeekDay" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarWeekDay" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarWeekDay" } } } } } } }, "/api/CalendarWeekDay/GetLookup": { "post": { "tags": [ "CalendarWeekDay" ], "summary": "CalendarWeekDay: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarWeekDay-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarWeekDay_GetLookup_9AEF0E1C5EFB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/CalendarWeekDay/GetLookupByValue": { "post": { "tags": [ "CalendarWeekDay" ], "summary": "CalendarWeekDay: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarWeekDay-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarWeekDay_GetLookupByValue_155B62D799F4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/CalendarWeekDay/Page": { "get": { "tags": [ "CalendarWeekDay" ], "summary": "CalendarWeekDay: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarWeekDay-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarWeekDay_GetPage_133BA577612B", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CalendarWeekDay/PageAsc": { "get": { "tags": [ "CalendarWeekDay" ], "summary": "CalendarWeekDay: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarWeekDay-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarWeekDay_GetPageAsc_5BF9877ACEDF", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CalendarWeekDay/SearchByValue": { "post": { "tags": [ "CalendarWeekDay" ], "summary": "CalendarWeekDay: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarWeekDay-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarWeekDay_SearchByValue_3860A00A8F1B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CalendarWeekDay" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CalendarWeekDay" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CalendarWeekDay" } } } } } } }, "/api/CalendarWeekDay/TryGetByValue": { "post": { "tags": [ "CalendarWeekDay" ], "summary": "CalendarWeekDay: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarWeekDay-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarWeekDay_TryGetByValue_97BE53F2B48D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarWeekDay" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarWeekDay" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarWeekDay" } } } } } } }, "/api/CalendarWeekDay/UpsertGraph": { "put": { "tags": [ "CalendarWeekDay" ], "summary": "CalendarWeekDay: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarWeekDay-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarWeekDay_UpsertGraph_7C1B42E78224", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarWeekDay" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarWeekDay" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarWeekDay" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarWeekDay" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarWeekDay" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarWeekDay" } } } } } } }, "/api/CalendarWeekDay/UpsertGraphWithExtraFields": { "put": { "tags": [ "CalendarWeekDay" ], "summary": "CalendarWeekDay: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarWeekDay-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarWeekDay_UpsertGraphWithExtraFields_DACF4339C9C9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CalendarWeekDay" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CalendarWeekDay" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CalendarWeekDay" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CalendarWeekDay" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CalendarWeekDay" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CalendarWeekDay" } } } } } } }, "/api/CalendarWorkingDay": { "get": { "tags": [ "CalendarWorkingDay" ], "summary": "CalendarWorkingDay: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarWorkingDay-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarWorkingDay_GetAll_857E01FE5212", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CalendarWorkingDay" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CalendarWorkingDay" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CalendarWorkingDay" } } } } } }, "post": { "tags": [ "CalendarWorkingDay" ], "summary": "CalendarWorkingDay: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarWorkingDay-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarWorkingDay_Post_14A6EA2EEB2A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarWorkingDay" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarWorkingDay" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarWorkingDay" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarWorkingDay" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarWorkingDay" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarWorkingDay" } } } } } }, "put": { "tags": [ "CalendarWorkingDay" ], "summary": "CalendarWorkingDay: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarWorkingDay-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarWorkingDay_Put_B2FE27649925", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarWorkingDay" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarWorkingDay" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarWorkingDay" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarWorkingDay" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarWorkingDay" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarWorkingDay" } } } } } } }, "/api/CalendarWorkingDay/{date}/GetCalendarInfo": { "get": { "tags": [ "CalendarWorkingDay" ], "summary": "CalendarWorkingDay: GetCalendarInfo", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarWorkingDay-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarWorkingDay_GetCalendarInfo_7B58AA1910DE", "parameters": [ { "name": "date", "in": "path", "required": true, "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CalendarWorkingDay" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CalendarWorkingDay" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CalendarWorkingDay" } } } } } } }, "/api/CalendarWorkingDay/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "CalendarWorkingDay" ], "summary": "CalendarWorkingDay: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarWorkingDay-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarWorkingDay_GetPageByValue_DC3ACAD3E606", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CalendarWorkingDay/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "CalendarWorkingDay" ], "summary": "CalendarWorkingDay: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarWorkingDay-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarWorkingDay_GetPageByValue2_C17CDBF0CEFD", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CalendarWorkingDay/DeleteByFilter": { "post": { "tags": [ "CalendarWorkingDay" ], "summary": "CalendarWorkingDay: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarWorkingDay-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarWorkingDay_DeleteByFilter_1B0E4745217E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/CalendarWorkingDay/GetAllByValue": { "post": { "tags": [ "CalendarWorkingDay" ], "summary": "CalendarWorkingDay: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarWorkingDay-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarWorkingDay_GetAllByValue_62A7B5EF046A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CalendarWorkingDay" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CalendarWorkingDay" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CalendarWorkingDay" } } } } } } }, "/api/CalendarWorkingDay/GetAllGraphByValue": { "post": { "tags": [ "CalendarWorkingDay" ], "summary": "CalendarWorkingDay: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarWorkingDay-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarWorkingDay_GetAllGraphByValue_CDF4A14048DF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CalendarWorkingDay" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CalendarWorkingDay" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CalendarWorkingDay" } } } } } } }, "/api/CalendarWorkingDay/GetByValue": { "post": { "tags": [ "CalendarWorkingDay" ], "summary": "CalendarWorkingDay: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarWorkingDay-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarWorkingDay_GetByValue_B338177562AB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarWorkingDay" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarWorkingDay" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarWorkingDay" } } } } } } }, "/api/CalendarWorkingDay/GetCalendarDaysInfo": { "post": { "tags": [ "CalendarWorkingDay" ], "summary": "CalendarWorkingDay: GetCalendarDaysInfo", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarWorkingDay-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarWorkingDay_GetCalendarDaysInfo_B609622BB34F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Client.ApiClients.CalendarInfoRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Client.ApiClients.CalendarInfoRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Client.ApiClients.CalendarInfoRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CalendarWorkingDay" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CalendarWorkingDay" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CalendarWorkingDay" } } } } } } }, "/api/CalendarWorkingDay/GetLookup": { "post": { "tags": [ "CalendarWorkingDay" ], "summary": "CalendarWorkingDay: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarWorkingDay-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarWorkingDay_GetLookup_8FA7A92FBDE7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/CalendarWorkingDay/GetLookupByValue": { "post": { "tags": [ "CalendarWorkingDay" ], "summary": "CalendarWorkingDay: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarWorkingDay-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarWorkingDay_GetLookupByValue_3107456EDEDE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/CalendarWorkingDay/Page": { "get": { "tags": [ "CalendarWorkingDay" ], "summary": "CalendarWorkingDay: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarWorkingDay-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarWorkingDay_GetPage_72EE918E6BC9", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CalendarWorkingDay/PageAsc": { "get": { "tags": [ "CalendarWorkingDay" ], "summary": "CalendarWorkingDay: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarWorkingDay-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarWorkingDay_GetPageAsc_074CB1B6AF51", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CalendarWorkingDay/RunWizard": { "post": { "tags": [ "CalendarWorkingDay" ], "summary": "CalendarWorkingDay: RunWizard", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarWorkingDay-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarWorkingDay_RunWizard_07508FAAACDD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarWorkingDay_RunWizardRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarWorkingDay_RunWizardRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarWorkingDay_RunWizardRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/CalendarWorkingDay/SearchByValue": { "post": { "tags": [ "CalendarWorkingDay" ], "summary": "CalendarWorkingDay: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarWorkingDay-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarWorkingDay_SearchByValue_A80C14B8ABAC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CalendarWorkingDay" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CalendarWorkingDay" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CalendarWorkingDay" } } } } } } }, "/api/CalendarWorkingDay/TryGetByValue": { "post": { "tags": [ "CalendarWorkingDay" ], "summary": "CalendarWorkingDay: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarWorkingDay-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarWorkingDay_TryGetByValue_48AA6A207177", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarWorkingDay" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarWorkingDay" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarWorkingDay" } } } } } } }, "/api/CalendarWorkingDay/UpsertGraph": { "put": { "tags": [ "CalendarWorkingDay" ], "summary": "CalendarWorkingDay: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarWorkingDay-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarWorkingDay_UpsertGraph_63FA91639A55", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarWorkingDay" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarWorkingDay" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarWorkingDay" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarWorkingDay" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarWorkingDay" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarWorkingDay" } } } } } } }, "/api/CalendarWorkingDay/UpsertGraphWithExtraFields": { "put": { "tags": [ "CalendarWorkingDay" ], "summary": "CalendarWorkingDay: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CalendarWorkingDay-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CalendarWorkingDay_UpsertGraphWithExtraFields_10937000025E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CalendarWorkingDay" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CalendarWorkingDay" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CalendarWorkingDay" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CalendarWorkingDay" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CalendarWorkingDay" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CalendarWorkingDay" } } } } } } }, "/api/ClientLog/LogError": { "post": { "tags": [ "ClientLog" ], "summary": "ClientLog: LogError", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ClientLog-Create.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ClientLog_LogError_F3A8F9AB7820", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ClientLogEntryDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ClientLogEntryDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ClientLogEntryDto" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/CountryPackageDatevExport": { "get": { "tags": [ "CountryPackageDatevExport" ], "summary": "CountryPackageDatevExport: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageDatevExport-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageDatevExport_GetAll_B27B8EAD2AB6", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageDatevExport" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageDatevExport" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageDatevExport" } } } } } }, "post": { "tags": [ "CountryPackageDatevExport" ], "summary": "CountryPackageDatevExport: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageDatevExport-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageDatevExport_Post_3065D7546CE6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageDatevExport" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageDatevExport" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageDatevExport" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageDatevExport" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageDatevExport" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageDatevExport" } } } } } }, "put": { "tags": [ "CountryPackageDatevExport" ], "summary": "CountryPackageDatevExport: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageDatevExport-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageDatevExport_Put_A9C89FE69FBA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageDatevExport" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageDatevExport" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageDatevExport" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageDatevExport" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageDatevExport" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageDatevExport" } } } } } } }, "/api/CountryPackageDatevExport/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "CountryPackageDatevExport" ], "summary": "CountryPackageDatevExport: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageDatevExport-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageDatevExport_GetPageByValue_34D499142084", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CountryPackageDatevExport/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "CountryPackageDatevExport" ], "summary": "CountryPackageDatevExport: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageDatevExport-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageDatevExport_GetPageByValue2_EAD2FAFC208E", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CountryPackageDatevExport/DeleteByFilter": { "post": { "tags": [ "CountryPackageDatevExport" ], "summary": "CountryPackageDatevExport: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageDatevExport-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageDatevExport_DeleteByFilter_2051188DB977", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/CountryPackageDatevExport/GetAllByValue": { "post": { "tags": [ "CountryPackageDatevExport" ], "summary": "CountryPackageDatevExport: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageDatevExport-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageDatevExport_GetAllByValue_15561C183F52", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageDatevExport" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageDatevExport" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageDatevExport" } } } } } } }, "/api/CountryPackageDatevExport/GetAllGraphByValue": { "post": { "tags": [ "CountryPackageDatevExport" ], "summary": "CountryPackageDatevExport: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageDatevExport-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageDatevExport_GetAllGraphByValue_C0C9206B47D9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageDatevExport" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageDatevExport" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageDatevExport" } } } } } } }, "/api/CountryPackageDatevExport/GetByValue": { "post": { "tags": [ "CountryPackageDatevExport" ], "summary": "CountryPackageDatevExport: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageDatevExport-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageDatevExport_GetByValue_DEACCE2DA321", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageDatevExport" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageDatevExport" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageDatevExport" } } } } } } }, "/api/CountryPackageDatevExport/GetLookup": { "post": { "tags": [ "CountryPackageDatevExport" ], "summary": "CountryPackageDatevExport: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageDatevExport-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageDatevExport_GetLookup_D6769B6B8789", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/CountryPackageDatevExport/GetLookupByValue": { "post": { "tags": [ "CountryPackageDatevExport" ], "summary": "CountryPackageDatevExport: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageDatevExport-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageDatevExport_GetLookupByValue_3FDBE1681A72", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/CountryPackageDatevExport/Page": { "get": { "tags": [ "CountryPackageDatevExport" ], "summary": "CountryPackageDatevExport: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageDatevExport-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageDatevExport_GetPage_2AFB8716B9BE", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CountryPackageDatevExport/PageAsc": { "get": { "tags": [ "CountryPackageDatevExport" ], "summary": "CountryPackageDatevExport: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageDatevExport-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageDatevExport_GetPageAsc_2D63A70588A6", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CountryPackageDatevExport/SearchByValue": { "post": { "tags": [ "CountryPackageDatevExport" ], "summary": "CountryPackageDatevExport: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageDatevExport-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageDatevExport_SearchByValue_58797F6E3AD5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CountryPackageDatevExport" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CountryPackageDatevExport" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CountryPackageDatevExport" } } } } } } }, "/api/CountryPackageDatevExport/TryGetByValue": { "post": { "tags": [ "CountryPackageDatevExport" ], "summary": "CountryPackageDatevExport: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageDatevExport-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageDatevExport_TryGetByValue_D0FA9E3E8057", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageDatevExport" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageDatevExport" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageDatevExport" } } } } } } }, "/api/CountryPackageDatevExport/UpsertGraph": { "put": { "tags": [ "CountryPackageDatevExport" ], "summary": "CountryPackageDatevExport: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageDatevExport-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageDatevExport_UpsertGraph_BB9C7E5C097D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageDatevExport" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageDatevExport" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageDatevExport" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageDatevExport" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageDatevExport" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageDatevExport" } } } } } } }, "/api/CountryPackageDatevExport/UpsertGraphWithExtraFields": { "put": { "tags": [ "CountryPackageDatevExport" ], "summary": "CountryPackageDatevExport: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageDatevExport-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageDatevExport_UpsertGraphWithExtraFields_CA38BCCEAC3E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageDatevExport" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageDatevExport" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageDatevExport" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageDatevExport" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageDatevExport" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageDatevExport" } } } } } } }, "/api/CountryPackageElsterExport": { "get": { "tags": [ "CountryPackageElsterExport" ], "summary": "CountryPackageElsterExport: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageElsterExport-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageElsterExport_GetAll_B04AF5134C8B", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageElsterExport" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageElsterExport" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageElsterExport" } } } } } }, "post": { "tags": [ "CountryPackageElsterExport" ], "summary": "CountryPackageElsterExport: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageElsterExport-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageElsterExport_Post_512AEC458994", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageElsterExport" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageElsterExport" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageElsterExport" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageElsterExport" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageElsterExport" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageElsterExport" } } } } } }, "put": { "tags": [ "CountryPackageElsterExport" ], "summary": "CountryPackageElsterExport: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageElsterExport-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageElsterExport_Put_DA08DBDD4FAA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageElsterExport" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageElsterExport" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageElsterExport" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageElsterExport" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageElsterExport" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageElsterExport" } } } } } } }, "/api/CountryPackageElsterExport/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "CountryPackageElsterExport" ], "summary": "CountryPackageElsterExport: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageElsterExport-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageElsterExport_GetPageByValue_9497E3F5897B", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CountryPackageElsterExport/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "CountryPackageElsterExport" ], "summary": "CountryPackageElsterExport: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageElsterExport-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageElsterExport_GetPageByValue2_8860FF203676", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CountryPackageElsterExport/DeleteByFilter": { "post": { "tags": [ "CountryPackageElsterExport" ], "summary": "CountryPackageElsterExport: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageElsterExport-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageElsterExport_DeleteByFilter_D5729C919D6B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/CountryPackageElsterExport/GetAllByValue": { "post": { "tags": [ "CountryPackageElsterExport" ], "summary": "CountryPackageElsterExport: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageElsterExport-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageElsterExport_GetAllByValue_741D8E379B26", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageElsterExport" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageElsterExport" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageElsterExport" } } } } } } }, "/api/CountryPackageElsterExport/GetAllGraphByValue": { "post": { "tags": [ "CountryPackageElsterExport" ], "summary": "CountryPackageElsterExport: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageElsterExport-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageElsterExport_GetAllGraphByValue_CBF73FF9D320", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageElsterExport" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageElsterExport" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageElsterExport" } } } } } } }, "/api/CountryPackageElsterExport/GetByValue": { "post": { "tags": [ "CountryPackageElsterExport" ], "summary": "CountryPackageElsterExport: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageElsterExport-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageElsterExport_GetByValue_549F0048567C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageElsterExport" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageElsterExport" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageElsterExport" } } } } } } }, "/api/CountryPackageElsterExport/GetLookup": { "post": { "tags": [ "CountryPackageElsterExport" ], "summary": "CountryPackageElsterExport: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageElsterExport-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageElsterExport_GetLookup_8508A4F6C292", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/CountryPackageElsterExport/GetLookupByValue": { "post": { "tags": [ "CountryPackageElsterExport" ], "summary": "CountryPackageElsterExport: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageElsterExport-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageElsterExport_GetLookupByValue_4CB19BD5EA41", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/CountryPackageElsterExport/Page": { "get": { "tags": [ "CountryPackageElsterExport" ], "summary": "CountryPackageElsterExport: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageElsterExport-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageElsterExport_GetPage_2A2F971D0B7C", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CountryPackageElsterExport/PageAsc": { "get": { "tags": [ "CountryPackageElsterExport" ], "summary": "CountryPackageElsterExport: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageElsterExport-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageElsterExport_GetPageAsc_8B6CBC24F76D", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CountryPackageElsterExport/SearchByValue": { "post": { "tags": [ "CountryPackageElsterExport" ], "summary": "CountryPackageElsterExport: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageElsterExport-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageElsterExport_SearchByValue_5BD7A2F55876", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CountryPackageElsterExport" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CountryPackageElsterExport" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CountryPackageElsterExport" } } } } } } }, "/api/CountryPackageElsterExport/TryGetByValue": { "post": { "tags": [ "CountryPackageElsterExport" ], "summary": "CountryPackageElsterExport: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageElsterExport-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageElsterExport_TryGetByValue_A9094E48A228", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageElsterExport" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageElsterExport" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageElsterExport" } } } } } } }, "/api/CountryPackageElsterExport/UpsertGraph": { "put": { "tags": [ "CountryPackageElsterExport" ], "summary": "CountryPackageElsterExport: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageElsterExport-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageElsterExport_UpsertGraph_07987778ED15", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageElsterExport" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageElsterExport" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageElsterExport" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageElsterExport" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageElsterExport" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageElsterExport" } } } } } } }, "/api/CountryPackageElsterExport/UpsertGraphWithExtraFields": { "put": { "tags": [ "CountryPackageElsterExport" ], "summary": "CountryPackageElsterExport: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageElsterExport-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageElsterExport_UpsertGraphWithExtraFields_BF5BA1CD46F3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageElsterExport" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageElsterExport" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageElsterExport" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageElsterExport" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageElsterExport" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageElsterExport" } } } } } } }, "/api/CountryPackageIntrastatArticle": { "get": { "tags": [ "CountryPackageIntrastatArticle" ], "summary": "CountryPackageIntrastatArticle: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatArticle-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatArticle_GetAll_2611BDFEC58B", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatArticle" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatArticle" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatArticle" } } } } } }, "post": { "tags": [ "CountryPackageIntrastatArticle" ], "summary": "CountryPackageIntrastatArticle: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatArticle-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatArticle_Post_33176D7077DB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatArticle" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatArticle" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatArticle" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatArticle" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatArticle" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatArticle" } } } } } }, "put": { "tags": [ "CountryPackageIntrastatArticle" ], "summary": "CountryPackageIntrastatArticle: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatArticle-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatArticle_Put_4A65A325B839", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatArticle" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatArticle" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatArticle" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatArticle" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatArticle" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatArticle" } } } } } } }, "/api/CountryPackageIntrastatArticle/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "CountryPackageIntrastatArticle" ], "summary": "CountryPackageIntrastatArticle: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatArticle-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatArticle_GetPageByValue_1E0D6184BE24", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CountryPackageIntrastatArticle/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "CountryPackageIntrastatArticle" ], "summary": "CountryPackageIntrastatArticle: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatArticle-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatArticle_GetPageByValue2_346F01227451", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CountryPackageIntrastatArticle/DeleteByFilter": { "post": { "tags": [ "CountryPackageIntrastatArticle" ], "summary": "CountryPackageIntrastatArticle: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatArticle-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatArticle_DeleteByFilter_F5E8F5D4A471", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/CountryPackageIntrastatArticle/GetAllByValue": { "post": { "tags": [ "CountryPackageIntrastatArticle" ], "summary": "CountryPackageIntrastatArticle: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatArticle-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatArticle_GetAllByValue_DFEFB1A41A8B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatArticle" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatArticle" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatArticle" } } } } } } }, "/api/CountryPackageIntrastatArticle/GetAllGraphByValue": { "post": { "tags": [ "CountryPackageIntrastatArticle" ], "summary": "CountryPackageIntrastatArticle: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatArticle-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatArticle_GetAllGraphByValue_B7911D1ECE41", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatArticle" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatArticle" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatArticle" } } } } } } }, "/api/CountryPackageIntrastatArticle/GetByValue": { "post": { "tags": [ "CountryPackageIntrastatArticle" ], "summary": "CountryPackageIntrastatArticle: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatArticle-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatArticle_GetByValue_DD820010F285", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatArticle" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatArticle" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatArticle" } } } } } } }, "/api/CountryPackageIntrastatArticle/GetLookup": { "post": { "tags": [ "CountryPackageIntrastatArticle" ], "summary": "CountryPackageIntrastatArticle: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatArticle-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatArticle_GetLookup_0673C4A90373", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/CountryPackageIntrastatArticle/GetLookupByValue": { "post": { "tags": [ "CountryPackageIntrastatArticle" ], "summary": "CountryPackageIntrastatArticle: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatArticle-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatArticle_GetLookupByValue_54F26DEBE384", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/CountryPackageIntrastatArticle/Page": { "get": { "tags": [ "CountryPackageIntrastatArticle" ], "summary": "CountryPackageIntrastatArticle: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatArticle-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatArticle_GetPage_8770BA9B930B", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CountryPackageIntrastatArticle/PageAsc": { "get": { "tags": [ "CountryPackageIntrastatArticle" ], "summary": "CountryPackageIntrastatArticle: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatArticle-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatArticle_GetPageAsc_B0A89A3168D0", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CountryPackageIntrastatArticle/SearchByValue": { "post": { "tags": [ "CountryPackageIntrastatArticle" ], "summary": "CountryPackageIntrastatArticle: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatArticle-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatArticle_SearchByValue_22BFEF659563", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CountryPackageIntrastatArticle" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CountryPackageIntrastatArticle" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CountryPackageIntrastatArticle" } } } } } } }, "/api/CountryPackageIntrastatArticle/TryGetByValue": { "post": { "tags": [ "CountryPackageIntrastatArticle" ], "summary": "CountryPackageIntrastatArticle: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatArticle-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatArticle_TryGetByValue_69445F3B1607", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatArticle" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatArticle" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatArticle" } } } } } } }, "/api/CountryPackageIntrastatArticle/UpsertGraph": { "put": { "tags": [ "CountryPackageIntrastatArticle" ], "summary": "CountryPackageIntrastatArticle: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatArticle-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatArticle_UpsertGraph_48D1AFDA6101", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatArticle" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatArticle" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatArticle" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatArticle" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatArticle" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatArticle" } } } } } } }, "/api/CountryPackageIntrastatArticle/UpsertGraphWithExtraFields": { "put": { "tags": [ "CountryPackageIntrastatArticle" ], "summary": "CountryPackageIntrastatArticle: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatArticle-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatArticle_UpsertGraphWithExtraFields_BA5496BB169C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatArticle" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatArticle" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatArticle" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatArticle" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatArticle" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatArticle" } } } } } } }, "/api/CountryPackageIntrastatCommodityCode": { "get": { "tags": [ "CountryPackageIntrastatCommodityCode" ], "summary": "CountryPackageIntrastatCommodityCode: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatCommodityCode-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatCommodityCode_GetAll_5FEEA17D9E8A", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatCommodityCode" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatCommodityCode" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatCommodityCode" } } } } } }, "post": { "tags": [ "CountryPackageIntrastatCommodityCode" ], "summary": "CountryPackageIntrastatCommodityCode: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatCommodityCode-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatCommodityCode_Post_B19C579175D1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatCommodityCode" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatCommodityCode" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatCommodityCode" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatCommodityCode" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatCommodityCode" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatCommodityCode" } } } } } }, "put": { "tags": [ "CountryPackageIntrastatCommodityCode" ], "summary": "CountryPackageIntrastatCommodityCode: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatCommodityCode-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatCommodityCode_Put_39347D67152A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatCommodityCode" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatCommodityCode" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatCommodityCode" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatCommodityCode" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatCommodityCode" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatCommodityCode" } } } } } } }, "/api/CountryPackageIntrastatCommodityCode/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "CountryPackageIntrastatCommodityCode" ], "summary": "CountryPackageIntrastatCommodityCode: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatCommodityCode-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatCommodityCode_GetPageByValue_5FA5B3CACD3E", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CountryPackageIntrastatCommodityCode/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "CountryPackageIntrastatCommodityCode" ], "summary": "CountryPackageIntrastatCommodityCode: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatCommodityCode-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatCommodityCode_GetPageByValue2_16811C33CB1B", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CountryPackageIntrastatCommodityCode/DeleteByFilter": { "post": { "tags": [ "CountryPackageIntrastatCommodityCode" ], "summary": "CountryPackageIntrastatCommodityCode: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatCommodityCode-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatCommodityCode_DeleteByFilter_B38241FBE48A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/CountryPackageIntrastatCommodityCode/GetAllByValue": { "post": { "tags": [ "CountryPackageIntrastatCommodityCode" ], "summary": "CountryPackageIntrastatCommodityCode: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatCommodityCode-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatCommodityCode_GetAllByValue_5B8A8523DD0D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatCommodityCode" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatCommodityCode" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatCommodityCode" } } } } } } }, "/api/CountryPackageIntrastatCommodityCode/GetAllGraphByValue": { "post": { "tags": [ "CountryPackageIntrastatCommodityCode" ], "summary": "CountryPackageIntrastatCommodityCode: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatCommodityCode-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatCommodityCode_GetAllGraphByValue_D04E3DA38472", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatCommodityCode" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatCommodityCode" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatCommodityCode" } } } } } } }, "/api/CountryPackageIntrastatCommodityCode/GetByValue": { "post": { "tags": [ "CountryPackageIntrastatCommodityCode" ], "summary": "CountryPackageIntrastatCommodityCode: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatCommodityCode-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatCommodityCode_GetByValue_D5ADCB7AF6EF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatCommodityCode" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatCommodityCode" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatCommodityCode" } } } } } } }, "/api/CountryPackageIntrastatCommodityCode/GetLookup": { "post": { "tags": [ "CountryPackageIntrastatCommodityCode" ], "summary": "CountryPackageIntrastatCommodityCode: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatCommodityCode-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatCommodityCode_GetLookup_131AF1BD9251", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/CountryPackageIntrastatCommodityCode/GetLookupByValue": { "post": { "tags": [ "CountryPackageIntrastatCommodityCode" ], "summary": "CountryPackageIntrastatCommodityCode: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatCommodityCode-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatCommodityCode_GetLookupByValue_B9AC145FF085", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/CountryPackageIntrastatCommodityCode/Page": { "get": { "tags": [ "CountryPackageIntrastatCommodityCode" ], "summary": "CountryPackageIntrastatCommodityCode: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatCommodityCode-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatCommodityCode_GetPage_09C9FC40D803", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CountryPackageIntrastatCommodityCode/PageAsc": { "get": { "tags": [ "CountryPackageIntrastatCommodityCode" ], "summary": "CountryPackageIntrastatCommodityCode: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatCommodityCode-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatCommodityCode_GetPageAsc_93D6AD224822", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CountryPackageIntrastatCommodityCode/SearchByValue": { "post": { "tags": [ "CountryPackageIntrastatCommodityCode" ], "summary": "CountryPackageIntrastatCommodityCode: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatCommodityCode-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatCommodityCode_SearchByValue_017F6D59D68D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CountryPackageIntrastatCommodityCode" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CountryPackageIntrastatCommodityCode" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CountryPackageIntrastatCommodityCode" } } } } } } }, "/api/CountryPackageIntrastatCommodityCode/TryGetByValue": { "post": { "tags": [ "CountryPackageIntrastatCommodityCode" ], "summary": "CountryPackageIntrastatCommodityCode: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatCommodityCode-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatCommodityCode_TryGetByValue_12E877CB0EE0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatCommodityCode" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatCommodityCode" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatCommodityCode" } } } } } } }, "/api/CountryPackageIntrastatCommodityCode/UpsertGraph": { "put": { "tags": [ "CountryPackageIntrastatCommodityCode" ], "summary": "CountryPackageIntrastatCommodityCode: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatCommodityCode-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatCommodityCode_UpsertGraph_D3665D88AF78", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatCommodityCode" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatCommodityCode" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatCommodityCode" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatCommodityCode" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatCommodityCode" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatCommodityCode" } } } } } } }, "/api/CountryPackageIntrastatCommodityCode/UpsertGraphWithExtraFields": { "put": { "tags": [ "CountryPackageIntrastatCommodityCode" ], "summary": "CountryPackageIntrastatCommodityCode: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatCommodityCode-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatCommodityCode_UpsertGraphWithExtraFields_EBEEE0BE5D60", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatCommodityCode" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatCommodityCode" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatCommodityCode" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatCommodityCode" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatCommodityCode" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatCommodityCode" } } } } } } }, "/api/CountryPackageIntrastatDeclaration": { "get": { "tags": [ "CountryPackageIntrastatDeclaration" ], "summary": "CountryPackageIntrastatDeclaration: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDeclaration-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDeclaration_GetAll_9CF9A739AD51", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatDeclaration" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatDeclaration" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatDeclaration" } } } } } }, "post": { "tags": [ "CountryPackageIntrastatDeclaration" ], "summary": "CountryPackageIntrastatDeclaration: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDeclaration-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDeclaration_Post_B89BC23457D6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDeclaration" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDeclaration" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDeclaration" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatDeclaration" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatDeclaration" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatDeclaration" } } } } } }, "put": { "tags": [ "CountryPackageIntrastatDeclaration" ], "summary": "CountryPackageIntrastatDeclaration: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDeclaration-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDeclaration_Put_3689CCC54848", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDeclaration" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDeclaration" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDeclaration" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatDeclaration" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatDeclaration" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatDeclaration" } } } } } } }, "/api/CountryPackageIntrastatDeclaration/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "CountryPackageIntrastatDeclaration" ], "summary": "CountryPackageIntrastatDeclaration: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDeclaration-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDeclaration_GetPageByValue_18A4DF3171AC", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CountryPackageIntrastatDeclaration/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "CountryPackageIntrastatDeclaration" ], "summary": "CountryPackageIntrastatDeclaration: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDeclaration-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDeclaration_GetPageByValue2_F4FA4F56CB91", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CountryPackageIntrastatDeclaration/Cancel": { "post": { "tags": [ "CountryPackageIntrastatDeclaration" ], "summary": "CountryPackageIntrastatDeclaration: Cancel", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDeclaration-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDeclaration_Cancel_688A0DBD9DAE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDeclaration_IdRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDeclaration_IdRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDeclaration_IdRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/CountryPackageIntrastatDeclaration/CreateCorrection": { "post": { "tags": [ "CountryPackageIntrastatDeclaration" ], "summary": "CountryPackageIntrastatDeclaration: CreateCorrection", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDeclaration-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDeclaration_CreateCorrection_DB7F5B1D6837", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDeclaration_IdRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDeclaration_IdRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDeclaration_IdRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/CountryPackageIntrastatDeclaration/CreateForPeriod": { "post": { "tags": [ "CountryPackageIntrastatDeclaration" ], "summary": "CountryPackageIntrastatDeclaration: CreateForPeriod", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDeclaration-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDeclaration_CreateForPeriod_27DB9656DB06", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDeclaration_CreateForPeriodRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDeclaration_CreateForPeriodRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDeclaration_CreateForPeriodRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/CountryPackageIntrastatDeclaration/CreateFromPreview": { "post": { "tags": [ "CountryPackageIntrastatDeclaration" ], "summary": "CountryPackageIntrastatDeclaration: CreateFromPreview", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDeclaration-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDeclaration_CreateFromPreview_A7E2FA089117", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDeclaration_CreateFromPreviewRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDeclaration_CreateFromPreviewRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDeclaration_CreateFromPreviewRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/CountryPackageIntrastatDeclaration/DeleteByFilter": { "post": { "tags": [ "CountryPackageIntrastatDeclaration" ], "summary": "CountryPackageIntrastatDeclaration: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDeclaration-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDeclaration_DeleteByFilter_2B814AB1B0F6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/CountryPackageIntrastatDeclaration/ExportInstatFile/{declarationId}": { "get": { "tags": [ "CountryPackageIntrastatDeclaration" ], "summary": "CountryPackageIntrastatDeclaration: ExportInstatFile", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDeclaration-Read.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDeclaration_ExportInstatFile_6777AED3E2FE", "parameters": [ { "name": "declarationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CountryPackageIntrastatDeclaration/GetAllByValue": { "post": { "tags": [ "CountryPackageIntrastatDeclaration" ], "summary": "CountryPackageIntrastatDeclaration: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDeclaration-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDeclaration_GetAllByValue_BBE99A486792", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatDeclaration" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatDeclaration" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatDeclaration" } } } } } } }, "/api/CountryPackageIntrastatDeclaration/GetAllGraphByValue": { "post": { "tags": [ "CountryPackageIntrastatDeclaration" ], "summary": "CountryPackageIntrastatDeclaration: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDeclaration-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDeclaration_GetAllGraphByValue_D95B3C21D188", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatDeclaration" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatDeclaration" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatDeclaration" } } } } } } }, "/api/CountryPackageIntrastatDeclaration/GetByValue": { "post": { "tags": [ "CountryPackageIntrastatDeclaration" ], "summary": "CountryPackageIntrastatDeclaration: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDeclaration-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDeclaration_GetByValue_75B3052A2BB1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatDeclaration" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatDeclaration" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatDeclaration" } } } } } } }, "/api/CountryPackageIntrastatDeclaration/GetLookup": { "post": { "tags": [ "CountryPackageIntrastatDeclaration" ], "summary": "CountryPackageIntrastatDeclaration: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDeclaration-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDeclaration_GetLookup_CCA019690A8D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/CountryPackageIntrastatDeclaration/GetLookupByValue": { "post": { "tags": [ "CountryPackageIntrastatDeclaration" ], "summary": "CountryPackageIntrastatDeclaration: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDeclaration-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDeclaration_GetLookupByValue_886CD1A0B370", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/CountryPackageIntrastatDeclaration/Page": { "get": { "tags": [ "CountryPackageIntrastatDeclaration" ], "summary": "CountryPackageIntrastatDeclaration: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDeclaration-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDeclaration_GetPage_FC409A77F12A", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CountryPackageIntrastatDeclaration/PageAsc": { "get": { "tags": [ "CountryPackageIntrastatDeclaration" ], "summary": "CountryPackageIntrastatDeclaration: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDeclaration-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDeclaration_GetPageAsc_DAA00337CFF8", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CountryPackageIntrastatDeclaration/Populate": { "post": { "tags": [ "CountryPackageIntrastatDeclaration" ], "summary": "CountryPackageIntrastatDeclaration: Populate", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDeclaration-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDeclaration_Populate_52E40327DFC3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDeclaration_IdRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDeclaration_IdRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDeclaration_IdRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/CountryPackageIntrastatDeclaration/Preview": { "post": { "tags": [ "CountryPackageIntrastatDeclaration" ], "summary": "CountryPackageIntrastatDeclaration: Preview", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDeclaration-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDeclaration_Preview_C38455A7884C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDeclaration_CreateForPeriodRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDeclaration_CreateForPeriodRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDeclaration_CreateForPeriodRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatPreviewPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatPreviewPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatPreviewPosition" } } } } } } }, "/api/CountryPackageIntrastatDeclaration/SearchByValue": { "post": { "tags": [ "CountryPackageIntrastatDeclaration" ], "summary": "CountryPackageIntrastatDeclaration: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDeclaration-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDeclaration_SearchByValue_694869545BE7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CountryPackageIntrastatDeclaration" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CountryPackageIntrastatDeclaration" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CountryPackageIntrastatDeclaration" } } } } } } }, "/api/CountryPackageIntrastatDeclaration/Submit": { "post": { "tags": [ "CountryPackageIntrastatDeclaration" ], "summary": "CountryPackageIntrastatDeclaration: Submit", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDeclaration-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDeclaration_Submit_7D9294D120BE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDeclaration_SubmitRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDeclaration_SubmitRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDeclaration_SubmitRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/CountryPackageIntrastatDeclaration/TryGetByValue": { "post": { "tags": [ "CountryPackageIntrastatDeclaration" ], "summary": "CountryPackageIntrastatDeclaration: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDeclaration-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDeclaration_TryGetByValue_2E53D38693EA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatDeclaration" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatDeclaration" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatDeclaration" } } } } } } }, "/api/CountryPackageIntrastatDeclaration/UpsertGraph": { "put": { "tags": [ "CountryPackageIntrastatDeclaration" ], "summary": "CountryPackageIntrastatDeclaration: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDeclaration-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDeclaration_UpsertGraph_0AE35F8BCBC5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDeclaration" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDeclaration" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDeclaration" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatDeclaration" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatDeclaration" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatDeclaration" } } } } } } }, "/api/CountryPackageIntrastatDeclaration/UpsertGraphWithExtraFields": { "put": { "tags": [ "CountryPackageIntrastatDeclaration" ], "summary": "CountryPackageIntrastatDeclaration: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDeclaration-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDeclaration_UpsertGraphWithExtraFields_4C89B05801E8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatDeclaration" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatDeclaration" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatDeclaration" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatDeclaration" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatDeclaration" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatDeclaration" } } } } } } }, "/api/CountryPackageIntrastatDeclaration/Validate": { "post": { "tags": [ "CountryPackageIntrastatDeclaration" ], "summary": "CountryPackageIntrastatDeclaration: Validate", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDeclaration-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDeclaration_Validate_4B2EDBD61DEE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDeclaration_IdRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDeclaration_IdRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDeclaration_IdRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/CountryPackageIntrastatDeclarationPosition": { "get": { "tags": [ "CountryPackageIntrastatDeclarationPosition" ], "summary": "CountryPackageIntrastatDeclarationPosition: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDeclarationPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDeclarationPosition_GetAll_B704DFC265D4", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatDeclarationPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatDeclarationPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatDeclarationPosition" } } } } } }, "post": { "tags": [ "CountryPackageIntrastatDeclarationPosition" ], "summary": "CountryPackageIntrastatDeclarationPosition: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDeclarationPosition-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDeclarationPosition_Post_7E2EEED14640", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDeclarationPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDeclarationPosition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDeclarationPosition" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatDeclarationPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatDeclarationPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatDeclarationPosition" } } } } } }, "put": { "tags": [ "CountryPackageIntrastatDeclarationPosition" ], "summary": "CountryPackageIntrastatDeclarationPosition: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDeclarationPosition-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDeclarationPosition_Put_6707F21AC959", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDeclarationPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDeclarationPosition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDeclarationPosition" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatDeclarationPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatDeclarationPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatDeclarationPosition" } } } } } } }, "/api/CountryPackageIntrastatDeclarationPosition/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "CountryPackageIntrastatDeclarationPosition" ], "summary": "CountryPackageIntrastatDeclarationPosition: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDeclarationPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDeclarationPosition_GetPageByValue_29762430BEE8", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CountryPackageIntrastatDeclarationPosition/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "CountryPackageIntrastatDeclarationPosition" ], "summary": "CountryPackageIntrastatDeclarationPosition: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDeclarationPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDeclarationPosition_GetPageByValue2_F3D753DF84D2", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CountryPackageIntrastatDeclarationPosition/DeleteByFilter": { "post": { "tags": [ "CountryPackageIntrastatDeclarationPosition" ], "summary": "CountryPackageIntrastatDeclarationPosition: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDeclarationPosition-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDeclarationPosition_DeleteByFilter_146AA970C24C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/CountryPackageIntrastatDeclarationPosition/GetAllByValue": { "post": { "tags": [ "CountryPackageIntrastatDeclarationPosition" ], "summary": "CountryPackageIntrastatDeclarationPosition: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDeclarationPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDeclarationPosition_GetAllByValue_FBBA7263B01E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatDeclarationPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatDeclarationPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatDeclarationPosition" } } } } } } }, "/api/CountryPackageIntrastatDeclarationPosition/GetAllGraphByValue": { "post": { "tags": [ "CountryPackageIntrastatDeclarationPosition" ], "summary": "CountryPackageIntrastatDeclarationPosition: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDeclarationPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDeclarationPosition_GetAllGraphByValue_962D6D5D3E53", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatDeclarationPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatDeclarationPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatDeclarationPosition" } } } } } } }, "/api/CountryPackageIntrastatDeclarationPosition/GetByValue": { "post": { "tags": [ "CountryPackageIntrastatDeclarationPosition" ], "summary": "CountryPackageIntrastatDeclarationPosition: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDeclarationPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDeclarationPosition_GetByValue_1906825B4A01", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatDeclarationPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatDeclarationPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatDeclarationPosition" } } } } } } }, "/api/CountryPackageIntrastatDeclarationPosition/GetLookup": { "post": { "tags": [ "CountryPackageIntrastatDeclarationPosition" ], "summary": "CountryPackageIntrastatDeclarationPosition: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDeclarationPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDeclarationPosition_GetLookup_17347F0DDC15", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/CountryPackageIntrastatDeclarationPosition/GetLookupByValue": { "post": { "tags": [ "CountryPackageIntrastatDeclarationPosition" ], "summary": "CountryPackageIntrastatDeclarationPosition: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDeclarationPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDeclarationPosition_GetLookupByValue_16FAAD7B50A1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/CountryPackageIntrastatDeclarationPosition/Page": { "get": { "tags": [ "CountryPackageIntrastatDeclarationPosition" ], "summary": "CountryPackageIntrastatDeclarationPosition: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDeclarationPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDeclarationPosition_GetPage_DB91540B5F75", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CountryPackageIntrastatDeclarationPosition/PageAsc": { "get": { "tags": [ "CountryPackageIntrastatDeclarationPosition" ], "summary": "CountryPackageIntrastatDeclarationPosition: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDeclarationPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDeclarationPosition_GetPageAsc_627E89638D54", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CountryPackageIntrastatDeclarationPosition/SearchByValue": { "post": { "tags": [ "CountryPackageIntrastatDeclarationPosition" ], "summary": "CountryPackageIntrastatDeclarationPosition: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDeclarationPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDeclarationPosition_SearchByValue_D65C542C3A69", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CountryPackageIntrastatDeclarationPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CountryPackageIntrastatDeclarationPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CountryPackageIntrastatDeclarationPosition" } } } } } } }, "/api/CountryPackageIntrastatDeclarationPosition/TryGetByValue": { "post": { "tags": [ "CountryPackageIntrastatDeclarationPosition" ], "summary": "CountryPackageIntrastatDeclarationPosition: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDeclarationPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDeclarationPosition_TryGetByValue_707E2CC73F57", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatDeclarationPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatDeclarationPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatDeclarationPosition" } } } } } } }, "/api/CountryPackageIntrastatDeclarationPosition/UpsertGraph": { "put": { "tags": [ "CountryPackageIntrastatDeclarationPosition" ], "summary": "CountryPackageIntrastatDeclarationPosition: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDeclarationPosition-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDeclarationPosition_UpsertGraph_58EFAA4A3311", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDeclarationPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDeclarationPosition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDeclarationPosition" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatDeclarationPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatDeclarationPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatDeclarationPosition" } } } } } } }, "/api/CountryPackageIntrastatDeclarationPosition/UpsertGraphWithExtraFields": { "put": { "tags": [ "CountryPackageIntrastatDeclarationPosition" ], "summary": "CountryPackageIntrastatDeclarationPosition: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDeclarationPosition-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDeclarationPosition_UpsertGraphWithExtraFields_50A92847B428", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatDeclarationPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatDeclarationPosition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatDeclarationPosition" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatDeclarationPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatDeclarationPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatDeclarationPosition" } } } } } } }, "/api/CountryPackageIntrastatDeclarationStatus": { "get": { "tags": [ "CountryPackageIntrastatDeclarationStatus" ], "summary": "CountryPackageIntrastatDeclarationStatus: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDeclarationStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDeclarationStatus_GetAll_CBB56BD411CF", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatDeclarationStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatDeclarationStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatDeclarationStatus" } } } } } }, "post": { "tags": [ "CountryPackageIntrastatDeclarationStatus" ], "summary": "CountryPackageIntrastatDeclarationStatus: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDeclarationStatus-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDeclarationStatus_Post_950A87889466", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDeclarationStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDeclarationStatus" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDeclarationStatus" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatDeclarationStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatDeclarationStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatDeclarationStatus" } } } } } }, "put": { "tags": [ "CountryPackageIntrastatDeclarationStatus" ], "summary": "CountryPackageIntrastatDeclarationStatus: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDeclarationStatus-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDeclarationStatus_Put_D54FE98CF9E9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDeclarationStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDeclarationStatus" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDeclarationStatus" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatDeclarationStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatDeclarationStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatDeclarationStatus" } } } } } } }, "/api/CountryPackageIntrastatDeclarationStatus/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "CountryPackageIntrastatDeclarationStatus" ], "summary": "CountryPackageIntrastatDeclarationStatus: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDeclarationStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDeclarationStatus_GetPageByValue_9A07273010EE", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CountryPackageIntrastatDeclarationStatus/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "CountryPackageIntrastatDeclarationStatus" ], "summary": "CountryPackageIntrastatDeclarationStatus: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDeclarationStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDeclarationStatus_GetPageByValue2_E0611952E56E", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CountryPackageIntrastatDeclarationStatus/DeleteByFilter": { "post": { "tags": [ "CountryPackageIntrastatDeclarationStatus" ], "summary": "CountryPackageIntrastatDeclarationStatus: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDeclarationStatus-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDeclarationStatus_DeleteByFilter_52676B1753BD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/CountryPackageIntrastatDeclarationStatus/GetAllByValue": { "post": { "tags": [ "CountryPackageIntrastatDeclarationStatus" ], "summary": "CountryPackageIntrastatDeclarationStatus: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDeclarationStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDeclarationStatus_GetAllByValue_6993C17E257C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatDeclarationStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatDeclarationStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatDeclarationStatus" } } } } } } }, "/api/CountryPackageIntrastatDeclarationStatus/GetAllGraphByValue": { "post": { "tags": [ "CountryPackageIntrastatDeclarationStatus" ], "summary": "CountryPackageIntrastatDeclarationStatus: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDeclarationStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDeclarationStatus_GetAllGraphByValue_2D6E84720701", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatDeclarationStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatDeclarationStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatDeclarationStatus" } } } } } } }, "/api/CountryPackageIntrastatDeclarationStatus/GetByValue": { "post": { "tags": [ "CountryPackageIntrastatDeclarationStatus" ], "summary": "CountryPackageIntrastatDeclarationStatus: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDeclarationStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDeclarationStatus_GetByValue_795236270593", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatDeclarationStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatDeclarationStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatDeclarationStatus" } } } } } } }, "/api/CountryPackageIntrastatDeclarationStatus/GetLookup": { "post": { "tags": [ "CountryPackageIntrastatDeclarationStatus" ], "summary": "CountryPackageIntrastatDeclarationStatus: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDeclarationStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDeclarationStatus_GetLookup_219BE2DD4DEC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/CountryPackageIntrastatDeclarationStatus/GetLookupByValue": { "post": { "tags": [ "CountryPackageIntrastatDeclarationStatus" ], "summary": "CountryPackageIntrastatDeclarationStatus: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDeclarationStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDeclarationStatus_GetLookupByValue_3C392CE5C167", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/CountryPackageIntrastatDeclarationStatus/Page": { "get": { "tags": [ "CountryPackageIntrastatDeclarationStatus" ], "summary": "CountryPackageIntrastatDeclarationStatus: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDeclarationStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDeclarationStatus_GetPage_40DC90E5F8F2", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CountryPackageIntrastatDeclarationStatus/PageAsc": { "get": { "tags": [ "CountryPackageIntrastatDeclarationStatus" ], "summary": "CountryPackageIntrastatDeclarationStatus: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDeclarationStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDeclarationStatus_GetPageAsc_55D2D78D95F0", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CountryPackageIntrastatDeclarationStatus/SearchByValue": { "post": { "tags": [ "CountryPackageIntrastatDeclarationStatus" ], "summary": "CountryPackageIntrastatDeclarationStatus: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDeclarationStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDeclarationStatus_SearchByValue_5DA684D9EE8B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CountryPackageIntrastatDeclarationStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CountryPackageIntrastatDeclarationStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CountryPackageIntrastatDeclarationStatus" } } } } } } }, "/api/CountryPackageIntrastatDeclarationStatus/TryGetByValue": { "post": { "tags": [ "CountryPackageIntrastatDeclarationStatus" ], "summary": "CountryPackageIntrastatDeclarationStatus: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDeclarationStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDeclarationStatus_TryGetByValue_06621E3286C5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatDeclarationStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatDeclarationStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatDeclarationStatus" } } } } } } }, "/api/CountryPackageIntrastatDeclarationStatus/UpsertGraph": { "put": { "tags": [ "CountryPackageIntrastatDeclarationStatus" ], "summary": "CountryPackageIntrastatDeclarationStatus: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDeclarationStatus-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDeclarationStatus_UpsertGraph_C783C6D4A12C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDeclarationStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDeclarationStatus" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDeclarationStatus" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatDeclarationStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatDeclarationStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatDeclarationStatus" } } } } } } }, "/api/CountryPackageIntrastatDeclarationStatus/UpsertGraphWithExtraFields": { "put": { "tags": [ "CountryPackageIntrastatDeclarationStatus" ], "summary": "CountryPackageIntrastatDeclarationStatus: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDeclarationStatus-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDeclarationStatus_UpsertGraphWithExtraFields_047C0B3326C3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatDeclarationStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatDeclarationStatus" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatDeclarationStatus" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatDeclarationStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatDeclarationStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatDeclarationStatus" } } } } } } }, "/api/CountryPackageIntrastatDirection": { "get": { "tags": [ "CountryPackageIntrastatDirection" ], "summary": "CountryPackageIntrastatDirection: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDirection-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDirection_GetAll_9F13EA0A43B8", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatDirection" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatDirection" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatDirection" } } } } } }, "post": { "tags": [ "CountryPackageIntrastatDirection" ], "summary": "CountryPackageIntrastatDirection: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDirection-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDirection_Post_487262ADFC74", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDirection" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDirection" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDirection" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatDirection" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatDirection" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatDirection" } } } } } }, "put": { "tags": [ "CountryPackageIntrastatDirection" ], "summary": "CountryPackageIntrastatDirection: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDirection-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDirection_Put_AFE1708800E6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDirection" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDirection" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDirection" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatDirection" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatDirection" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatDirection" } } } } } } }, "/api/CountryPackageIntrastatDirection/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "CountryPackageIntrastatDirection" ], "summary": "CountryPackageIntrastatDirection: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDirection-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDirection_GetPageByValue_55E1856169BE", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CountryPackageIntrastatDirection/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "CountryPackageIntrastatDirection" ], "summary": "CountryPackageIntrastatDirection: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDirection-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDirection_GetPageByValue2_B505CB56F3E0", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CountryPackageIntrastatDirection/DeleteByFilter": { "post": { "tags": [ "CountryPackageIntrastatDirection" ], "summary": "CountryPackageIntrastatDirection: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDirection-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDirection_DeleteByFilter_06F0A1C07281", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/CountryPackageIntrastatDirection/GetAllByValue": { "post": { "tags": [ "CountryPackageIntrastatDirection" ], "summary": "CountryPackageIntrastatDirection: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDirection-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDirection_GetAllByValue_844019573D1D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatDirection" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatDirection" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatDirection" } } } } } } }, "/api/CountryPackageIntrastatDirection/GetAllGraphByValue": { "post": { "tags": [ "CountryPackageIntrastatDirection" ], "summary": "CountryPackageIntrastatDirection: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDirection-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDirection_GetAllGraphByValue_6F9C5AC9A892", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatDirection" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatDirection" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatDirection" } } } } } } }, "/api/CountryPackageIntrastatDirection/GetByValue": { "post": { "tags": [ "CountryPackageIntrastatDirection" ], "summary": "CountryPackageIntrastatDirection: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDirection-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDirection_GetByValue_F21C0AE511D0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatDirection" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatDirection" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatDirection" } } } } } } }, "/api/CountryPackageIntrastatDirection/GetLookup": { "post": { "tags": [ "CountryPackageIntrastatDirection" ], "summary": "CountryPackageIntrastatDirection: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDirection-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDirection_GetLookup_AFF6A19F26FC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/CountryPackageIntrastatDirection/GetLookupByValue": { "post": { "tags": [ "CountryPackageIntrastatDirection" ], "summary": "CountryPackageIntrastatDirection: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDirection-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDirection_GetLookupByValue_4016C90FA68C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/CountryPackageIntrastatDirection/Page": { "get": { "tags": [ "CountryPackageIntrastatDirection" ], "summary": "CountryPackageIntrastatDirection: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDirection-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDirection_GetPage_A5D7F82F8735", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CountryPackageIntrastatDirection/PageAsc": { "get": { "tags": [ "CountryPackageIntrastatDirection" ], "summary": "CountryPackageIntrastatDirection: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDirection-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDirection_GetPageAsc_9C6E762B0033", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CountryPackageIntrastatDirection/SearchByValue": { "post": { "tags": [ "CountryPackageIntrastatDirection" ], "summary": "CountryPackageIntrastatDirection: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDirection-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDirection_SearchByValue_11306385A6BC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CountryPackageIntrastatDirection" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CountryPackageIntrastatDirection" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CountryPackageIntrastatDirection" } } } } } } }, "/api/CountryPackageIntrastatDirection/TryGetByValue": { "post": { "tags": [ "CountryPackageIntrastatDirection" ], "summary": "CountryPackageIntrastatDirection: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDirection-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDirection_TryGetByValue_69AFA8800928", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatDirection" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatDirection" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatDirection" } } } } } } }, "/api/CountryPackageIntrastatDirection/UpsertGraph": { "put": { "tags": [ "CountryPackageIntrastatDirection" ], "summary": "CountryPackageIntrastatDirection: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDirection-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDirection_UpsertGraph_8B051B3EF810", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDirection" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDirection" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDirection" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatDirection" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatDirection" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatDirection" } } } } } } }, "/api/CountryPackageIntrastatDirection/UpsertGraphWithExtraFields": { "put": { "tags": [ "CountryPackageIntrastatDirection" ], "summary": "CountryPackageIntrastatDirection: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDirection-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDirection_UpsertGraphWithExtraFields_E0D726EB6418", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatDirection" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatDirection" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatDirection" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatDirection" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatDirection" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatDirection" } } } } } } }, "/api/CountryPackageIntrastatDocPosition": { "get": { "tags": [ "CountryPackageIntrastatDocPosition" ], "summary": "CountryPackageIntrastatDocPosition: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDocPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDocPosition_GetAll_EE003925FB4C", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatDocPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatDocPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatDocPosition" } } } } } }, "post": { "tags": [ "CountryPackageIntrastatDocPosition" ], "summary": "CountryPackageIntrastatDocPosition: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDocPosition-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDocPosition_Post_54DB9F8739EA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDocPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDocPosition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDocPosition" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatDocPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatDocPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatDocPosition" } } } } } }, "put": { "tags": [ "CountryPackageIntrastatDocPosition" ], "summary": "CountryPackageIntrastatDocPosition: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDocPosition-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDocPosition_Put_BF9ACC5FAD4C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDocPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDocPosition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDocPosition" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatDocPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatDocPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatDocPosition" } } } } } } }, "/api/CountryPackageIntrastatDocPosition/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "CountryPackageIntrastatDocPosition" ], "summary": "CountryPackageIntrastatDocPosition: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDocPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDocPosition_GetPageByValue_B0B99105E277", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CountryPackageIntrastatDocPosition/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "CountryPackageIntrastatDocPosition" ], "summary": "CountryPackageIntrastatDocPosition: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDocPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDocPosition_GetPageByValue2_A9C8A24CFE55", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CountryPackageIntrastatDocPosition/DeleteByFilter": { "post": { "tags": [ "CountryPackageIntrastatDocPosition" ], "summary": "CountryPackageIntrastatDocPosition: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDocPosition-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDocPosition_DeleteByFilter_159A768389B8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/CountryPackageIntrastatDocPosition/GetAllByValue": { "post": { "tags": [ "CountryPackageIntrastatDocPosition" ], "summary": "CountryPackageIntrastatDocPosition: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDocPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDocPosition_GetAllByValue_97C33B25B806", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatDocPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatDocPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatDocPosition" } } } } } } }, "/api/CountryPackageIntrastatDocPosition/GetAllGraphByValue": { "post": { "tags": [ "CountryPackageIntrastatDocPosition" ], "summary": "CountryPackageIntrastatDocPosition: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDocPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDocPosition_GetAllGraphByValue_023E9F8E6274", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatDocPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatDocPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatDocPosition" } } } } } } }, "/api/CountryPackageIntrastatDocPosition/GetByValue": { "post": { "tags": [ "CountryPackageIntrastatDocPosition" ], "summary": "CountryPackageIntrastatDocPosition: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDocPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDocPosition_GetByValue_3F3E33CBE7C0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatDocPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatDocPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatDocPosition" } } } } } } }, "/api/CountryPackageIntrastatDocPosition/GetLookup": { "post": { "tags": [ "CountryPackageIntrastatDocPosition" ], "summary": "CountryPackageIntrastatDocPosition: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDocPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDocPosition_GetLookup_1BC5B06F0E16", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/CountryPackageIntrastatDocPosition/GetLookupByValue": { "post": { "tags": [ "CountryPackageIntrastatDocPosition" ], "summary": "CountryPackageIntrastatDocPosition: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDocPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDocPosition_GetLookupByValue_162E0F4958B1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/CountryPackageIntrastatDocPosition/Page": { "get": { "tags": [ "CountryPackageIntrastatDocPosition" ], "summary": "CountryPackageIntrastatDocPosition: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDocPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDocPosition_GetPage_89BBFB897F75", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CountryPackageIntrastatDocPosition/PageAsc": { "get": { "tags": [ "CountryPackageIntrastatDocPosition" ], "summary": "CountryPackageIntrastatDocPosition: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDocPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDocPosition_GetPageAsc_CA4209FC8A57", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CountryPackageIntrastatDocPosition/SearchByValue": { "post": { "tags": [ "CountryPackageIntrastatDocPosition" ], "summary": "CountryPackageIntrastatDocPosition: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDocPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDocPosition_SearchByValue_C978A592F1CA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CountryPackageIntrastatDocPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CountryPackageIntrastatDocPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CountryPackageIntrastatDocPosition" } } } } } } }, "/api/CountryPackageIntrastatDocPosition/TryGetByValue": { "post": { "tags": [ "CountryPackageIntrastatDocPosition" ], "summary": "CountryPackageIntrastatDocPosition: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDocPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDocPosition_TryGetByValue_761FD41A4F00", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatDocPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatDocPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatDocPosition" } } } } } } }, "/api/CountryPackageIntrastatDocPosition/UpsertGraph": { "put": { "tags": [ "CountryPackageIntrastatDocPosition" ], "summary": "CountryPackageIntrastatDocPosition: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDocPosition-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDocPosition_UpsertGraph_28B3044F5FAC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDocPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDocPosition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDocPosition" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatDocPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatDocPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatDocPosition" } } } } } } }, "/api/CountryPackageIntrastatDocPosition/UpsertGraphWithExtraFields": { "put": { "tags": [ "CountryPackageIntrastatDocPosition" ], "summary": "CountryPackageIntrastatDocPosition: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatDocPosition-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatDocPosition_UpsertGraphWithExtraFields_8C0E56D0755E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatDocPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatDocPosition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatDocPosition" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatDocPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatDocPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatDocPosition" } } } } } } }, "/api/CountryPackageIntrastatPartner": { "get": { "tags": [ "CountryPackageIntrastatPartner" ], "summary": "CountryPackageIntrastatPartner: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatPartner-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatPartner_GetAll_A41FDDDA16B4", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatPartner" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatPartner" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatPartner" } } } } } }, "post": { "tags": [ "CountryPackageIntrastatPartner" ], "summary": "CountryPackageIntrastatPartner: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatPartner-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatPartner_Post_D1A66CCFFE3F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatPartner" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatPartner" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatPartner" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatPartner" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatPartner" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatPartner" } } } } } }, "put": { "tags": [ "CountryPackageIntrastatPartner" ], "summary": "CountryPackageIntrastatPartner: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatPartner-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatPartner_Put_6172DC79A1CC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatPartner" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatPartner" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatPartner" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatPartner" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatPartner" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatPartner" } } } } } } }, "/api/CountryPackageIntrastatPartner/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "CountryPackageIntrastatPartner" ], "summary": "CountryPackageIntrastatPartner: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatPartner-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatPartner_GetPageByValue_69F6FE42F2A2", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CountryPackageIntrastatPartner/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "CountryPackageIntrastatPartner" ], "summary": "CountryPackageIntrastatPartner: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatPartner-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatPartner_GetPageByValue2_8C5A3C50D22F", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CountryPackageIntrastatPartner/DeleteByFilter": { "post": { "tags": [ "CountryPackageIntrastatPartner" ], "summary": "CountryPackageIntrastatPartner: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatPartner-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatPartner_DeleteByFilter_67288D85E379", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/CountryPackageIntrastatPartner/GetAllByValue": { "post": { "tags": [ "CountryPackageIntrastatPartner" ], "summary": "CountryPackageIntrastatPartner: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatPartner-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatPartner_GetAllByValue_7EE2FBB386D0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatPartner" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatPartner" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatPartner" } } } } } } }, "/api/CountryPackageIntrastatPartner/GetAllGraphByValue": { "post": { "tags": [ "CountryPackageIntrastatPartner" ], "summary": "CountryPackageIntrastatPartner: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatPartner-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatPartner_GetAllGraphByValue_73E73AA57CEA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatPartner" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatPartner" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatPartner" } } } } } } }, "/api/CountryPackageIntrastatPartner/GetByValue": { "post": { "tags": [ "CountryPackageIntrastatPartner" ], "summary": "CountryPackageIntrastatPartner: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatPartner-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatPartner_GetByValue_FA9269A38DD9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatPartner" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatPartner" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatPartner" } } } } } } }, "/api/CountryPackageIntrastatPartner/GetLookup": { "post": { "tags": [ "CountryPackageIntrastatPartner" ], "summary": "CountryPackageIntrastatPartner: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatPartner-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatPartner_GetLookup_F188DBC72C2D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/CountryPackageIntrastatPartner/GetLookupByValue": { "post": { "tags": [ "CountryPackageIntrastatPartner" ], "summary": "CountryPackageIntrastatPartner: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatPartner-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatPartner_GetLookupByValue_D3E1F9A0A40E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/CountryPackageIntrastatPartner/Page": { "get": { "tags": [ "CountryPackageIntrastatPartner" ], "summary": "CountryPackageIntrastatPartner: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatPartner-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatPartner_GetPage_CBA7A7F59C44", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CountryPackageIntrastatPartner/PageAsc": { "get": { "tags": [ "CountryPackageIntrastatPartner" ], "summary": "CountryPackageIntrastatPartner: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatPartner-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatPartner_GetPageAsc_0A6B9886D856", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CountryPackageIntrastatPartner/SearchByValue": { "post": { "tags": [ "CountryPackageIntrastatPartner" ], "summary": "CountryPackageIntrastatPartner: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatPartner-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatPartner_SearchByValue_6B019CAAAD50", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CountryPackageIntrastatPartner" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CountryPackageIntrastatPartner" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CountryPackageIntrastatPartner" } } } } } } }, "/api/CountryPackageIntrastatPartner/TryGetByValue": { "post": { "tags": [ "CountryPackageIntrastatPartner" ], "summary": "CountryPackageIntrastatPartner: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatPartner-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatPartner_TryGetByValue_08FA4EA994F6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatPartner" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatPartner" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatPartner" } } } } } } }, "/api/CountryPackageIntrastatPartner/UpsertGraph": { "put": { "tags": [ "CountryPackageIntrastatPartner" ], "summary": "CountryPackageIntrastatPartner: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatPartner-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatPartner_UpsertGraph_0E6AB0E6CC53", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatPartner" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatPartner" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatPartner" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatPartner" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatPartner" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatPartner" } } } } } } }, "/api/CountryPackageIntrastatPartner/UpsertGraphWithExtraFields": { "put": { "tags": [ "CountryPackageIntrastatPartner" ], "summary": "CountryPackageIntrastatPartner: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatPartner-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatPartner_UpsertGraphWithExtraFields_167411665B6D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatPartner" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatPartner" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatPartner" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatPartner" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatPartner" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatPartner" } } } } } } }, "/api/CountryPackageIntrastatReportingEntity": { "get": { "tags": [ "CountryPackageIntrastatReportingEntity" ], "summary": "CountryPackageIntrastatReportingEntity: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatReportingEntity-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatReportingEntity_GetAll_5A745488C642", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatReportingEntity" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatReportingEntity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatReportingEntity" } } } } } }, "post": { "tags": [ "CountryPackageIntrastatReportingEntity" ], "summary": "CountryPackageIntrastatReportingEntity: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatReportingEntity-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatReportingEntity_Post_BB8F5B41907C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatReportingEntity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatReportingEntity" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatReportingEntity" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatReportingEntity" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatReportingEntity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatReportingEntity" } } } } } }, "put": { "tags": [ "CountryPackageIntrastatReportingEntity" ], "summary": "CountryPackageIntrastatReportingEntity: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatReportingEntity-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatReportingEntity_Put_168C369A7B72", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatReportingEntity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatReportingEntity" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatReportingEntity" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatReportingEntity" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatReportingEntity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatReportingEntity" } } } } } } }, "/api/CountryPackageIntrastatReportingEntity/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "CountryPackageIntrastatReportingEntity" ], "summary": "CountryPackageIntrastatReportingEntity: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatReportingEntity-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatReportingEntity_GetPageByValue_7A0A187E584D", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CountryPackageIntrastatReportingEntity/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "CountryPackageIntrastatReportingEntity" ], "summary": "CountryPackageIntrastatReportingEntity: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatReportingEntity-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatReportingEntity_GetPageByValue2_0CEFA0CD452C", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CountryPackageIntrastatReportingEntity/DeleteByFilter": { "post": { "tags": [ "CountryPackageIntrastatReportingEntity" ], "summary": "CountryPackageIntrastatReportingEntity: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatReportingEntity-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatReportingEntity_DeleteByFilter_553989BB6407", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/CountryPackageIntrastatReportingEntity/GetAllByValue": { "post": { "tags": [ "CountryPackageIntrastatReportingEntity" ], "summary": "CountryPackageIntrastatReportingEntity: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatReportingEntity-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatReportingEntity_GetAllByValue_38719A8D4D2D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatReportingEntity" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatReportingEntity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatReportingEntity" } } } } } } }, "/api/CountryPackageIntrastatReportingEntity/GetAllGraphByValue": { "post": { "tags": [ "CountryPackageIntrastatReportingEntity" ], "summary": "CountryPackageIntrastatReportingEntity: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatReportingEntity-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatReportingEntity_GetAllGraphByValue_43907EEF53EC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatReportingEntity" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatReportingEntity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatReportingEntity" } } } } } } }, "/api/CountryPackageIntrastatReportingEntity/GetByValue": { "post": { "tags": [ "CountryPackageIntrastatReportingEntity" ], "summary": "CountryPackageIntrastatReportingEntity: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatReportingEntity-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatReportingEntity_GetByValue_E34E96B54565", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatReportingEntity" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatReportingEntity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatReportingEntity" } } } } } } }, "/api/CountryPackageIntrastatReportingEntity/GetFederalStates": { "get": { "tags": [ "CountryPackageIntrastatReportingEntity" ], "summary": "CountryPackageIntrastatReportingEntity: GetFederalStates", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatReportingEntity-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatReportingEntity_GetFederalStates_8F5975FBE006", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminFederalState" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminFederalState" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminFederalState" } } } } } } }, "/api/CountryPackageIntrastatReportingEntity/GetLookup": { "post": { "tags": [ "CountryPackageIntrastatReportingEntity" ], "summary": "CountryPackageIntrastatReportingEntity: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatReportingEntity-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatReportingEntity_GetLookup_9164673A5361", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/CountryPackageIntrastatReportingEntity/GetLookupByValue": { "post": { "tags": [ "CountryPackageIntrastatReportingEntity" ], "summary": "CountryPackageIntrastatReportingEntity: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatReportingEntity-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatReportingEntity_GetLookupByValue_C542ECB17E42", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/CountryPackageIntrastatReportingEntity/Page": { "get": { "tags": [ "CountryPackageIntrastatReportingEntity" ], "summary": "CountryPackageIntrastatReportingEntity: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatReportingEntity-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatReportingEntity_GetPage_A6233DA003C0", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CountryPackageIntrastatReportingEntity/PageAsc": { "get": { "tags": [ "CountryPackageIntrastatReportingEntity" ], "summary": "CountryPackageIntrastatReportingEntity: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatReportingEntity-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatReportingEntity_GetPageAsc_DE41C4069DB1", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CountryPackageIntrastatReportingEntity/SearchByValue": { "post": { "tags": [ "CountryPackageIntrastatReportingEntity" ], "summary": "CountryPackageIntrastatReportingEntity: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatReportingEntity-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatReportingEntity_SearchByValue_FDB45F55F6C3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CountryPackageIntrastatReportingEntity" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CountryPackageIntrastatReportingEntity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CountryPackageIntrastatReportingEntity" } } } } } } }, "/api/CountryPackageIntrastatReportingEntity/TryGetByValue": { "post": { "tags": [ "CountryPackageIntrastatReportingEntity" ], "summary": "CountryPackageIntrastatReportingEntity: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatReportingEntity-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatReportingEntity_TryGetByValue_83C5214DB8D7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatReportingEntity" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatReportingEntity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatReportingEntity" } } } } } } }, "/api/CountryPackageIntrastatReportingEntity/UpsertGraph": { "put": { "tags": [ "CountryPackageIntrastatReportingEntity" ], "summary": "CountryPackageIntrastatReportingEntity: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatReportingEntity-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatReportingEntity_UpsertGraph_ACFC7A28A3D5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatReportingEntity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatReportingEntity" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatReportingEntity" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatReportingEntity" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatReportingEntity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatReportingEntity" } } } } } } }, "/api/CountryPackageIntrastatReportingEntity/UpsertGraphWithExtraFields": { "put": { "tags": [ "CountryPackageIntrastatReportingEntity" ], "summary": "CountryPackageIntrastatReportingEntity: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatReportingEntity-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatReportingEntity_UpsertGraphWithExtraFields_9B4D4CDEF731", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatReportingEntity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatReportingEntity" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatReportingEntity" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatReportingEntity" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatReportingEntity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatReportingEntity" } } } } } } }, "/api/CountryPackageIntrastatTransactionType": { "get": { "tags": [ "CountryPackageIntrastatTransactionType" ], "summary": "CountryPackageIntrastatTransactionType: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatTransactionType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatTransactionType_GetAll_35B921611F2E", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatTransactionType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatTransactionType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatTransactionType" } } } } } }, "post": { "tags": [ "CountryPackageIntrastatTransactionType" ], "summary": "CountryPackageIntrastatTransactionType: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatTransactionType-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatTransactionType_Post_01072A8ABB68", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatTransactionType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatTransactionType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatTransactionType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatTransactionType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatTransactionType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatTransactionType" } } } } } }, "put": { "tags": [ "CountryPackageIntrastatTransactionType" ], "summary": "CountryPackageIntrastatTransactionType: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatTransactionType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatTransactionType_Put_1A2DE1D00213", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatTransactionType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatTransactionType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatTransactionType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatTransactionType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatTransactionType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatTransactionType" } } } } } } }, "/api/CountryPackageIntrastatTransactionType/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "CountryPackageIntrastatTransactionType" ], "summary": "CountryPackageIntrastatTransactionType: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatTransactionType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatTransactionType_GetPageByValue_ED1AF61413A5", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CountryPackageIntrastatTransactionType/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "CountryPackageIntrastatTransactionType" ], "summary": "CountryPackageIntrastatTransactionType: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatTransactionType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatTransactionType_GetPageByValue2_4054EE0980C1", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CountryPackageIntrastatTransactionType/DeleteByFilter": { "post": { "tags": [ "CountryPackageIntrastatTransactionType" ], "summary": "CountryPackageIntrastatTransactionType: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatTransactionType-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatTransactionType_DeleteByFilter_8B993317BA61", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/CountryPackageIntrastatTransactionType/GetAllByValue": { "post": { "tags": [ "CountryPackageIntrastatTransactionType" ], "summary": "CountryPackageIntrastatTransactionType: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatTransactionType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatTransactionType_GetAllByValue_1F1A3738B7D4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatTransactionType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatTransactionType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatTransactionType" } } } } } } }, "/api/CountryPackageIntrastatTransactionType/GetAllGraphByValue": { "post": { "tags": [ "CountryPackageIntrastatTransactionType" ], "summary": "CountryPackageIntrastatTransactionType: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatTransactionType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatTransactionType_GetAllGraphByValue_9BD9EEB5AFBD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatTransactionType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatTransactionType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatTransactionType" } } } } } } }, "/api/CountryPackageIntrastatTransactionType/GetByValue": { "post": { "tags": [ "CountryPackageIntrastatTransactionType" ], "summary": "CountryPackageIntrastatTransactionType: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatTransactionType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatTransactionType_GetByValue_990ED0B82BF1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatTransactionType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatTransactionType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatTransactionType" } } } } } } }, "/api/CountryPackageIntrastatTransactionType/GetLookup": { "post": { "tags": [ "CountryPackageIntrastatTransactionType" ], "summary": "CountryPackageIntrastatTransactionType: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatTransactionType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatTransactionType_GetLookup_A13874BC9C64", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/CountryPackageIntrastatTransactionType/GetLookupByValue": { "post": { "tags": [ "CountryPackageIntrastatTransactionType" ], "summary": "CountryPackageIntrastatTransactionType: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatTransactionType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatTransactionType_GetLookupByValue_6F64870B4BF4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/CountryPackageIntrastatTransactionType/Page": { "get": { "tags": [ "CountryPackageIntrastatTransactionType" ], "summary": "CountryPackageIntrastatTransactionType: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatTransactionType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatTransactionType_GetPage_E010C547346C", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CountryPackageIntrastatTransactionType/PageAsc": { "get": { "tags": [ "CountryPackageIntrastatTransactionType" ], "summary": "CountryPackageIntrastatTransactionType: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatTransactionType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatTransactionType_GetPageAsc_2F75B2F9BCB3", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CountryPackageIntrastatTransactionType/SearchByValue": { "post": { "tags": [ "CountryPackageIntrastatTransactionType" ], "summary": "CountryPackageIntrastatTransactionType: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatTransactionType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatTransactionType_SearchByValue_09448779BF6C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CountryPackageIntrastatTransactionType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CountryPackageIntrastatTransactionType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CountryPackageIntrastatTransactionType" } } } } } } }, "/api/CountryPackageIntrastatTransactionType/TryGetByValue": { "post": { "tags": [ "CountryPackageIntrastatTransactionType" ], "summary": "CountryPackageIntrastatTransactionType: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatTransactionType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatTransactionType_TryGetByValue_2428934A53F3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatTransactionType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatTransactionType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatTransactionType" } } } } } } }, "/api/CountryPackageIntrastatTransactionType/UpsertGraph": { "put": { "tags": [ "CountryPackageIntrastatTransactionType" ], "summary": "CountryPackageIntrastatTransactionType: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatTransactionType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatTransactionType_UpsertGraph_8E5CAA8FDC4C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatTransactionType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatTransactionType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatTransactionType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatTransactionType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatTransactionType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatTransactionType" } } } } } } }, "/api/CountryPackageIntrastatTransactionType/UpsertGraphWithExtraFields": { "put": { "tags": [ "CountryPackageIntrastatTransactionType" ], "summary": "CountryPackageIntrastatTransactionType: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatTransactionType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatTransactionType_UpsertGraphWithExtraFields_ED8A7DEB9C13", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatTransactionType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatTransactionType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatTransactionType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatTransactionType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatTransactionType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatTransactionType" } } } } } } }, "/api/CountryPackageIntrastatTransportMode": { "get": { "tags": [ "CountryPackageIntrastatTransportMode" ], "summary": "CountryPackageIntrastatTransportMode: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatTransportMode-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatTransportMode_GetAll_1E2416A46F70", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatTransportMode" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatTransportMode" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatTransportMode" } } } } } }, "post": { "tags": [ "CountryPackageIntrastatTransportMode" ], "summary": "CountryPackageIntrastatTransportMode: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatTransportMode-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatTransportMode_Post_1F5FCBED2BBA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatTransportMode" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatTransportMode" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatTransportMode" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatTransportMode" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatTransportMode" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatTransportMode" } } } } } }, "put": { "tags": [ "CountryPackageIntrastatTransportMode" ], "summary": "CountryPackageIntrastatTransportMode: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatTransportMode-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatTransportMode_Put_94074FA6FE02", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatTransportMode" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatTransportMode" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatTransportMode" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatTransportMode" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatTransportMode" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatTransportMode" } } } } } } }, "/api/CountryPackageIntrastatTransportMode/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "CountryPackageIntrastatTransportMode" ], "summary": "CountryPackageIntrastatTransportMode: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatTransportMode-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatTransportMode_GetPageByValue_639858E50EAA", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CountryPackageIntrastatTransportMode/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "CountryPackageIntrastatTransportMode" ], "summary": "CountryPackageIntrastatTransportMode: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatTransportMode-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatTransportMode_GetPageByValue2_C038D470DEC4", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CountryPackageIntrastatTransportMode/DeleteByFilter": { "post": { "tags": [ "CountryPackageIntrastatTransportMode" ], "summary": "CountryPackageIntrastatTransportMode: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatTransportMode-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatTransportMode_DeleteByFilter_30D0B053CA5B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/CountryPackageIntrastatTransportMode/GetAllByValue": { "post": { "tags": [ "CountryPackageIntrastatTransportMode" ], "summary": "CountryPackageIntrastatTransportMode: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatTransportMode-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatTransportMode_GetAllByValue_D21F13414E2B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatTransportMode" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatTransportMode" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatTransportMode" } } } } } } }, "/api/CountryPackageIntrastatTransportMode/GetAllGraphByValue": { "post": { "tags": [ "CountryPackageIntrastatTransportMode" ], "summary": "CountryPackageIntrastatTransportMode: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatTransportMode-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatTransportMode_GetAllGraphByValue_802A41A1AE87", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatTransportMode" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatTransportMode" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatTransportMode" } } } } } } }, "/api/CountryPackageIntrastatTransportMode/GetByValue": { "post": { "tags": [ "CountryPackageIntrastatTransportMode" ], "summary": "CountryPackageIntrastatTransportMode: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatTransportMode-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatTransportMode_GetByValue_7EA0940DE911", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatTransportMode" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatTransportMode" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatTransportMode" } } } } } } }, "/api/CountryPackageIntrastatTransportMode/GetLookup": { "post": { "tags": [ "CountryPackageIntrastatTransportMode" ], "summary": "CountryPackageIntrastatTransportMode: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatTransportMode-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatTransportMode_GetLookup_C8B383E88443", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/CountryPackageIntrastatTransportMode/GetLookupByValue": { "post": { "tags": [ "CountryPackageIntrastatTransportMode" ], "summary": "CountryPackageIntrastatTransportMode: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatTransportMode-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatTransportMode_GetLookupByValue_7E2C7CF22EA0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/CountryPackageIntrastatTransportMode/Page": { "get": { "tags": [ "CountryPackageIntrastatTransportMode" ], "summary": "CountryPackageIntrastatTransportMode: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatTransportMode-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatTransportMode_GetPage_71716D9CDFFC", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CountryPackageIntrastatTransportMode/PageAsc": { "get": { "tags": [ "CountryPackageIntrastatTransportMode" ], "summary": "CountryPackageIntrastatTransportMode: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatTransportMode-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatTransportMode_GetPageAsc_30C90A941FD5", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CountryPackageIntrastatTransportMode/SearchByValue": { "post": { "tags": [ "CountryPackageIntrastatTransportMode" ], "summary": "CountryPackageIntrastatTransportMode: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatTransportMode-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatTransportMode_SearchByValue_E39369FAC6FB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CountryPackageIntrastatTransportMode" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CountryPackageIntrastatTransportMode" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CountryPackageIntrastatTransportMode" } } } } } } }, "/api/CountryPackageIntrastatTransportMode/TryGetByValue": { "post": { "tags": [ "CountryPackageIntrastatTransportMode" ], "summary": "CountryPackageIntrastatTransportMode: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatTransportMode-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatTransportMode_TryGetByValue_2D62AA78FBBD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatTransportMode" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatTransportMode" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatTransportMode" } } } } } } }, "/api/CountryPackageIntrastatTransportMode/UpsertGraph": { "put": { "tags": [ "CountryPackageIntrastatTransportMode" ], "summary": "CountryPackageIntrastatTransportMode: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatTransportMode-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatTransportMode_UpsertGraph_23E9AC1404FC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatTransportMode" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatTransportMode" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatTransportMode" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatTransportMode" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatTransportMode" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatTransportMode" } } } } } } }, "/api/CountryPackageIntrastatTransportMode/UpsertGraphWithExtraFields": { "put": { "tags": [ "CountryPackageIntrastatTransportMode" ], "summary": "CountryPackageIntrastatTransportMode: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackageIntrastatTransportMode-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackageIntrastatTransportMode_UpsertGraphWithExtraFields_107CFF70D338", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatTransportMode" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatTransportMode" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatTransportMode" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatTransportMode" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatTransportMode" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatTransportMode" } } } } } } }, "/api/CountryPackagePrivacyProcessingActivity": { "get": { "tags": [ "CountryPackagePrivacyProcessingActivity" ], "summary": "CountryPackagePrivacyProcessingActivity: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackagePrivacyProcessingActivity-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackagePrivacyProcessingActivity_GetAll_18D7BB5E000C", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackagePrivacyProcessingActivity" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackagePrivacyProcessingActivity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackagePrivacyProcessingActivity" } } } } } }, "post": { "tags": [ "CountryPackagePrivacyProcessingActivity" ], "summary": "CountryPackagePrivacyProcessingActivity: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackagePrivacyProcessingActivity-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackagePrivacyProcessingActivity_Post_33BFC901A722", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackagePrivacyProcessingActivity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackagePrivacyProcessingActivity" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackagePrivacyProcessingActivity" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackagePrivacyProcessingActivity" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackagePrivacyProcessingActivity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackagePrivacyProcessingActivity" } } } } } }, "put": { "tags": [ "CountryPackagePrivacyProcessingActivity" ], "summary": "CountryPackagePrivacyProcessingActivity: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackagePrivacyProcessingActivity-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackagePrivacyProcessingActivity_Put_577D31798EC1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackagePrivacyProcessingActivity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackagePrivacyProcessingActivity" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackagePrivacyProcessingActivity" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackagePrivacyProcessingActivity" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackagePrivacyProcessingActivity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackagePrivacyProcessingActivity" } } } } } } }, "/api/CountryPackagePrivacyProcessingActivity/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "CountryPackagePrivacyProcessingActivity" ], "summary": "CountryPackagePrivacyProcessingActivity: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackagePrivacyProcessingActivity-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackagePrivacyProcessingActivity_GetPageByValue_FBC3ECF80347", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CountryPackagePrivacyProcessingActivity/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "CountryPackagePrivacyProcessingActivity" ], "summary": "CountryPackagePrivacyProcessingActivity: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackagePrivacyProcessingActivity-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackagePrivacyProcessingActivity_GetPageByValue2_5DE4F714C8C3", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CountryPackagePrivacyProcessingActivity/DeleteByFilter": { "post": { "tags": [ "CountryPackagePrivacyProcessingActivity" ], "summary": "CountryPackagePrivacyProcessingActivity: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackagePrivacyProcessingActivity-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackagePrivacyProcessingActivity_DeleteByFilter_1F9CC3C8E1E7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/CountryPackagePrivacyProcessingActivity/GetAllByValue": { "post": { "tags": [ "CountryPackagePrivacyProcessingActivity" ], "summary": "CountryPackagePrivacyProcessingActivity: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackagePrivacyProcessingActivity-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackagePrivacyProcessingActivity_GetAllByValue_7B7EF5D80AB1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackagePrivacyProcessingActivity" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackagePrivacyProcessingActivity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackagePrivacyProcessingActivity" } } } } } } }, "/api/CountryPackagePrivacyProcessingActivity/GetAllGraphByValue": { "post": { "tags": [ "CountryPackagePrivacyProcessingActivity" ], "summary": "CountryPackagePrivacyProcessingActivity: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackagePrivacyProcessingActivity-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackagePrivacyProcessingActivity_GetAllGraphByValue_7A7F067C28A8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackagePrivacyProcessingActivity" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackagePrivacyProcessingActivity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackagePrivacyProcessingActivity" } } } } } } }, "/api/CountryPackagePrivacyProcessingActivity/GetByValue": { "post": { "tags": [ "CountryPackagePrivacyProcessingActivity" ], "summary": "CountryPackagePrivacyProcessingActivity: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackagePrivacyProcessingActivity-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackagePrivacyProcessingActivity_GetByValue_B6C89A6362C6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackagePrivacyProcessingActivity" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackagePrivacyProcessingActivity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackagePrivacyProcessingActivity" } } } } } } }, "/api/CountryPackagePrivacyProcessingActivity/GetLookup": { "post": { "tags": [ "CountryPackagePrivacyProcessingActivity" ], "summary": "CountryPackagePrivacyProcessingActivity: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackagePrivacyProcessingActivity-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackagePrivacyProcessingActivity_GetLookup_225763EEB9A9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/CountryPackagePrivacyProcessingActivity/GetLookupByValue": { "post": { "tags": [ "CountryPackagePrivacyProcessingActivity" ], "summary": "CountryPackagePrivacyProcessingActivity: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackagePrivacyProcessingActivity-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackagePrivacyProcessingActivity_GetLookupByValue_87D5F9D5D42A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/CountryPackagePrivacyProcessingActivity/Page": { "get": { "tags": [ "CountryPackagePrivacyProcessingActivity" ], "summary": "CountryPackagePrivacyProcessingActivity: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackagePrivacyProcessingActivity-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackagePrivacyProcessingActivity_GetPage_73BC7ACD9B9B", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CountryPackagePrivacyProcessingActivity/PageAsc": { "get": { "tags": [ "CountryPackagePrivacyProcessingActivity" ], "summary": "CountryPackagePrivacyProcessingActivity: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackagePrivacyProcessingActivity-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackagePrivacyProcessingActivity_GetPageAsc_3CBED0444FEC", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CountryPackagePrivacyProcessingActivity/SearchByValue": { "post": { "tags": [ "CountryPackagePrivacyProcessingActivity" ], "summary": "CountryPackagePrivacyProcessingActivity: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackagePrivacyProcessingActivity-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackagePrivacyProcessingActivity_SearchByValue_001C51D66EDA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CountryPackagePrivacyProcessingActivity" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CountryPackagePrivacyProcessingActivity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CountryPackagePrivacyProcessingActivity" } } } } } } }, "/api/CountryPackagePrivacyProcessingActivity/TryGetByValue": { "post": { "tags": [ "CountryPackagePrivacyProcessingActivity" ], "summary": "CountryPackagePrivacyProcessingActivity: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackagePrivacyProcessingActivity-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackagePrivacyProcessingActivity_TryGetByValue_3F936C032D58", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackagePrivacyProcessingActivity" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackagePrivacyProcessingActivity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackagePrivacyProcessingActivity" } } } } } } }, "/api/CountryPackagePrivacyProcessingActivity/UpsertGraph": { "put": { "tags": [ "CountryPackagePrivacyProcessingActivity" ], "summary": "CountryPackagePrivacyProcessingActivity: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackagePrivacyProcessingActivity-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackagePrivacyProcessingActivity_UpsertGraph_0C00627EED10", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackagePrivacyProcessingActivity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackagePrivacyProcessingActivity" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackagePrivacyProcessingActivity" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackagePrivacyProcessingActivity" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackagePrivacyProcessingActivity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackagePrivacyProcessingActivity" } } } } } } }, "/api/CountryPackagePrivacyProcessingActivity/UpsertGraphWithExtraFields": { "put": { "tags": [ "CountryPackagePrivacyProcessingActivity" ], "summary": "CountryPackagePrivacyProcessingActivity: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackagePrivacyProcessingActivity-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackagePrivacyProcessingActivity_UpsertGraphWithExtraFields_17567ECAC394", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackagePrivacyProcessingActivity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackagePrivacyProcessingActivity" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackagePrivacyProcessingActivity" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackagePrivacyProcessingActivity" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackagePrivacyProcessingActivity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackagePrivacyProcessingActivity" } } } } } } }, "/api/CountryPackagePrivacyProcessingActivityObject": { "get": { "tags": [ "CountryPackagePrivacyProcessingActivityObject" ], "summary": "CountryPackagePrivacyProcessingActivityObject: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackagePrivacyProcessingActivityObject-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackagePrivacyProcessingActivityObject_GetAll_CF7ED4C32BB4", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackagePrivacyProcessingActivityObject" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackagePrivacyProcessingActivityObject" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackagePrivacyProcessingActivityObject" } } } } } }, "post": { "tags": [ "CountryPackagePrivacyProcessingActivityObject" ], "summary": "CountryPackagePrivacyProcessingActivityObject: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackagePrivacyProcessingActivityObject-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackagePrivacyProcessingActivityObject_Post_5F8820EFFA89", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackagePrivacyProcessingActivityObject" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackagePrivacyProcessingActivityObject" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackagePrivacyProcessingActivityObject" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackagePrivacyProcessingActivityObject" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackagePrivacyProcessingActivityObject" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackagePrivacyProcessingActivityObject" } } } } } }, "put": { "tags": [ "CountryPackagePrivacyProcessingActivityObject" ], "summary": "CountryPackagePrivacyProcessingActivityObject: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackagePrivacyProcessingActivityObject-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackagePrivacyProcessingActivityObject_Put_0D428DB2032B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackagePrivacyProcessingActivityObject" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackagePrivacyProcessingActivityObject" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackagePrivacyProcessingActivityObject" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackagePrivacyProcessingActivityObject" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackagePrivacyProcessingActivityObject" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackagePrivacyProcessingActivityObject" } } } } } } }, "/api/CountryPackagePrivacyProcessingActivityObject/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "CountryPackagePrivacyProcessingActivityObject" ], "summary": "CountryPackagePrivacyProcessingActivityObject: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackagePrivacyProcessingActivityObject-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackagePrivacyProcessingActivityObject_GetPageByValue_DA01BB350C9D", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CountryPackagePrivacyProcessingActivityObject/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "CountryPackagePrivacyProcessingActivityObject" ], "summary": "CountryPackagePrivacyProcessingActivityObject: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackagePrivacyProcessingActivityObject-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackagePrivacyProcessingActivityObject_GetPageByValue2_06B09C3C1719", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CountryPackagePrivacyProcessingActivityObject/DeleteByFilter": { "post": { "tags": [ "CountryPackagePrivacyProcessingActivityObject" ], "summary": "CountryPackagePrivacyProcessingActivityObject: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackagePrivacyProcessingActivityObject-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackagePrivacyProcessingActivityObject_DeleteByFilter_E4881328F0DD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/CountryPackagePrivacyProcessingActivityObject/GetAllByValue": { "post": { "tags": [ "CountryPackagePrivacyProcessingActivityObject" ], "summary": "CountryPackagePrivacyProcessingActivityObject: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackagePrivacyProcessingActivityObject-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackagePrivacyProcessingActivityObject_GetAllByValue_035FB521A9DF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackagePrivacyProcessingActivityObject" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackagePrivacyProcessingActivityObject" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackagePrivacyProcessingActivityObject" } } } } } } }, "/api/CountryPackagePrivacyProcessingActivityObject/GetAllGraphByValue": { "post": { "tags": [ "CountryPackagePrivacyProcessingActivityObject" ], "summary": "CountryPackagePrivacyProcessingActivityObject: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackagePrivacyProcessingActivityObject-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackagePrivacyProcessingActivityObject_GetAllGraphByValue_50EF9CC8BEC0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackagePrivacyProcessingActivityObject" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackagePrivacyProcessingActivityObject" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackagePrivacyProcessingActivityObject" } } } } } } }, "/api/CountryPackagePrivacyProcessingActivityObject/GetByValue": { "post": { "tags": [ "CountryPackagePrivacyProcessingActivityObject" ], "summary": "CountryPackagePrivacyProcessingActivityObject: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackagePrivacyProcessingActivityObject-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackagePrivacyProcessingActivityObject_GetByValue_7B54E75659F6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackagePrivacyProcessingActivityObject" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackagePrivacyProcessingActivityObject" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackagePrivacyProcessingActivityObject" } } } } } } }, "/api/CountryPackagePrivacyProcessingActivityObject/GetLookup": { "post": { "tags": [ "CountryPackagePrivacyProcessingActivityObject" ], "summary": "CountryPackagePrivacyProcessingActivityObject: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackagePrivacyProcessingActivityObject-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackagePrivacyProcessingActivityObject_GetLookup_E6DC47E62BE6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/CountryPackagePrivacyProcessingActivityObject/GetLookupByValue": { "post": { "tags": [ "CountryPackagePrivacyProcessingActivityObject" ], "summary": "CountryPackagePrivacyProcessingActivityObject: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackagePrivacyProcessingActivityObject-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackagePrivacyProcessingActivityObject_GetLookupByValue_1BF139424DCF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/CountryPackagePrivacyProcessingActivityObject/Page": { "get": { "tags": [ "CountryPackagePrivacyProcessingActivityObject" ], "summary": "CountryPackagePrivacyProcessingActivityObject: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackagePrivacyProcessingActivityObject-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackagePrivacyProcessingActivityObject_GetPage_818853E087D5", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CountryPackagePrivacyProcessingActivityObject/PageAsc": { "get": { "tags": [ "CountryPackagePrivacyProcessingActivityObject" ], "summary": "CountryPackagePrivacyProcessingActivityObject: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackagePrivacyProcessingActivityObject-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackagePrivacyProcessingActivityObject_GetPageAsc_6BB46C4D195B", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CountryPackagePrivacyProcessingActivityObject/SearchByValue": { "post": { "tags": [ "CountryPackagePrivacyProcessingActivityObject" ], "summary": "CountryPackagePrivacyProcessingActivityObject: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackagePrivacyProcessingActivityObject-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackagePrivacyProcessingActivityObject_SearchByValue_8499A46D4044", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CountryPackagePrivacyProcessingActivityObject" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CountryPackagePrivacyProcessingActivityObject" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CountryPackagePrivacyProcessingActivityObject" } } } } } } }, "/api/CountryPackagePrivacyProcessingActivityObject/TryGetByValue": { "post": { "tags": [ "CountryPackagePrivacyProcessingActivityObject" ], "summary": "CountryPackagePrivacyProcessingActivityObject: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackagePrivacyProcessingActivityObject-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackagePrivacyProcessingActivityObject_TryGetByValue_4B52747B14B3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackagePrivacyProcessingActivityObject" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackagePrivacyProcessingActivityObject" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackagePrivacyProcessingActivityObject" } } } } } } }, "/api/CountryPackagePrivacyProcessingActivityObject/UpsertGraph": { "put": { "tags": [ "CountryPackagePrivacyProcessingActivityObject" ], "summary": "CountryPackagePrivacyProcessingActivityObject: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackagePrivacyProcessingActivityObject-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackagePrivacyProcessingActivityObject_UpsertGraph_30E0DFE4516D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackagePrivacyProcessingActivityObject" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackagePrivacyProcessingActivityObject" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackagePrivacyProcessingActivityObject" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackagePrivacyProcessingActivityObject" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackagePrivacyProcessingActivityObject" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackagePrivacyProcessingActivityObject" } } } } } } }, "/api/CountryPackagePrivacyProcessingActivityObject/UpsertGraphWithExtraFields": { "put": { "tags": [ "CountryPackagePrivacyProcessingActivityObject" ], "summary": "CountryPackagePrivacyProcessingActivityObject: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CountryPackagePrivacyProcessingActivityObject-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CountryPackagePrivacyProcessingActivityObject_UpsertGraphWithExtraFields_DC8BD65E52C2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackagePrivacyProcessingActivityObject" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackagePrivacyProcessingActivityObject" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackagePrivacyProcessingActivityObject" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackagePrivacyProcessingActivityObject" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackagePrivacyProcessingActivityObject" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackagePrivacyProcessingActivityObject" } } } } } } }, "/api/Crm": { "get": { "tags": [ "Crm" ], "summary": "Crm: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Crm-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Crm_GetAll_DD27BBDD345F", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Crm" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Crm" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Crm" } } } } } }, "post": { "tags": [ "Crm" ], "summary": "Crm: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Crm-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Crm_Post_4E1840E72753", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Crm" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Crm" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Crm" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Crm" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Crm" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Crm" } } } } } }, "put": { "tags": [ "Crm" ], "summary": "Crm: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Crm-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Crm_Put_F6E0CADE4010", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Crm" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Crm" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Crm" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Crm" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Crm" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Crm" } } } } } } }, "/api/Crm/{PartnerId}/PageFromViewByPartnerId": { "get": { "tags": [ "Crm" ], "summary": "Crm: GetPageFromViewByPartnerId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Crm-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Crm_GetPageFromViewByPartnerId_303AA8DDE9EE", "parameters": [ { "name": "PartnerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Crm/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "Crm" ], "summary": "Crm: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Crm-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Crm_GetPageByValue_C70B75C41603", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Crm/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "Crm" ], "summary": "Crm: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Crm-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Crm_GetPageByValue2_00422E45FD24", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Crm/DeleteByFilter": { "post": { "tags": [ "Crm" ], "summary": "Crm: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Crm-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Crm_DeleteByFilter_8A8A954F81A5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/Crm/GetAllByValue": { "post": { "tags": [ "Crm" ], "summary": "Crm: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Crm-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Crm_GetAllByValue_855CA8A688CD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Crm" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Crm" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Crm" } } } } } } }, "/api/Crm/GetAllGraphByValue": { "post": { "tags": [ "Crm" ], "summary": "Crm: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Crm-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Crm_GetAllGraphByValue_334D6032F6C8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Crm" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Crm" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Crm" } } } } } } }, "/api/Crm/GetByValue": { "post": { "tags": [ "Crm" ], "summary": "Crm: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Crm-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Crm_GetByValue_3319DB51DD20", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Crm" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Crm" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Crm" } } } } } } }, "/api/Crm/GetLookup": { "post": { "tags": [ "Crm" ], "summary": "Crm: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Crm-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Crm_GetLookup_DABC22CFA42B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/Crm/GetLookupByValue": { "post": { "tags": [ "Crm" ], "summary": "Crm: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Crm-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Crm_GetLookupByValue_F7BE92841DE0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/Crm/Page": { "get": { "tags": [ "Crm" ], "summary": "Crm: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Crm-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Crm_GetPage_CF447EC7ED09", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Crm/PageAsc": { "get": { "tags": [ "Crm" ], "summary": "Crm: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Crm-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Crm_GetPageAsc_6A86A597AB23", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Crm/PageFromView/{GroupId}/{IncludeSubNodes}/{activeOnly}/{favoriteOnly}": { "get": { "tags": [ "Crm" ], "summary": "Crm: GetPageFromView", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Crm-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Crm_GetPageFromView_35DE4352EE30", "parameters": [ { "name": "GroupId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "IncludeSubNodes", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "activeOnly", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "favoriteOnly", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Crm/SearchByValue": { "post": { "tags": [ "Crm" ], "summary": "Crm: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Crm-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Crm_SearchByValue_8976CC727333", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.Crm" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.Crm" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.Crm" } } } } } } }, "/api/Crm/TryGetByValue": { "post": { "tags": [ "Crm" ], "summary": "Crm: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Crm-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Crm_TryGetByValue_2AD655E30857", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Crm" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Crm" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Crm" } } } } } } }, "/api/Crm/UpsertGraph": { "put": { "tags": [ "Crm" ], "summary": "Crm: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Crm-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Crm_UpsertGraph_96A6F00966C0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Crm" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Crm" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Crm" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Crm" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Crm" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Crm" } } } } } } }, "/api/Crm/UpsertGraphWithExtraFields": { "put": { "tags": [ "Crm" ], "summary": "Crm: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Crm-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Crm_UpsertGraphWithExtraFields_8AC2142B970C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Crm" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Crm" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Crm" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Crm" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Crm" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Crm" } } } } } } }, "/api/CrmActivity": { "get": { "tags": [ "CrmActivity" ], "summary": "CrmActivity: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CrmActivity-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CrmActivity_GetAll_E7A196438595", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CrmActivity" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CrmActivity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CrmActivity" } } } } } }, "post": { "tags": [ "CrmActivity" ], "summary": "CrmActivity: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CrmActivity-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CrmActivity_Post_0809D12F9364", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CrmActivity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CrmActivity" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CrmActivity" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CrmActivity" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CrmActivity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CrmActivity" } } } } } }, "put": { "tags": [ "CrmActivity" ], "summary": "CrmActivity: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CrmActivity-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CrmActivity_Put_C105932E4CFB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CrmActivity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CrmActivity" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CrmActivity" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CrmActivity" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CrmActivity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CrmActivity" } } } } } } }, "/api/CrmActivity/{PartnerId}/PageFromViewByPartnerId": { "get": { "tags": [ "CrmActivity" ], "summary": "CrmActivity: GetPageFromViewByArticleId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CrmActivity-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CrmActivity_GetPageFromViewByArticleId_FAD62C5BED48", "parameters": [ { "name": "PartnerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CrmActivity/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "CrmActivity" ], "summary": "CrmActivity: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CrmActivity-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CrmActivity_GetPageByValue_AD60E0CD18E4", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CrmActivity/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "CrmActivity" ], "summary": "CrmActivity: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CrmActivity-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CrmActivity_GetPageByValue2_DCF49AF77476", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CrmActivity/DeleteByFilter": { "post": { "tags": [ "CrmActivity" ], "summary": "CrmActivity: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CrmActivity-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CrmActivity_DeleteByFilter_85CDBE97BB5D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/CrmActivity/GetAllByValue": { "post": { "tags": [ "CrmActivity" ], "summary": "CrmActivity: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CrmActivity-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CrmActivity_GetAllByValue_B3E6CBB7D257", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CrmActivity" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CrmActivity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CrmActivity" } } } } } } }, "/api/CrmActivity/GetAllGraphByValue": { "post": { "tags": [ "CrmActivity" ], "summary": "CrmActivity: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CrmActivity-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CrmActivity_GetAllGraphByValue_1AB7076FEB1A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CrmActivity" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CrmActivity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CrmActivity" } } } } } } }, "/api/CrmActivity/GetByValue": { "post": { "tags": [ "CrmActivity" ], "summary": "CrmActivity: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CrmActivity-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CrmActivity_GetByValue_61FB6970E44F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CrmActivity" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CrmActivity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CrmActivity" } } } } } } }, "/api/CrmActivity/GetLookup": { "post": { "tags": [ "CrmActivity" ], "summary": "CrmActivity: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CrmActivity-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CrmActivity_GetLookup_E01FD00755DF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/CrmActivity/GetLookupByValue": { "post": { "tags": [ "CrmActivity" ], "summary": "CrmActivity: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CrmActivity-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CrmActivity_GetLookupByValue_82EAA55BCC25", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/CrmActivity/Page": { "get": { "tags": [ "CrmActivity" ], "summary": "CrmActivity: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CrmActivity-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CrmActivity_GetPage_0F472D1CA5F7", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CrmActivity/PageAsc": { "get": { "tags": [ "CrmActivity" ], "summary": "CrmActivity: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CrmActivity-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CrmActivity_GetPageAsc_FC105274AC34", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CrmActivity/SearchByValue": { "post": { "tags": [ "CrmActivity" ], "summary": "CrmActivity: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CrmActivity-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CrmActivity_SearchByValue_4CE722D89427", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CrmActivity" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CrmActivity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CrmActivity" } } } } } } }, "/api/CrmActivity/TryGetByValue": { "post": { "tags": [ "CrmActivity" ], "summary": "CrmActivity: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CrmActivity-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CrmActivity_TryGetByValue_1BE7B2A2623A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CrmActivity" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CrmActivity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CrmActivity" } } } } } } }, "/api/CrmActivity/UpsertGraph": { "put": { "tags": [ "CrmActivity" ], "summary": "CrmActivity: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CrmActivity-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CrmActivity_UpsertGraph_FB24EAC7B000", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CrmActivity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CrmActivity" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CrmActivity" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CrmActivity" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CrmActivity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CrmActivity" } } } } } } }, "/api/CrmActivity/UpsertGraphWithExtraFields": { "put": { "tags": [ "CrmActivity" ], "summary": "CrmActivity: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CrmActivity-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CrmActivity_UpsertGraphWithExtraFields_1EE0782CA8A8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CrmActivity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CrmActivity" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CrmActivity" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CrmActivity" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CrmActivity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CrmActivity" } } } } } } }, "/api/CrmActivityType": { "get": { "tags": [ "CrmActivityType" ], "summary": "CrmActivityType: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CrmActivityType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CrmActivityType_GetAll_51E7CDEF04BD", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CrmActivityType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CrmActivityType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CrmActivityType" } } } } } }, "post": { "tags": [ "CrmActivityType" ], "summary": "CrmActivityType: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CrmActivityType-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CrmActivityType_Post_D919C3BC035D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CrmActivityType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CrmActivityType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CrmActivityType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CrmActivityType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CrmActivityType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CrmActivityType" } } } } } }, "put": { "tags": [ "CrmActivityType" ], "summary": "CrmActivityType: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CrmActivityType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CrmActivityType_Put_12908F4DE9B8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CrmActivityType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CrmActivityType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CrmActivityType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CrmActivityType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CrmActivityType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CrmActivityType" } } } } } } }, "/api/CrmActivityType/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "CrmActivityType" ], "summary": "CrmActivityType: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CrmActivityType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CrmActivityType_GetPageByValue_777AB9F327CE", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CrmActivityType/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "CrmActivityType" ], "summary": "CrmActivityType: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CrmActivityType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CrmActivityType_GetPageByValue2_34265FE7C57F", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CrmActivityType/DeleteByFilter": { "post": { "tags": [ "CrmActivityType" ], "summary": "CrmActivityType: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CrmActivityType-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CrmActivityType_DeleteByFilter_6EE300B2E7E9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/CrmActivityType/GetAllByValue": { "post": { "tags": [ "CrmActivityType" ], "summary": "CrmActivityType: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CrmActivityType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CrmActivityType_GetAllByValue_BE399B53FB65", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CrmActivityType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CrmActivityType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CrmActivityType" } } } } } } }, "/api/CrmActivityType/GetAllGraphByValue": { "post": { "tags": [ "CrmActivityType" ], "summary": "CrmActivityType: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CrmActivityType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CrmActivityType_GetAllGraphByValue_753027F62AB1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CrmActivityType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CrmActivityType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CrmActivityType" } } } } } } }, "/api/CrmActivityType/GetByValue": { "post": { "tags": [ "CrmActivityType" ], "summary": "CrmActivityType: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CrmActivityType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CrmActivityType_GetByValue_D8602B593317", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CrmActivityType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CrmActivityType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CrmActivityType" } } } } } } }, "/api/CrmActivityType/GetLookup": { "post": { "tags": [ "CrmActivityType" ], "summary": "CrmActivityType: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CrmActivityType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CrmActivityType_GetLookup_99C8F0EE460D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/CrmActivityType/GetLookupByValue": { "post": { "tags": [ "CrmActivityType" ], "summary": "CrmActivityType: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CrmActivityType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CrmActivityType_GetLookupByValue_4F5DC4E2F10F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/CrmActivityType/Page": { "get": { "tags": [ "CrmActivityType" ], "summary": "CrmActivityType: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CrmActivityType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CrmActivityType_GetPage_4CA40DE6B0C5", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CrmActivityType/PageAsc": { "get": { "tags": [ "CrmActivityType" ], "summary": "CrmActivityType: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CrmActivityType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CrmActivityType_GetPageAsc_E009823A3EDC", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CrmActivityType/SearchByValue": { "post": { "tags": [ "CrmActivityType" ], "summary": "CrmActivityType: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CrmActivityType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CrmActivityType_SearchByValue_8828E1ACE7C2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CrmActivityType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CrmActivityType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CrmActivityType" } } } } } } }, "/api/CrmActivityType/TryGetByValue": { "post": { "tags": [ "CrmActivityType" ], "summary": "CrmActivityType: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CrmActivityType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CrmActivityType_TryGetByValue_7DC3FA558499", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CrmActivityType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CrmActivityType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CrmActivityType" } } } } } } }, "/api/CrmActivityType/UpsertGraph": { "put": { "tags": [ "CrmActivityType" ], "summary": "CrmActivityType: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CrmActivityType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CrmActivityType_UpsertGraph_548F5B2B677D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CrmActivityType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CrmActivityType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CrmActivityType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CrmActivityType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CrmActivityType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CrmActivityType" } } } } } } }, "/api/CrmActivityType/UpsertGraphWithExtraFields": { "put": { "tags": [ "CrmActivityType" ], "summary": "CrmActivityType: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CrmActivityType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CrmActivityType_UpsertGraphWithExtraFields_33BE1AED6CCC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CrmActivityType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CrmActivityType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CrmActivityType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CrmActivityType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CrmActivityType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CrmActivityType" } } } } } } }, "/api/CrmGroup": { "get": { "tags": [ "CrmGroup" ], "summary": "CrmGroup: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CrmGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CrmGroup_GetAll_7EA84F083C61", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CrmGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CrmGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CrmGroup" } } } } } }, "post": { "tags": [ "CrmGroup" ], "summary": "CrmGroup: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CrmGroup-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CrmGroup_Post_84B2EAA1F2D1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CrmGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CrmGroup" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CrmGroup" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CrmGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CrmGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CrmGroup" } } } } } }, "put": { "tags": [ "CrmGroup" ], "summary": "CrmGroup: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CrmGroup-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CrmGroup_Put_533E4B86E90D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CrmGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CrmGroup" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CrmGroup" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CrmGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CrmGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CrmGroup" } } } } } } }, "/api/CrmGroup/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "CrmGroup" ], "summary": "CrmGroup: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CrmGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CrmGroup_GetPageByValue_556125F9A6F4", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CrmGroup/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "CrmGroup" ], "summary": "CrmGroup: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CrmGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CrmGroup_GetPageByValue2_89DD575E5258", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CrmGroup/DeleteByFilter": { "post": { "tags": [ "CrmGroup" ], "summary": "CrmGroup: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CrmGroup-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CrmGroup_DeleteByFilter_C8116D21A0C8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/CrmGroup/GetAllByValue": { "post": { "tags": [ "CrmGroup" ], "summary": "CrmGroup: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CrmGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CrmGroup_GetAllByValue_1ED5D2D83AB7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CrmGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CrmGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CrmGroup" } } } } } } }, "/api/CrmGroup/GetAllGraphByValue": { "post": { "tags": [ "CrmGroup" ], "summary": "CrmGroup: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CrmGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CrmGroup_GetAllGraphByValue_CE1EB369ED62", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CrmGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CrmGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CrmGroup" } } } } } } }, "/api/CrmGroup/GetByValue": { "post": { "tags": [ "CrmGroup" ], "summary": "CrmGroup: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CrmGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CrmGroup_GetByValue_07FC0785E338", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CrmGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CrmGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CrmGroup" } } } } } } }, "/api/CrmGroup/GetLookup": { "post": { "tags": [ "CrmGroup" ], "summary": "CrmGroup: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CrmGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CrmGroup_GetLookup_179B6551B6BD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/CrmGroup/GetLookupByValue": { "post": { "tags": [ "CrmGroup" ], "summary": "CrmGroup: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CrmGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CrmGroup_GetLookupByValue_7985A68F96C8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/CrmGroup/Page": { "get": { "tags": [ "CrmGroup" ], "summary": "CrmGroup: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CrmGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CrmGroup_GetPage_38B0ACC3D395", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CrmGroup/PageAsc": { "get": { "tags": [ "CrmGroup" ], "summary": "CrmGroup: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CrmGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CrmGroup_GetPageAsc_884A86490B04", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CrmGroup/PageCrmGroupsByParent/{ParentId}/{IncludeSubNodes}/{TopParentsOnly}": { "get": { "tags": [ "CrmGroup" ], "summary": "CrmGroup: GetPageCrmGroupsByParent", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CrmGroup-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CrmGroup_GetPageCrmGroupsByParent_EB9089856A10", "parameters": [ { "name": "ParentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "IncludeSubNodes", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "TopParentsOnly", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CrmGroup/SearchByValue": { "post": { "tags": [ "CrmGroup" ], "summary": "CrmGroup: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CrmGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CrmGroup_SearchByValue_9D6EF070D87A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CrmGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CrmGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CrmGroup" } } } } } } }, "/api/CrmGroup/TryGetByValue": { "post": { "tags": [ "CrmGroup" ], "summary": "CrmGroup: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CrmGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CrmGroup_TryGetByValue_E54450785E3A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CrmGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CrmGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CrmGroup" } } } } } } }, "/api/CrmGroup/UpsertGraph": { "put": { "tags": [ "CrmGroup" ], "summary": "CrmGroup: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CrmGroup-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CrmGroup_UpsertGraph_4602C3F5790F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CrmGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CrmGroup" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CrmGroup" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CrmGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CrmGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CrmGroup" } } } } } } }, "/api/CrmGroup/UpsertGraphWithExtraFields": { "put": { "tags": [ "CrmGroup" ], "summary": "CrmGroup: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CrmGroup-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CrmGroup_UpsertGraphWithExtraFields_FB8CAB8D607F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CrmGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CrmGroup" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CrmGroup" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CrmGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CrmGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CrmGroup" } } } } } } }, "/api/CrmStatus": { "get": { "tags": [ "CrmStatus" ], "summary": "CrmStatus: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CrmStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CrmStatus_GetAll_E12A0F9EB7BC", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CrmStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CrmStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CrmStatus" } } } } } }, "post": { "tags": [ "CrmStatus" ], "summary": "CrmStatus: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CrmStatus-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CrmStatus_Post_14B3C60704B0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CrmStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CrmStatus" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CrmStatus" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CrmStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CrmStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CrmStatus" } } } } } }, "put": { "tags": [ "CrmStatus" ], "summary": "CrmStatus: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CrmStatus-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CrmStatus_Put_1BABE76C971A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CrmStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CrmStatus" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CrmStatus" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CrmStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CrmStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CrmStatus" } } } } } } }, "/api/CrmStatus/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "CrmStatus" ], "summary": "CrmStatus: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CrmStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CrmStatus_GetPageByValue_DD84FC72B939", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CrmStatus/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "CrmStatus" ], "summary": "CrmStatus: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CrmStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CrmStatus_GetPageByValue2_771BAB1E0C82", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CrmStatus/DeleteByFilter": { "post": { "tags": [ "CrmStatus" ], "summary": "CrmStatus: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CrmStatus-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CrmStatus_DeleteByFilter_E7F1B697F78C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/CrmStatus/GetAllByValue": { "post": { "tags": [ "CrmStatus" ], "summary": "CrmStatus: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CrmStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CrmStatus_GetAllByValue_F2986D12B93E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CrmStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CrmStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CrmStatus" } } } } } } }, "/api/CrmStatus/GetAllGraphByValue": { "post": { "tags": [ "CrmStatus" ], "summary": "CrmStatus: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CrmStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CrmStatus_GetAllGraphByValue_5F66AE4453AD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CrmStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CrmStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CrmStatus" } } } } } } }, "/api/CrmStatus/GetByValue": { "post": { "tags": [ "CrmStatus" ], "summary": "CrmStatus: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CrmStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CrmStatus_GetByValue_BB7C8A9D6109", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CrmStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CrmStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CrmStatus" } } } } } } }, "/api/CrmStatus/GetLookup": { "post": { "tags": [ "CrmStatus" ], "summary": "CrmStatus: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CrmStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CrmStatus_GetLookup_003B22E62079", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/CrmStatus/GetLookupByValue": { "post": { "tags": [ "CrmStatus" ], "summary": "CrmStatus: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CrmStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CrmStatus_GetLookupByValue_3DB4430224F1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/CrmStatus/Page": { "get": { "tags": [ "CrmStatus" ], "summary": "CrmStatus: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CrmStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CrmStatus_GetPage_89EBB69DB2F4", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CrmStatus/PageAsc": { "get": { "tags": [ "CrmStatus" ], "summary": "CrmStatus: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CrmStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CrmStatus_GetPageAsc_93DE0213D993", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CrmStatus/SearchByValue": { "post": { "tags": [ "CrmStatus" ], "summary": "CrmStatus: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CrmStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CrmStatus_SearchByValue_4EB5E7EC5A05", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CrmStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CrmStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CrmStatus" } } } } } } }, "/api/CrmStatus/TryGetByValue": { "post": { "tags": [ "CrmStatus" ], "summary": "CrmStatus: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CrmStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CrmStatus_TryGetByValue_3C4D9B9E2B23", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CrmStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CrmStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CrmStatus" } } } } } } }, "/api/CrmStatus/UpsertGraph": { "put": { "tags": [ "CrmStatus" ], "summary": "CrmStatus: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CrmStatus-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CrmStatus_UpsertGraph_B32DA2CEA9FD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CrmStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CrmStatus" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CrmStatus" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CrmStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CrmStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CrmStatus" } } } } } } }, "/api/CrmStatus/UpsertGraphWithExtraFields": { "put": { "tags": [ "CrmStatus" ], "summary": "CrmStatus: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CrmStatus-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CrmStatus_UpsertGraphWithExtraFields_9E36F8898640", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CrmStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CrmStatus" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CrmStatus" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CrmStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CrmStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CrmStatus" } } } } } } }, "/api/CrmType": { "get": { "tags": [ "CrmType" ], "summary": "CrmType: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CrmType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CrmType_GetAll_D25F280BC3EA", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CrmType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CrmType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CrmType" } } } } } }, "post": { "tags": [ "CrmType" ], "summary": "CrmType: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CrmType-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CrmType_Post_132E523FEF11", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CrmType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CrmType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CrmType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CrmType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CrmType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CrmType" } } } } } }, "put": { "tags": [ "CrmType" ], "summary": "CrmType: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CrmType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CrmType_Put_4DB2E8CB8600", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CrmType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CrmType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CrmType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CrmType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CrmType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CrmType" } } } } } } }, "/api/CrmType/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "CrmType" ], "summary": "CrmType: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CrmType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CrmType_GetPageByValue_45E082C8470A", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CrmType/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "CrmType" ], "summary": "CrmType: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CrmType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CrmType_GetPageByValue2_2133A3C8E44E", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CrmType/DeleteByFilter": { "post": { "tags": [ "CrmType" ], "summary": "CrmType: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CrmType-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CrmType_DeleteByFilter_993BC9CF3A2A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/CrmType/GetAllByValue": { "post": { "tags": [ "CrmType" ], "summary": "CrmType: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CrmType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CrmType_GetAllByValue_EE22409245F0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CrmType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CrmType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CrmType" } } } } } } }, "/api/CrmType/GetAllGraphByValue": { "post": { "tags": [ "CrmType" ], "summary": "CrmType: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CrmType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CrmType_GetAllGraphByValue_90C050889629", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CrmType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CrmType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CrmType" } } } } } } }, "/api/CrmType/GetByValue": { "post": { "tags": [ "CrmType" ], "summary": "CrmType: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CrmType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CrmType_GetByValue_615843E4CAC5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CrmType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CrmType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CrmType" } } } } } } }, "/api/CrmType/GetLookup": { "post": { "tags": [ "CrmType" ], "summary": "CrmType: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CrmType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CrmType_GetLookup_EC8DB3E0657D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/CrmType/GetLookupByValue": { "post": { "tags": [ "CrmType" ], "summary": "CrmType: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CrmType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CrmType_GetLookupByValue_D43351BFB2FD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/CrmType/Page": { "get": { "tags": [ "CrmType" ], "summary": "CrmType: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CrmType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CrmType_GetPage_9BCEC172F632", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CrmType/PageAsc": { "get": { "tags": [ "CrmType" ], "summary": "CrmType: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CrmType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CrmType_GetPageAsc_60EA49655F91", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CrmType/SearchByValue": { "post": { "tags": [ "CrmType" ], "summary": "CrmType: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CrmType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CrmType_SearchByValue_3FDF15BA9989", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CrmType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CrmType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CrmType" } } } } } } }, "/api/CrmType/TryGetByValue": { "post": { "tags": [ "CrmType" ], "summary": "CrmType: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CrmType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CrmType_TryGetByValue_E087A517BE01", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CrmType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CrmType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CrmType" } } } } } } }, "/api/CrmType/UpsertGraph": { "put": { "tags": [ "CrmType" ], "summary": "CrmType: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CrmType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CrmType_UpsertGraph_1F4505CAA876", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CrmType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CrmType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.CrmType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CrmType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CrmType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CrmType" } } } } } } }, "/api/CrmType/UpsertGraphWithExtraFields": { "put": { "tags": [ "CrmType" ], "summary": "CrmType: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: CrmType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CrmType_UpsertGraphWithExtraFields_6F30A4BDD668", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CrmType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CrmType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CrmType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CrmType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CrmType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CrmType" } } } } } } }, "/api/csp-report": { "post": { "tags": [ "CspReport" ], "summary": "CspReport: Report", "description": "This operation allows requests without an X-ERP application session. Operation-specific credentials or tokens may still be required.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "CspReport_Report_CBE99EA00F5C", "responses": { "200": { "description": "OK" } }, "security": [ ] } }, "/api/Dashboard": { "get": { "tags": [ "Dashboard" ], "summary": "Dashboard: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Dashboard-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Dashboard_GetAll_32A45C664772", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Dashboard" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Dashboard" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Dashboard" } } } } } }, "post": { "tags": [ "Dashboard" ], "summary": "Dashboard: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Dashboard-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Dashboard_Post_C4A19DD641F1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Dashboard" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Dashboard" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Dashboard" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dashboard" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dashboard" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dashboard" } } } } } }, "put": { "tags": [ "Dashboard" ], "summary": "Dashboard: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Dashboard-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Dashboard_Put_BA97C545CD20", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Dashboard" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Dashboard" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Dashboard" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dashboard" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dashboard" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dashboard" } } } } } } }, "/api/Dashboard/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "Dashboard" ], "summary": "Dashboard: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Dashboard-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Dashboard_GetPageByValue_A4A714A222C1", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Dashboard/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "Dashboard" ], "summary": "Dashboard: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Dashboard-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Dashboard_GetPageByValue2_BF92D3C4C8FD", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Dashboard/DeleteByFilter": { "post": { "tags": [ "Dashboard" ], "summary": "Dashboard: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Dashboard-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Dashboard_DeleteByFilter_2F4D7E564773", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/Dashboard/ExportDashboard/{dashboardId}": { "get": { "tags": [ "Dashboard" ], "summary": "Dashboard: ExportDashboard", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Dashboard-Read.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Dashboard_ExportDashboard_616368F00496", "parameters": [ { "name": "dashboardId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Dashboard/GetAllByValue": { "post": { "tags": [ "Dashboard" ], "summary": "Dashboard: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Dashboard-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Dashboard_GetAllByValue_26B6039027EF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Dashboard" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Dashboard" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Dashboard" } } } } } } }, "/api/Dashboard/GetAllGraphByValue": { "post": { "tags": [ "Dashboard" ], "summary": "Dashboard: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Dashboard-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Dashboard_GetAllGraphByValue_74BAD94A1EBB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Dashboard" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Dashboard" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Dashboard" } } } } } } }, "/api/Dashboard/GetByValue": { "post": { "tags": [ "Dashboard" ], "summary": "Dashboard: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Dashboard-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Dashboard_GetByValue_7485ECDB7FE9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dashboard" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dashboard" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dashboard" } } } } } } }, "/api/Dashboard/GetLookup": { "post": { "tags": [ "Dashboard" ], "summary": "Dashboard: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Dashboard-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Dashboard_GetLookup_EA68B4B95570", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/Dashboard/GetLookupByValue": { "post": { "tags": [ "Dashboard" ], "summary": "Dashboard: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Dashboard-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Dashboard_GetLookupByValue_A3481B9BBADE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/Dashboard/ImportDashboard": { "post": { "tags": [ "Dashboard" ], "summary": "Dashboard: ImportDashboard", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Dashboard-Create.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Dashboard_ImportDashboard_550DFBDACC7D", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" }, "dashboardName": { "type": "string", "default": "" } } }, "encoding": { "file": { "style": "form" }, "dashboardName": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dashboard" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dashboard" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dashboard" } } } } } } }, "/api/Dashboard/Page": { "get": { "tags": [ "Dashboard" ], "summary": "Dashboard: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Dashboard-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Dashboard_GetPage_00FFF1BB5F48", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Dashboard/PageAsc": { "get": { "tags": [ "Dashboard" ], "summary": "Dashboard: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Dashboard-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Dashboard_GetPageAsc_BCBAFACF2FA0", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Dashboard/SearchByValue": { "post": { "tags": [ "Dashboard" ], "summary": "Dashboard: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Dashboard-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Dashboard_SearchByValue_2B87B9F24524", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.Dashboard" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.Dashboard" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.Dashboard" } } } } } } }, "/api/Dashboard/TryGetByValue": { "post": { "tags": [ "Dashboard" ], "summary": "Dashboard: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Dashboard-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Dashboard_TryGetByValue_53EDFF0875A4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dashboard" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dashboard" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dashboard" } } } } } } }, "/api/Dashboard/UpsertGraph": { "put": { "tags": [ "Dashboard" ], "summary": "Dashboard: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Dashboard-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Dashboard_UpsertGraph_FA82D596C627", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Dashboard" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Dashboard" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Dashboard" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dashboard" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dashboard" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dashboard" } } } } } } }, "/api/Dashboard/UpsertGraphWithExtraFields": { "put": { "tags": [ "Dashboard" ], "summary": "Dashboard: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Dashboard-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Dashboard_UpsertGraphWithExtraFields_C3A93A37B161", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Dashboard" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Dashboard" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Dashboard" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Dashboard" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Dashboard" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Dashboard" } } } } } } }, "/api/DashboardCashflow/DashBoardCashFlowData": { "get": { "tags": [ "DashboardCashflow" ], "summary": "DashboardCashflow: GetDashBoardCashFlowData", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DashboardCashflow-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DashboardCashflow_GetDashBoardCashFlowData_E51CD7CE803C", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CashFlowDataPointModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CashFlowDataPointModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CashFlowDataPointModel" } } } } } } }, "/api/DeviceService": { "get": { "tags": [ "DeviceService" ], "summary": "DeviceService: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DeviceService-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DeviceService_GetAll_1C28836F0666", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DeviceService" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DeviceService" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DeviceService" } } } } } }, "post": { "tags": [ "DeviceService" ], "summary": "DeviceService: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DeviceService-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DeviceService_Post_0759A14A0C82", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DeviceService" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DeviceService" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DeviceService" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DeviceService" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DeviceService" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DeviceService" } } } } } }, "put": { "tags": [ "DeviceService" ], "summary": "DeviceService: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DeviceService-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DeviceService_Put_AA3E674CA97A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DeviceService" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DeviceService" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DeviceService" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DeviceService" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DeviceService" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DeviceService" } } } } } } }, "/api/DeviceService/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "DeviceService" ], "summary": "DeviceService: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DeviceService-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DeviceService_GetPageByValue_90A42F9A9E5E", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DeviceService/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "DeviceService" ], "summary": "DeviceService: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DeviceService-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DeviceService_GetPageByValue2_CCB2020A52BF", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DeviceService/DeleteByFilter": { "post": { "tags": [ "DeviceService" ], "summary": "DeviceService: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DeviceService-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DeviceService_DeleteByFilter_D3196B03B5B7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/DeviceService/GetAllByValue": { "post": { "tags": [ "DeviceService" ], "summary": "DeviceService: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DeviceService-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DeviceService_GetAllByValue_BDEE189E3C35", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DeviceService" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DeviceService" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DeviceService" } } } } } } }, "/api/DeviceService/GetAllGraphByValue": { "post": { "tags": [ "DeviceService" ], "summary": "DeviceService: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DeviceService-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DeviceService_GetAllGraphByValue_18C1CAAB067C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DeviceService" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DeviceService" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DeviceService" } } } } } } }, "/api/DeviceService/GetByValue": { "post": { "tags": [ "DeviceService" ], "summary": "DeviceService: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DeviceService-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DeviceService_GetByValue_3C5723A7EA54", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DeviceService" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DeviceService" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DeviceService" } } } } } } }, "/api/DeviceService/GetLookup": { "post": { "tags": [ "DeviceService" ], "summary": "DeviceService: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DeviceService-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DeviceService_GetLookup_70C5F5E9BFB0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/DeviceService/GetLookupByValue": { "post": { "tags": [ "DeviceService" ], "summary": "DeviceService: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DeviceService-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DeviceService_GetLookupByValue_8902A776C17E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/DeviceService/Page": { "get": { "tags": [ "DeviceService" ], "summary": "DeviceService: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DeviceService-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DeviceService_GetPage_0CF316BB321A", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DeviceService/PageAsc": { "get": { "tags": [ "DeviceService" ], "summary": "DeviceService: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DeviceService-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DeviceService_GetPageAsc_5EF39D4DE83E", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DeviceService/PageDocsByAdminDocType/{DocTypeId}/{AdminDocTypeId}/{IncludeSubNodes}/{OpenDocsOnly}": { "get": { "tags": [ "DeviceService" ], "summary": "DeviceService: GetPageDocsByAdminDocType", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DeviceService-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DeviceService_GetPageDocsByAdminDocType_A7C8F29D91BA", "parameters": [ { "name": "DocTypeId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "AdminDocTypeId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "IncludeSubNodes", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "OpenDocsOnly", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DeviceService/PageDocsByAdminDocTypeDocContractId/{DocTypeId}/{AdminDocTypeId}/{IncludeSubNodes}/{OpenDocsOnly}/{DocContractId}": { "get": { "tags": [ "DeviceService" ], "summary": "DeviceService: GetPageDocsByAdminDocTypeDocContractId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DeviceService-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DeviceService_GetPageDocsByAdminDocTypeDocContractId_D81F3878CC83", "parameters": [ { "name": "DocTypeId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "AdminDocTypeId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "IncludeSubNodes", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "OpenDocsOnly", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "DocContractId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DeviceService/PageDocsByAdminDocTypeProject/{DocTypeId}/{AdminDocTypeId}/{IncludeSubNodes}/{OpenDocsOnly}/{ProjectId}": { "get": { "tags": [ "DeviceService" ], "summary": "DeviceService: GetPageDocsByAdminDocTypeProject", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DeviceService-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DeviceService_GetPageDocsByAdminDocTypeProject_4B17B8A7066E", "parameters": [ { "name": "DocTypeId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "AdminDocTypeId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "IncludeSubNodes", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "OpenDocsOnly", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "ProjectId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DeviceService/SearchByValue": { "post": { "tags": [ "DeviceService" ], "summary": "DeviceService: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DeviceService-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DeviceService_SearchByValue_A9F0C4DB0344", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DeviceService" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DeviceService" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DeviceService" } } } } } } }, "/api/DeviceService/Sproc_UpdateField": { "put": { "tags": [ "DeviceService" ], "summary": "DeviceService: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DeviceService-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DeviceService_Put_D71C45839C9D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DeviceService_Sproc_UpdateField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DeviceService_Sproc_UpdateField" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DeviceService_Sproc_UpdateField" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DeviceService_Sproc_UpdateField" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DeviceService_Sproc_UpdateField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DeviceService_Sproc_UpdateField" } } } } } } }, "/api/DeviceService/TryGetByValue": { "post": { "tags": [ "DeviceService" ], "summary": "DeviceService: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DeviceService-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DeviceService_TryGetByValue_7560A0B07A7D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DeviceService" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DeviceService" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DeviceService" } } } } } } }, "/api/DeviceService/UpsertGraph": { "put": { "tags": [ "DeviceService" ], "summary": "DeviceService: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DeviceService-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DeviceService_UpsertGraph_0F2E2DC0D8BE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DeviceService" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DeviceService" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DeviceService" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DeviceService" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DeviceService" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DeviceService" } } } } } } }, "/api/DeviceService/UpsertGraphWithExtraFields": { "put": { "tags": [ "DeviceService" ], "summary": "DeviceService: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DeviceService-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DeviceService_UpsertGraphWithExtraFields_B8E9A35DC0D4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DeviceService" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DeviceService" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DeviceService" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DeviceService" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DeviceService" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DeviceService" } } } } } } }, "/api/Doc": { "get": { "tags": [ "Doc" ], "summary": "Doc: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Doc-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Doc_GetAll_C824629DBCF6", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Doc" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Doc" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Doc" } } } } } }, "post": { "tags": [ "Doc" ], "summary": "Doc: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Doc-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Doc_Post_8971171A4B1B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Doc" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Doc" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Doc" } } } } } }, "put": { "tags": [ "Doc" ], "summary": "Doc: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Doc-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Doc_Put_0DB1FD6933F1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Doc" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Doc" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Doc" } } } } } } }, "/api/Doc/{CurrDocId}/{DocTypeId}/GetPageDocsOpenOrPartially": { "get": { "tags": [ "Doc" ], "summary": "Doc: GetPageDocsOpenOrPartially", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Doc-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Doc_GetPageDocsOpenOrPartially_0F11B1764733", "parameters": [ { "name": "CurrDocId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "DocTypeId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Doc/{DocId}/PerformOutputControlFormat_Email": { "post": { "tags": [ "Doc" ], "summary": "Doc: PerformOutputControlFormat_Email", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Doc-Create.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Doc_PerformOutputControlFormat_Email_EAAA336E69E0", "parameters": [ { "name": "DocId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "saveAsDraft", "in": "query", "schema": { "type": "boolean", "default": false } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Email" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Email" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Email" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/Doc/{DocId}/PerformOutputControlFormat_PDF": { "get": { "tags": [ "Doc" ], "summary": "Doc: PerformOutputControlFormat_PDF", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Doc-Create.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Doc_PerformOutputControlFormat_PDF_E6B72C334687", "parameters": [ { "name": "DocId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Doc/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "Doc" ], "summary": "Doc: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Doc-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Doc_GetPageByValue_7D72449F2739", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Doc/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "Doc" ], "summary": "Doc: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Doc-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Doc_GetPageByValue2_686AFF44FC6A", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Doc/AddDocXml": { "post": { "tags": [ "Doc" ], "summary": "Doc: AddDocXml", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Doc-Create.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Doc_AddDocXml_1D89FF96086C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXml" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXml" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXml" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocXml" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocXml" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocXml" } } } } } } }, "/api/Doc/BlockDocument/{docId}": { "put": { "tags": [ "Doc" ], "summary": "Doc: BlockDocument", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Doc-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Doc_BlockDocument_151819713B88", "parameters": [ { "name": "docId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Doc" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Doc" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Doc" } } } } } } }, "/api/Doc/CloseDocManually": { "post": { "tags": [ "Doc" ], "summary": "Doc: CloseDocManually", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Doc-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Doc_CloseDocManually_1779C0C44BCB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc_DocIdRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc_DocIdRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc_DocIdRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/Doc/CopyDocPositions": { "post": { "tags": [ "Doc" ], "summary": "Doc: CopyDocPositions", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Doc-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Doc_CopyDocPositions_77EFD70996DE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc_CopyDocPositionsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc_CopyDocPositionsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc_CopyDocPositionsRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/Doc/CostPriceUpdate": { "post": { "tags": [ "Doc" ], "summary": "Doc: CostPriceUpdate", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Doc-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Doc_CostPriceUpdate_7A1D2AED1CA0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc_DocIdRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc_DocIdRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc_DocIdRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/Doc/CreateNewDoc": { "post": { "tags": [ "Doc" ], "summary": "Doc: CreateNewDoc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Doc-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Doc_CreateNewDoc_5134444223FF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc_CreateNewDocRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc_CreateNewDocRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc_CreateNewDocRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Doc" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Doc" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Doc" } } } } } } }, "/api/Doc/CreateTargetDoc": { "post": { "tags": [ "Doc" ], "summary": "Doc: CreateTargetDoc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Doc-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Doc_CreateTargetDoc_66956A88EF89", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc_CreateTargetDocRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc_CreateTargetDocRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc_CreateTargetDocRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Doc" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Doc" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Doc" } } } } } } }, "/api/Doc/DeleteByFilter": { "post": { "tags": [ "Doc" ], "summary": "Doc: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Doc-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Doc_DeleteByFilter_0EDAC30F822D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/Doc/DownloadArchivedFile/{DocId}": { "get": { "tags": [ "Doc" ], "summary": "Doc: DownloadArchivedFile", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Doc-Read.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Doc_DownloadArchivedFile_971A608EE9AB", "parameters": [ { "name": "DocId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Doc/DownloadXInvoiceXml/{DocId}": { "get": { "tags": [ "Doc" ], "summary": "Doc: DownloadXInvoiceXml", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Doc-Read.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Doc_DownloadXInvoiceXml_CE7511A10CA0", "parameters": [ { "name": "DocId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Doc/DownloadZUGFeRD/{DocId}": { "get": { "tags": [ "Doc" ], "summary": "Doc: DownloadZUGFeRD", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Doc-Read.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Doc_DownloadZUGFeRD_AC0CACFC8553", "parameters": [ { "name": "DocId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Doc/GetAllByValue": { "post": { "tags": [ "Doc" ], "summary": "Doc: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Doc-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Doc_GetAllByValue_FD8996FCCC23", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Doc" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Doc" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Doc" } } } } } } }, "/api/Doc/GetAllGraphByValue": { "post": { "tags": [ "Doc" ], "summary": "Doc: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Doc-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Doc_GetAllGraphByValue_888F7FD5D1A4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Doc" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Doc" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Doc" } } } } } } }, "/api/Doc/GetAttachmentCount": { "post": { "tags": [ "Doc" ], "summary": "Doc: GetAttachmentCount", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Doc-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Doc_GetAttachmentCount_74DBB0F1B935", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc_DocIdRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc_DocIdRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc_DocIdRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/Doc/GetByValue": { "post": { "tags": [ "Doc" ], "summary": "Doc: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Doc-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Doc_GetByValue_8F440D859DEA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Doc" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Doc" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Doc" } } } } } } }, "/api/Doc/GetIntrastat": { "get": { "tags": [ "Doc" ], "summary": "Doc: GetIntrastat", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Doc-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Doc_GetIntrastat_7D7EB81B48F6", "parameters": [ { "name": "docId", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocIntrastatRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocIntrastatRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocIntrastatRequest" } } } } } } }, "/api/Doc/GetLookup": { "post": { "tags": [ "Doc" ], "summary": "Doc: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Doc-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Doc_GetLookup_0B642D8F53FB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/Doc/GetLookupByValue": { "post": { "tags": [ "Doc" ], "summary": "Doc: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Doc-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Doc_GetLookupByValue_C456F4D0222E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/Doc/GetOrderConfirmationDueState": { "get": { "tags": [ "Doc" ], "summary": "Doc: GetOrderConfirmationDueState", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Doc-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Doc_GetOrderConfirmationDueState_E0D93A3B751F", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.OrderConfirmationDueState" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.OrderConfirmationDueState" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.OrderConfirmationDueState" } } } } } } }, "/api/Doc/Page": { "get": { "tags": [ "Doc" ], "summary": "Doc: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Doc-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Doc_GetPage_DF014D7D4833", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Doc/PageAsc": { "get": { "tags": [ "Doc" ], "summary": "Doc: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Doc-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Doc_GetPageAsc_3A9C3DF8EFB3", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Doc/PageFromView/{DocTypeId}/{SelectedDocTypeId}/{IncludeSubNodes}/{OpenDocsOnly}/{ProjectId}/{DocContractId}/{DeviceServiceOnly}": { "get": { "tags": [ "Doc" ], "summary": "Doc: GetPageDocsByAdminDocType", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Doc-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Doc_GetPageDocsByAdminDocType_14B42ECF5A58", "parameters": [ { "name": "DocTypeId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "SelectedDocTypeId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "IncludeSubNodes", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "OpenDocsOnly", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "ProjectId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "DocContractId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "DeviceServiceOnly", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Doc/PerformOutputControlFormat_ArchiveExternal/{docId}": { "post": { "tags": [ "Doc" ], "summary": "Doc: PerformOutputControlFormat_ArchiveExternal", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Doc-Create.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Doc_PerformOutputControlFormat_ArchiveExternal_3F845D5372CE", "parameters": [ { "name": "docId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "fileChunk": { "type": "string", "format": "binary" } } }, "encoding": { "fileChunk": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/Doc/PostDoc": { "post": { "tags": [ "Doc" ], "summary": "Doc: PostDoc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Doc-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Doc_PostDoc_DBC83C6C6376", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc_PostDocRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc_PostDocRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc_PostDocRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocPostingErrorMessage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocPostingErrorMessage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocPostingErrorMessage" } } } } } } }, "/api/Doc/ReduceToNowAvailableQuantity": { "post": { "tags": [ "Doc" ], "summary": "Doc: ReduceToNowAvailableQuantity", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Doc-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Doc_ReduceToNowAvailableQuantity_A8273D4D898A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc_DocIdRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc_DocIdRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc_DocIdRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/Doc/Renumber": { "post": { "tags": [ "Doc" ], "summary": "Doc: Renumber", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Doc-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Doc_Renumber_FC46A72DCE1E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc_DocIdRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc_DocIdRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc_DocIdRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/Doc/SaveIntrastat": { "put": { "tags": [ "Doc" ], "summary": "Doc: SaveIntrastat", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Doc-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Doc_SaveIntrastat_3266074D9C57", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocIntrastatRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocIntrastatRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocIntrastatRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocIntrastatRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocIntrastatRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocIntrastatRequest" } } } } } } }, "/api/Doc/SearchByValue": { "post": { "tags": [ "Doc" ], "summary": "Doc: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Doc-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Doc_SearchByValue_6EA753C71827", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.Doc" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.Doc" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.Doc" } } } } } } }, "/api/Doc/SetFirstDocNumber": { "post": { "tags": [ "Doc" ], "summary": "Doc: SetFirstDocNumber", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Doc-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Doc_SetFirstDocNumber_7654398EFDFC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc_SetFirstDocNumberRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc_SetFirstDocNumberRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc_SetFirstDocNumberRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/Doc/Sproc_DivergentInvoiceRecipientId": { "post": { "tags": [ "Doc" ], "summary": "Doc: Sproc_DivergentInvoiceRecipientId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Doc-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Doc_Sproc_DivergentInvoiceRecipientId_424438CB351E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc_DivergentInvoiceRecipientIdRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc_DivergentInvoiceRecipientIdRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc_DivergentInvoiceRecipientIdRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/Doc/Sproc_UpdateField": { "put": { "tags": [ "Doc" ], "summary": "Doc: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Doc-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Doc_Put_E1158CACAA28", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc_Sproc_UpdateField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc_Sproc_UpdateField" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc_Sproc_UpdateField" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Doc_Sproc_UpdateField" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Doc_Sproc_UpdateField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Doc_Sproc_UpdateField" } } } } } } }, "/api/Doc/TransferFromPreviousDoc": { "post": { "tags": [ "Doc" ], "summary": "Doc: TransferFromPreviousDoc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Doc-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Doc_TransferFromPreviousDoc_BDD9FA832881", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc_TransferFromPreviousDocRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc_TransferFromPreviousDocRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc_TransferFromPreviousDocRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/Doc/TransferSaleToPurchaseDoc": { "post": { "tags": [ "Doc" ], "summary": "Doc: TransferSaleToPurchaseDoc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Doc-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Doc_TransferSaleToPurchaseDoc_09A9F2406F67", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc_TransferSaleToPurchaseDocRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc_TransferSaleToPurchaseDocRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc_TransferSaleToPurchaseDocRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/Doc/TransferToNextDoc": { "post": { "tags": [ "Doc" ], "summary": "Doc: TransferToNextDoc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Doc-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Doc_TransferToNextDoc_4CD563B23E7A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc_TransferToNextDocRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc_TransferToNextDocRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc_TransferToNextDocRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Doc" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Doc" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Doc" } } } } } } }, "/api/Doc/TryGetByValue": { "post": { "tags": [ "Doc" ], "summary": "Doc: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Doc-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Doc_TryGetByValue_8A5F5015EFA4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Doc" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Doc" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Doc" } } } } } } }, "/api/Doc/UpsertGraph": { "put": { "tags": [ "Doc" ], "summary": "Doc: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Doc-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Doc_UpsertGraph_A47E9359FD1E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Doc" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Doc" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Doc" } } } } } } }, "/api/Doc/UpsertGraphWithExtraFields": { "put": { "tags": [ "Doc" ], "summary": "Doc: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Doc-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Doc_UpsertGraphWithExtraFields_3305F3ADD601", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Doc" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Doc" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Doc" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Doc" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Doc" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Doc" } } } } } } }, "/api/Doc/ValidateEInvoice/{DocId}/{Format}": { "get": { "tags": [ "Doc" ], "summary": "Doc: ValidateEInvoice", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Doc-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Doc_ValidateEInvoice_A06634577291", "parameters": [ { "name": "DocId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Format", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_System.String" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_System.String" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_System.String" } } } } } } }, "/api/DocApproval": { "get": { "tags": [ "DocApproval" ], "summary": "DocApproval: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocApproval-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocApproval_GetAll_34617096B00D", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocApproval" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocApproval" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocApproval" } } } } } }, "post": { "tags": [ "DocApproval" ], "summary": "DocApproval: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocApproval-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocApproval_Post_711DDFD6946C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocApproval" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocApproval" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocApproval" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocApproval" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocApproval" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocApproval" } } } } } }, "put": { "tags": [ "DocApproval" ], "summary": "DocApproval: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocApproval-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocApproval_Put_03F9CA3E6844", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocApproval" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocApproval" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocApproval" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocApproval" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocApproval" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocApproval" } } } } } } }, "/api/DocApproval/{DocId}/PageFromViewByDocId": { "get": { "tags": [ "DocApproval" ], "summary": "DocApproval: GetPageFromViewByDocId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocApproval-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocApproval_GetPageFromViewByDocId_30B6B289D15B", "parameters": [ { "name": "DocId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocApproval/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "DocApproval" ], "summary": "DocApproval: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocApproval-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocApproval_GetPageByValue_E3FB08A7B41A", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocApproval/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "DocApproval" ], "summary": "DocApproval: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocApproval-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocApproval_GetPageByValue2_D7A89CC57941", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocApproval/DeleteByFilter": { "post": { "tags": [ "DocApproval" ], "summary": "DocApproval: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocApproval-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocApproval_DeleteByFilter_A4ADF01B625F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/DocApproval/GetAllByValue": { "post": { "tags": [ "DocApproval" ], "summary": "DocApproval: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocApproval-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocApproval_GetAllByValue_58D134B0933E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocApproval" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocApproval" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocApproval" } } } } } } }, "/api/DocApproval/GetAllGraphByValue": { "post": { "tags": [ "DocApproval" ], "summary": "DocApproval: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocApproval-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocApproval_GetAllGraphByValue_569970BB04E4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocApproval" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocApproval" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocApproval" } } } } } } }, "/api/DocApproval/GetByValue": { "post": { "tags": [ "DocApproval" ], "summary": "DocApproval: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocApproval-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocApproval_GetByValue_257067163D4E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocApproval" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocApproval" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocApproval" } } } } } } }, "/api/DocApproval/GetLookup": { "post": { "tags": [ "DocApproval" ], "summary": "DocApproval: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocApproval-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocApproval_GetLookup_3F9106F504A1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/DocApproval/GetLookupByValue": { "post": { "tags": [ "DocApproval" ], "summary": "DocApproval: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocApproval-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocApproval_GetLookupByValue_D3BACB1B0075", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/DocApproval/Page": { "get": { "tags": [ "DocApproval" ], "summary": "DocApproval: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocApproval-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocApproval_GetPage_3E416943FD83", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocApproval/PageAsc": { "get": { "tags": [ "DocApproval" ], "summary": "DocApproval: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocApproval-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocApproval_GetPageAsc_BAC820D278B7", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocApproval/SearchByValue": { "post": { "tags": [ "DocApproval" ], "summary": "DocApproval: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocApproval-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocApproval_SearchByValue_593C8A4460D2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocApproval" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocApproval" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocApproval" } } } } } } }, "/api/DocApproval/TryGetByValue": { "post": { "tags": [ "DocApproval" ], "summary": "DocApproval: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocApproval-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocApproval_TryGetByValue_0E269A20FBD9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocApproval" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocApproval" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocApproval" } } } } } } }, "/api/DocApproval/UpsertGraph": { "put": { "tags": [ "DocApproval" ], "summary": "DocApproval: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocApproval-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocApproval_UpsertGraph_137C1F73779C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocApproval" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocApproval" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocApproval" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocApproval" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocApproval" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocApproval" } } } } } } }, "/api/DocApproval/UpsertGraphWithExtraFields": { "put": { "tags": [ "DocApproval" ], "summary": "DocApproval: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocApproval-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocApproval_UpsertGraphWithExtraFields_FFF547776F8D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocApproval" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocApproval" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocApproval" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocApproval" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocApproval" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocApproval" } } } } } } }, "/api/DocBillingAddress": { "get": { "tags": [ "DocBillingAddress" ], "summary": "DocBillingAddress: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocBillingAddress-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocBillingAddress_GetAll_358F60EC472E", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocBillingAddress" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocBillingAddress" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocBillingAddress" } } } } } }, "post": { "tags": [ "DocBillingAddress" ], "summary": "DocBillingAddress: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocBillingAddress-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocBillingAddress_Post_2AB2CF4FB57A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocBillingAddress" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocBillingAddress" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocBillingAddress" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocBillingAddress" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocBillingAddress" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocBillingAddress" } } } } } }, "put": { "tags": [ "DocBillingAddress" ], "summary": "DocBillingAddress: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocBillingAddress-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocBillingAddress_Put_EF729769EAD4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocBillingAddress" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocBillingAddress" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocBillingAddress" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocBillingAddress" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocBillingAddress" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocBillingAddress" } } } } } } }, "/api/DocBillingAddress/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "DocBillingAddress" ], "summary": "DocBillingAddress: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocBillingAddress-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocBillingAddress_GetPageByValue_F2B54EEDEDE6", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocBillingAddress/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "DocBillingAddress" ], "summary": "DocBillingAddress: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocBillingAddress-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocBillingAddress_GetPageByValue2_31EBE68D4340", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocBillingAddress/DeleteByFilter": { "post": { "tags": [ "DocBillingAddress" ], "summary": "DocBillingAddress: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocBillingAddress-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocBillingAddress_DeleteByFilter_E0F68745D568", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/DocBillingAddress/GetAllByValue": { "post": { "tags": [ "DocBillingAddress" ], "summary": "DocBillingAddress: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocBillingAddress-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocBillingAddress_GetAllByValue_27834D5541A0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocBillingAddress" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocBillingAddress" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocBillingAddress" } } } } } } }, "/api/DocBillingAddress/GetAllGraphByValue": { "post": { "tags": [ "DocBillingAddress" ], "summary": "DocBillingAddress: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocBillingAddress-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocBillingAddress_GetAllGraphByValue_BF9C9BC1FC48", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocBillingAddress" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocBillingAddress" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocBillingAddress" } } } } } } }, "/api/DocBillingAddress/GetByValue": { "post": { "tags": [ "DocBillingAddress" ], "summary": "DocBillingAddress: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocBillingAddress-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocBillingAddress_GetByValue_0191B980DB93", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocBillingAddress" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocBillingAddress" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocBillingAddress" } } } } } } }, "/api/DocBillingAddress/GetLookup": { "post": { "tags": [ "DocBillingAddress" ], "summary": "DocBillingAddress: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocBillingAddress-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocBillingAddress_GetLookup_9D560B169219", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/DocBillingAddress/GetLookupByValue": { "post": { "tags": [ "DocBillingAddress" ], "summary": "DocBillingAddress: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocBillingAddress-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocBillingAddress_GetLookupByValue_A161ACE53C36", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/DocBillingAddress/Page": { "get": { "tags": [ "DocBillingAddress" ], "summary": "DocBillingAddress: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocBillingAddress-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocBillingAddress_GetPage_EB947799B0CD", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocBillingAddress/PageAsc": { "get": { "tags": [ "DocBillingAddress" ], "summary": "DocBillingAddress: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocBillingAddress-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocBillingAddress_GetPageAsc_C95AF9BF6D6B", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocBillingAddress/SearchByValue": { "post": { "tags": [ "DocBillingAddress" ], "summary": "DocBillingAddress: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocBillingAddress-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocBillingAddress_SearchByValue_C3CB798C0A54", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocBillingAddress" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocBillingAddress" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocBillingAddress" } } } } } } }, "/api/DocBillingAddress/TryGetByValue": { "post": { "tags": [ "DocBillingAddress" ], "summary": "DocBillingAddress: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocBillingAddress-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocBillingAddress_TryGetByValue_8F9EAD7CE229", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocBillingAddress" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocBillingAddress" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocBillingAddress" } } } } } } }, "/api/DocBillingAddress/UpsertGraph": { "put": { "tags": [ "DocBillingAddress" ], "summary": "DocBillingAddress: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocBillingAddress-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocBillingAddress_UpsertGraph_AE2FB17678B1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocBillingAddress" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocBillingAddress" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocBillingAddress" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocBillingAddress" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocBillingAddress" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocBillingAddress" } } } } } } }, "/api/DocBillingAddress/UpsertGraphWithExtraFields": { "put": { "tags": [ "DocBillingAddress" ], "summary": "DocBillingAddress: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocBillingAddress-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocBillingAddress_UpsertGraphWithExtraFields_6293F9E567CF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocBillingAddress" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocBillingAddress" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocBillingAddress" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocBillingAddress" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocBillingAddress" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocBillingAddress" } } } } } } }, "/api/DocCategory": { "get": { "tags": [ "DocCategory" ], "summary": "DocCategory: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocCategory_GetAll_CA90AEE406D7", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocCategory" } } } } } }, "post": { "tags": [ "DocCategory" ], "summary": "DocCategory: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocCategory-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocCategory_Post_F65E383A50C0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocCategory" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocCategory" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocCategory" } } } } } }, "put": { "tags": [ "DocCategory" ], "summary": "DocCategory: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocCategory-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocCategory_Put_8EDA4F3AE975", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocCategory" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocCategory" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocCategory" } } } } } } }, "/api/DocCategory/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "DocCategory" ], "summary": "DocCategory: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocCategory_GetPageByValue_9E43BCAE60AD", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocCategory/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "DocCategory" ], "summary": "DocCategory: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocCategory_GetPageByValue2_79BED3104633", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocCategory/DeleteByFilter": { "post": { "tags": [ "DocCategory" ], "summary": "DocCategory: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocCategory-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocCategory_DeleteByFilter_94A314825932", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/DocCategory/GetAllByValue": { "post": { "tags": [ "DocCategory" ], "summary": "DocCategory: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocCategory_GetAllByValue_CE38E436C297", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocCategory" } } } } } } }, "/api/DocCategory/GetAllGraphByValue": { "post": { "tags": [ "DocCategory" ], "summary": "DocCategory: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocCategory_GetAllGraphByValue_740744A72822", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocCategory" } } } } } } }, "/api/DocCategory/GetByValue": { "post": { "tags": [ "DocCategory" ], "summary": "DocCategory: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocCategory_GetByValue_C33BC3706DAD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocCategory" } } } } } } }, "/api/DocCategory/GetLookup": { "post": { "tags": [ "DocCategory" ], "summary": "DocCategory: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocCategory_GetLookup_19C2BDAF4696", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/DocCategory/GetLookupByValue": { "post": { "tags": [ "DocCategory" ], "summary": "DocCategory: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocCategory_GetLookupByValue_FF6E3F97260C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/DocCategory/Page": { "get": { "tags": [ "DocCategory" ], "summary": "DocCategory: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocCategory_GetPage_7295C994013A", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocCategory/PageAsc": { "get": { "tags": [ "DocCategory" ], "summary": "DocCategory: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocCategory_GetPageAsc_757AB6BE96F8", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocCategory/SearchByValue": { "post": { "tags": [ "DocCategory" ], "summary": "DocCategory: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocCategory_SearchByValue_459587D70A36", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocCategory" } } } } } } }, "/api/DocCategory/TryGetByValue": { "post": { "tags": [ "DocCategory" ], "summary": "DocCategory: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocCategory_TryGetByValue_128AC4C9C12C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocCategory" } } } } } } }, "/api/DocCategory/UpsertGraph": { "put": { "tags": [ "DocCategory" ], "summary": "DocCategory: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocCategory-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocCategory_UpsertGraph_AE7E88848679", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocCategory" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocCategory" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocCategory" } } } } } } }, "/api/DocCategory/UpsertGraphWithExtraFields": { "put": { "tags": [ "DocCategory" ], "summary": "DocCategory: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocCategory-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocCategory_UpsertGraphWithExtraFields_894E19732371", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocCategory" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocCategory" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocCategory" } } } } } } }, "/api/DocContract": { "get": { "tags": [ "DocContract" ], "summary": "DocContract: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocContract-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocContract_GetAll_7E95BF1D5B4A", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocContract" } } } } } }, "post": { "tags": [ "DocContract" ], "summary": "DocContract: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocContract-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocContract_Post_0EA2247DD857", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocContract" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocContract" } } } } } }, "put": { "tags": [ "DocContract" ], "summary": "DocContract: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocContract-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocContract_Put_CDA0E2B63037", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocContract" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocContract" } } } } } } }, "/api/DocContract/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "DocContract" ], "summary": "DocContract: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocContract-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocContract_GetPageByValue_B0F8711F371B", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocContract/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "DocContract" ], "summary": "DocContract: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocContract-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocContract_GetPageByValue2_66304D385193", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocContract/DeleteByFilter": { "post": { "tags": [ "DocContract" ], "summary": "DocContract: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocContract-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocContract_DeleteByFilter_754DCB629C41", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/DocContract/GetAllByValue": { "post": { "tags": [ "DocContract" ], "summary": "DocContract: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocContract-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocContract_GetAllByValue_B292F22D158B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocContract" } } } } } } }, "/api/DocContract/GetAllGraphByValue": { "post": { "tags": [ "DocContract" ], "summary": "DocContract: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocContract-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocContract_GetAllGraphByValue_F02668064E7F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocContract" } } } } } } }, "/api/DocContract/GetByValue": { "post": { "tags": [ "DocContract" ], "summary": "DocContract: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocContract-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocContract_GetByValue_FADBA5EDC87D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocContract" } } } } } } }, "/api/DocContract/GetLookup": { "post": { "tags": [ "DocContract" ], "summary": "DocContract: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocContract-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocContract_GetLookup_C82AC7CD39BA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/DocContract/GetLookupByValue": { "post": { "tags": [ "DocContract" ], "summary": "DocContract: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocContract-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocContract_GetLookupByValue_5BBA42845D87", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/DocContract/Page": { "get": { "tags": [ "DocContract" ], "summary": "DocContract: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocContract-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocContract_GetPage_139A84C8B92E", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocContract/PageAsc": { "get": { "tags": [ "DocContract" ], "summary": "DocContract: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocContract-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocContract_GetPageAsc_22938A49D48C", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocContract/SearchByValue": { "post": { "tags": [ "DocContract" ], "summary": "DocContract: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocContract-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocContract_SearchByValue_3F5C82361DAD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocContract" } } } } } } }, "/api/DocContract/Sproc_UpdateField": { "put": { "tags": [ "DocContract" ], "summary": "DocContract: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocContract-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocContract_Put_D200CA82C5F8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocContract_Sproc_UpdateField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocContract_Sproc_UpdateField" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocContract_Sproc_UpdateField" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocContract_Sproc_UpdateField" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocContract_Sproc_UpdateField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocContract_Sproc_UpdateField" } } } } } } }, "/api/DocContract/TryGetByValue": { "post": { "tags": [ "DocContract" ], "summary": "DocContract: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocContract-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocContract_TryGetByValue_09BAAA459D61", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocContract" } } } } } } }, "/api/DocContract/UpsertGraph": { "put": { "tags": [ "DocContract" ], "summary": "DocContract: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocContract-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocContract_UpsertGraph_8F3D2C040BD3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocContract" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocContract" } } } } } } }, "/api/DocContract/UpsertGraphWithExtraFields": { "put": { "tags": [ "DocContract" ], "summary": "DocContract: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocContract-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocContract_UpsertGraphWithExtraFields_A5D7CB744905", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocContract" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocContract" } } } } } } }, "/api/DocContractCyclePeriod": { "get": { "tags": [ "DocContractCyclePeriod" ], "summary": "DocContractCyclePeriod: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocContractCyclePeriod-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocContractCyclePeriod_GetAll_729EC1C14853", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocContractCyclePeriod" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocContractCyclePeriod" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocContractCyclePeriod" } } } } } }, "post": { "tags": [ "DocContractCyclePeriod" ], "summary": "DocContractCyclePeriod: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocContractCyclePeriod-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocContractCyclePeriod_Post_A7AE34AFBD22", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocContractCyclePeriod" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocContractCyclePeriod" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocContractCyclePeriod" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocContractCyclePeriod" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocContractCyclePeriod" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocContractCyclePeriod" } } } } } }, "put": { "tags": [ "DocContractCyclePeriod" ], "summary": "DocContractCyclePeriod: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocContractCyclePeriod-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocContractCyclePeriod_Put_FD622CE2FDC5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocContractCyclePeriod" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocContractCyclePeriod" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocContractCyclePeriod" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocContractCyclePeriod" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocContractCyclePeriod" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocContractCyclePeriod" } } } } } } }, "/api/DocContractCyclePeriod/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "DocContractCyclePeriod" ], "summary": "DocContractCyclePeriod: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocContractCyclePeriod-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocContractCyclePeriod_GetPageByValue_F4AFCC4825DD", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocContractCyclePeriod/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "DocContractCyclePeriod" ], "summary": "DocContractCyclePeriod: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocContractCyclePeriod-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocContractCyclePeriod_GetPageByValue2_2940A911E4C6", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocContractCyclePeriod/DeleteByFilter": { "post": { "tags": [ "DocContractCyclePeriod" ], "summary": "DocContractCyclePeriod: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocContractCyclePeriod-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocContractCyclePeriod_DeleteByFilter_B4F6FC578E46", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/DocContractCyclePeriod/GetAllByValue": { "post": { "tags": [ "DocContractCyclePeriod" ], "summary": "DocContractCyclePeriod: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocContractCyclePeriod-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocContractCyclePeriod_GetAllByValue_3D8CC3FA8A9A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocContractCyclePeriod" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocContractCyclePeriod" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocContractCyclePeriod" } } } } } } }, "/api/DocContractCyclePeriod/GetAllGraphByValue": { "post": { "tags": [ "DocContractCyclePeriod" ], "summary": "DocContractCyclePeriod: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocContractCyclePeriod-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocContractCyclePeriod_GetAllGraphByValue_75670E568BF5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocContractCyclePeriod" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocContractCyclePeriod" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocContractCyclePeriod" } } } } } } }, "/api/DocContractCyclePeriod/GetByValue": { "post": { "tags": [ "DocContractCyclePeriod" ], "summary": "DocContractCyclePeriod: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocContractCyclePeriod-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocContractCyclePeriod_GetByValue_D31B69D2E624", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocContractCyclePeriod" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocContractCyclePeriod" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocContractCyclePeriod" } } } } } } }, "/api/DocContractCyclePeriod/GetLookup": { "post": { "tags": [ "DocContractCyclePeriod" ], "summary": "DocContractCyclePeriod: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocContractCyclePeriod-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocContractCyclePeriod_GetLookup_B387652D1F91", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/DocContractCyclePeriod/GetLookupByValue": { "post": { "tags": [ "DocContractCyclePeriod" ], "summary": "DocContractCyclePeriod: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocContractCyclePeriod-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocContractCyclePeriod_GetLookupByValue_10DB8ECE59D5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/DocContractCyclePeriod/Page": { "get": { "tags": [ "DocContractCyclePeriod" ], "summary": "DocContractCyclePeriod: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocContractCyclePeriod-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocContractCyclePeriod_GetPage_B385DF3FBA7E", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocContractCyclePeriod/PageAsc": { "get": { "tags": [ "DocContractCyclePeriod" ], "summary": "DocContractCyclePeriod: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocContractCyclePeriod-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocContractCyclePeriod_GetPageAsc_5A3DE633306E", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocContractCyclePeriod/SearchByValue": { "post": { "tags": [ "DocContractCyclePeriod" ], "summary": "DocContractCyclePeriod: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocContractCyclePeriod-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocContractCyclePeriod_SearchByValue_BFF898AEA1F3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocContractCyclePeriod" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocContractCyclePeriod" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocContractCyclePeriod" } } } } } } }, "/api/DocContractCyclePeriod/TryGetByValue": { "post": { "tags": [ "DocContractCyclePeriod" ], "summary": "DocContractCyclePeriod: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocContractCyclePeriod-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocContractCyclePeriod_TryGetByValue_4B624CB4C62F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocContractCyclePeriod" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocContractCyclePeriod" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocContractCyclePeriod" } } } } } } }, "/api/DocContractCyclePeriod/UpsertGraph": { "put": { "tags": [ "DocContractCyclePeriod" ], "summary": "DocContractCyclePeriod: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocContractCyclePeriod-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocContractCyclePeriod_UpsertGraph_445B4C20BB08", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocContractCyclePeriod" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocContractCyclePeriod" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocContractCyclePeriod" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocContractCyclePeriod" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocContractCyclePeriod" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocContractCyclePeriod" } } } } } } }, "/api/DocContractCyclePeriod/UpsertGraphWithExtraFields": { "put": { "tags": [ "DocContractCyclePeriod" ], "summary": "DocContractCyclePeriod: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocContractCyclePeriod-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocContractCyclePeriod_UpsertGraphWithExtraFields_DAAF404C2406", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocContractCyclePeriod" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocContractCyclePeriod" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocContractCyclePeriod" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocContractCyclePeriod" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocContractCyclePeriod" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocContractCyclePeriod" } } } } } } }, "/api/DocContractStatus": { "get": { "tags": [ "DocContractStatus" ], "summary": "DocContractStatus: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocContractStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocContractStatus_GetAll_E7FB30EDA7B7", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocContractStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocContractStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocContractStatus" } } } } } }, "post": { "tags": [ "DocContractStatus" ], "summary": "DocContractStatus: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocContractStatus-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocContractStatus_Post_467B29729EAB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocContractStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocContractStatus" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocContractStatus" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocContractStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocContractStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocContractStatus" } } } } } }, "put": { "tags": [ "DocContractStatus" ], "summary": "DocContractStatus: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocContractStatus-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocContractStatus_Put_E210934CAC2C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocContractStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocContractStatus" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocContractStatus" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocContractStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocContractStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocContractStatus" } } } } } } }, "/api/DocContractStatus/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "DocContractStatus" ], "summary": "DocContractStatus: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocContractStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocContractStatus_GetPageByValue_7CF20A871833", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocContractStatus/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "DocContractStatus" ], "summary": "DocContractStatus: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocContractStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocContractStatus_GetPageByValue2_7B0B4DE104FB", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocContractStatus/DeleteByFilter": { "post": { "tags": [ "DocContractStatus" ], "summary": "DocContractStatus: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocContractStatus-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocContractStatus_DeleteByFilter_21F0E983F4B2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/DocContractStatus/GetAllByValue": { "post": { "tags": [ "DocContractStatus" ], "summary": "DocContractStatus: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocContractStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocContractStatus_GetAllByValue_211F0D813009", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocContractStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocContractStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocContractStatus" } } } } } } }, "/api/DocContractStatus/GetAllGraphByValue": { "post": { "tags": [ "DocContractStatus" ], "summary": "DocContractStatus: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocContractStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocContractStatus_GetAllGraphByValue_A138DF944C40", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocContractStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocContractStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocContractStatus" } } } } } } }, "/api/DocContractStatus/GetByValue": { "post": { "tags": [ "DocContractStatus" ], "summary": "DocContractStatus: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocContractStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocContractStatus_GetByValue_8DC7CD5669CA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocContractStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocContractStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocContractStatus" } } } } } } }, "/api/DocContractStatus/GetLookup": { "post": { "tags": [ "DocContractStatus" ], "summary": "DocContractStatus: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocContractStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocContractStatus_GetLookup_DB72A9743944", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/DocContractStatus/GetLookupByValue": { "post": { "tags": [ "DocContractStatus" ], "summary": "DocContractStatus: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocContractStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocContractStatus_GetLookupByValue_A1F02D76C808", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/DocContractStatus/Page": { "get": { "tags": [ "DocContractStatus" ], "summary": "DocContractStatus: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocContractStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocContractStatus_GetPage_0DC4F7FE2131", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocContractStatus/PageAsc": { "get": { "tags": [ "DocContractStatus" ], "summary": "DocContractStatus: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocContractStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocContractStatus_GetPageAsc_D9A9F55D3992", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocContractStatus/SearchByValue": { "post": { "tags": [ "DocContractStatus" ], "summary": "DocContractStatus: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocContractStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocContractStatus_SearchByValue_DF3F42289AFB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocContractStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocContractStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocContractStatus" } } } } } } }, "/api/DocContractStatus/TryGetByValue": { "post": { "tags": [ "DocContractStatus" ], "summary": "DocContractStatus: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocContractStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocContractStatus_TryGetByValue_8431AA8B7DD7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocContractStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocContractStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocContractStatus" } } } } } } }, "/api/DocContractStatus/UpsertGraph": { "put": { "tags": [ "DocContractStatus" ], "summary": "DocContractStatus: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocContractStatus-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocContractStatus_UpsertGraph_43E37B1BD6CF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocContractStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocContractStatus" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocContractStatus" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocContractStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocContractStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocContractStatus" } } } } } } }, "/api/DocContractStatus/UpsertGraphWithExtraFields": { "put": { "tags": [ "DocContractStatus" ], "summary": "DocContractStatus: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocContractStatus-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocContractStatus_UpsertGraphWithExtraFields_C042AF784C42", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocContractStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocContractStatus" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocContractStatus" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocContractStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocContractStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocContractStatus" } } } } } } }, "/api/DocDeliveryAddress": { "get": { "tags": [ "DocDeliveryAddress" ], "summary": "DocDeliveryAddress: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocDeliveryAddress-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocDeliveryAddress_GetAll_3F67B28249D3", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocDeliveryAddress" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocDeliveryAddress" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocDeliveryAddress" } } } } } }, "post": { "tags": [ "DocDeliveryAddress" ], "summary": "DocDeliveryAddress: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocDeliveryAddress-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocDeliveryAddress_Post_133683CBDFCB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocDeliveryAddress" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocDeliveryAddress" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocDeliveryAddress" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocDeliveryAddress" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocDeliveryAddress" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocDeliveryAddress" } } } } } }, "put": { "tags": [ "DocDeliveryAddress" ], "summary": "DocDeliveryAddress: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocDeliveryAddress-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocDeliveryAddress_Put_3EE6EEA10E7F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocDeliveryAddress" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocDeliveryAddress" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocDeliveryAddress" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocDeliveryAddress" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocDeliveryAddress" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocDeliveryAddress" } } } } } } }, "/api/DocDeliveryAddress/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "DocDeliveryAddress" ], "summary": "DocDeliveryAddress: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocDeliveryAddress-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocDeliveryAddress_GetPageByValue_2A039715D094", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocDeliveryAddress/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "DocDeliveryAddress" ], "summary": "DocDeliveryAddress: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocDeliveryAddress-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocDeliveryAddress_GetPageByValue2_8A5965D56FF2", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocDeliveryAddress/DeleteByFilter": { "post": { "tags": [ "DocDeliveryAddress" ], "summary": "DocDeliveryAddress: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocDeliveryAddress-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocDeliveryAddress_DeleteByFilter_24D0D9F6D369", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/DocDeliveryAddress/GetAllByValue": { "post": { "tags": [ "DocDeliveryAddress" ], "summary": "DocDeliveryAddress: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocDeliveryAddress-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocDeliveryAddress_GetAllByValue_C44CF4E0269B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocDeliveryAddress" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocDeliveryAddress" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocDeliveryAddress" } } } } } } }, "/api/DocDeliveryAddress/GetAllGraphByValue": { "post": { "tags": [ "DocDeliveryAddress" ], "summary": "DocDeliveryAddress: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocDeliveryAddress-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocDeliveryAddress_GetAllGraphByValue_0A08F423C49F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocDeliveryAddress" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocDeliveryAddress" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocDeliveryAddress" } } } } } } }, "/api/DocDeliveryAddress/GetByValue": { "post": { "tags": [ "DocDeliveryAddress" ], "summary": "DocDeliveryAddress: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocDeliveryAddress-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocDeliveryAddress_GetByValue_C2B2B11ADF20", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocDeliveryAddress" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocDeliveryAddress" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocDeliveryAddress" } } } } } } }, "/api/DocDeliveryAddress/GetLookup": { "post": { "tags": [ "DocDeliveryAddress" ], "summary": "DocDeliveryAddress: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocDeliveryAddress-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocDeliveryAddress_GetLookup_2224087585F1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/DocDeliveryAddress/GetLookupByValue": { "post": { "tags": [ "DocDeliveryAddress" ], "summary": "DocDeliveryAddress: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocDeliveryAddress-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocDeliveryAddress_GetLookupByValue_81396192011E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/DocDeliveryAddress/Page": { "get": { "tags": [ "DocDeliveryAddress" ], "summary": "DocDeliveryAddress: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocDeliveryAddress-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocDeliveryAddress_GetPage_30C3718E50AE", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocDeliveryAddress/PageAsc": { "get": { "tags": [ "DocDeliveryAddress" ], "summary": "DocDeliveryAddress: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocDeliveryAddress-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocDeliveryAddress_GetPageAsc_DDEEF7E05F3C", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocDeliveryAddress/SearchByValue": { "post": { "tags": [ "DocDeliveryAddress" ], "summary": "DocDeliveryAddress: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocDeliveryAddress-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocDeliveryAddress_SearchByValue_02697A5B04AF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocDeliveryAddress" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocDeliveryAddress" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocDeliveryAddress" } } } } } } }, "/api/DocDeliveryAddress/TryGetByValue": { "post": { "tags": [ "DocDeliveryAddress" ], "summary": "DocDeliveryAddress: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocDeliveryAddress-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocDeliveryAddress_TryGetByValue_33E4BD4E1701", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocDeliveryAddress" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocDeliveryAddress" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocDeliveryAddress" } } } } } } }, "/api/DocDeliveryAddress/UpsertGraph": { "put": { "tags": [ "DocDeliveryAddress" ], "summary": "DocDeliveryAddress: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocDeliveryAddress-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocDeliveryAddress_UpsertGraph_0315B3809321", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocDeliveryAddress" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocDeliveryAddress" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocDeliveryAddress" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocDeliveryAddress" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocDeliveryAddress" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocDeliveryAddress" } } } } } } }, "/api/DocDeliveryAddress/UpsertGraphWithExtraFields": { "put": { "tags": [ "DocDeliveryAddress" ], "summary": "DocDeliveryAddress: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocDeliveryAddress-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocDeliveryAddress_UpsertGraphWithExtraFields_89DB87E2E194", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocDeliveryAddress" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocDeliveryAddress" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocDeliveryAddress" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocDeliveryAddress" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocDeliveryAddress" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocDeliveryAddress" } } } } } } }, "/api/DocFooterText": { "get": { "tags": [ "DocFooterText" ], "summary": "DocFooterText: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocFooterText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocFooterText_GetAll_F786DFA56076", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocFooterText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocFooterText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocFooterText" } } } } } }, "post": { "tags": [ "DocFooterText" ], "summary": "DocFooterText: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocFooterText-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocFooterText_Post_109253B6B858", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocFooterText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocFooterText" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocFooterText" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocFooterText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocFooterText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocFooterText" } } } } } }, "put": { "tags": [ "DocFooterText" ], "summary": "DocFooterText: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocFooterText-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocFooterText_Put_331D9C5D00B1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocFooterText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocFooterText" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocFooterText" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocFooterText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocFooterText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocFooterText" } } } } } } }, "/api/DocFooterText/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "DocFooterText" ], "summary": "DocFooterText: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocFooterText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocFooterText_GetPageByValue_158A3A6A3BE4", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocFooterText/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "DocFooterText" ], "summary": "DocFooterText: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocFooterText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocFooterText_GetPageByValue2_197F81260952", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocFooterText/DeleteByFilter": { "post": { "tags": [ "DocFooterText" ], "summary": "DocFooterText: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocFooterText-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocFooterText_DeleteByFilter_2572CBA1A7A6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/DocFooterText/GetAllByValue": { "post": { "tags": [ "DocFooterText" ], "summary": "DocFooterText: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocFooterText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocFooterText_GetAllByValue_E4E0892699ED", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocFooterText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocFooterText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocFooterText" } } } } } } }, "/api/DocFooterText/GetAllGraphByValue": { "post": { "tags": [ "DocFooterText" ], "summary": "DocFooterText: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocFooterText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocFooterText_GetAllGraphByValue_FFCB0BFDF342", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocFooterText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocFooterText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocFooterText" } } } } } } }, "/api/DocFooterText/GetByValue": { "post": { "tags": [ "DocFooterText" ], "summary": "DocFooterText: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocFooterText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocFooterText_GetByValue_7EA875291C14", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocFooterText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocFooterText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocFooterText" } } } } } } }, "/api/DocFooterText/GetLookup": { "post": { "tags": [ "DocFooterText" ], "summary": "DocFooterText: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocFooterText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocFooterText_GetLookup_D327C6EFB1E8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/DocFooterText/GetLookupByValue": { "post": { "tags": [ "DocFooterText" ], "summary": "DocFooterText: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocFooterText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocFooterText_GetLookupByValue_2FA81A9FB523", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/DocFooterText/Page": { "get": { "tags": [ "DocFooterText" ], "summary": "DocFooterText: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocFooterText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocFooterText_GetPage_C0B5B05038C6", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocFooterText/PageAsc": { "get": { "tags": [ "DocFooterText" ], "summary": "DocFooterText: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocFooterText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocFooterText_GetPageAsc_27BDF8BDBDA0", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocFooterText/SearchByValue": { "post": { "tags": [ "DocFooterText" ], "summary": "DocFooterText: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocFooterText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocFooterText_SearchByValue_D357F90DAD07", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocFooterText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocFooterText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocFooterText" } } } } } } }, "/api/DocFooterText/TryGetByValue": { "post": { "tags": [ "DocFooterText" ], "summary": "DocFooterText: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocFooterText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocFooterText_TryGetByValue_DBCB7F6626BF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocFooterText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocFooterText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocFooterText" } } } } } } }, "/api/DocFooterText/UpsertGraph": { "put": { "tags": [ "DocFooterText" ], "summary": "DocFooterText: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocFooterText-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocFooterText_UpsertGraph_93338377CC5F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocFooterText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocFooterText" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocFooterText" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocFooterText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocFooterText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocFooterText" } } } } } } }, "/api/DocFooterText/UpsertGraphWithExtraFields": { "put": { "tags": [ "DocFooterText" ], "summary": "DocFooterText: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocFooterText-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocFooterText_UpsertGraphWithExtraFields_D4B89EE1047E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocFooterText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocFooterText" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocFooterText" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocFooterText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocFooterText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocFooterText" } } } } } } }, "/api/DocHeaderText": { "get": { "tags": [ "DocHeaderText" ], "summary": "DocHeaderText: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocHeaderText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocHeaderText_GetAll_43493725745B", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocHeaderText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocHeaderText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocHeaderText" } } } } } }, "post": { "tags": [ "DocHeaderText" ], "summary": "DocHeaderText: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocHeaderText-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocHeaderText_Post_7A1E364FD9C9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocHeaderText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocHeaderText" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocHeaderText" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocHeaderText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocHeaderText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocHeaderText" } } } } } }, "put": { "tags": [ "DocHeaderText" ], "summary": "DocHeaderText: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocHeaderText-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocHeaderText_Put_C690E7B86399", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocHeaderText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocHeaderText" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocHeaderText" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocHeaderText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocHeaderText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocHeaderText" } } } } } } }, "/api/DocHeaderText/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "DocHeaderText" ], "summary": "DocHeaderText: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocHeaderText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocHeaderText_GetPageByValue_EEB0B8DFF33F", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocHeaderText/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "DocHeaderText" ], "summary": "DocHeaderText: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocHeaderText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocHeaderText_GetPageByValue2_9C45628C2A0F", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocHeaderText/DeleteByFilter": { "post": { "tags": [ "DocHeaderText" ], "summary": "DocHeaderText: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocHeaderText-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocHeaderText_DeleteByFilter_63C0153BE1A7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/DocHeaderText/GetAllByValue": { "post": { "tags": [ "DocHeaderText" ], "summary": "DocHeaderText: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocHeaderText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocHeaderText_GetAllByValue_B2198A2F139A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocHeaderText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocHeaderText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocHeaderText" } } } } } } }, "/api/DocHeaderText/GetAllGraphByValue": { "post": { "tags": [ "DocHeaderText" ], "summary": "DocHeaderText: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocHeaderText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocHeaderText_GetAllGraphByValue_178423EC2139", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocHeaderText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocHeaderText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocHeaderText" } } } } } } }, "/api/DocHeaderText/GetByValue": { "post": { "tags": [ "DocHeaderText" ], "summary": "DocHeaderText: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocHeaderText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocHeaderText_GetByValue_59DD9F798226", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocHeaderText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocHeaderText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocHeaderText" } } } } } } }, "/api/DocHeaderText/GetLookup": { "post": { "tags": [ "DocHeaderText" ], "summary": "DocHeaderText: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocHeaderText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocHeaderText_GetLookup_93F74332D955", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/DocHeaderText/GetLookupByValue": { "post": { "tags": [ "DocHeaderText" ], "summary": "DocHeaderText: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocHeaderText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocHeaderText_GetLookupByValue_89B9534CD3F4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/DocHeaderText/Page": { "get": { "tags": [ "DocHeaderText" ], "summary": "DocHeaderText: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocHeaderText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocHeaderText_GetPage_9806AD681DAD", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocHeaderText/PageAsc": { "get": { "tags": [ "DocHeaderText" ], "summary": "DocHeaderText: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocHeaderText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocHeaderText_GetPageAsc_1FB2375167B0", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocHeaderText/SearchByValue": { "post": { "tags": [ "DocHeaderText" ], "summary": "DocHeaderText: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocHeaderText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocHeaderText_SearchByValue_C7969687E74D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocHeaderText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocHeaderText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocHeaderText" } } } } } } }, "/api/DocHeaderText/TryGetByValue": { "post": { "tags": [ "DocHeaderText" ], "summary": "DocHeaderText: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocHeaderText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocHeaderText_TryGetByValue_3B48E88E90A9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocHeaderText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocHeaderText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocHeaderText" } } } } } } }, "/api/DocHeaderText/UpsertGraph": { "put": { "tags": [ "DocHeaderText" ], "summary": "DocHeaderText: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocHeaderText-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocHeaderText_UpsertGraph_AA048F7F081C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocHeaderText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocHeaderText" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocHeaderText" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocHeaderText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocHeaderText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocHeaderText" } } } } } } }, "/api/DocHeaderText/UpsertGraphWithExtraFields": { "put": { "tags": [ "DocHeaderText" ], "summary": "DocHeaderText: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocHeaderText-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocHeaderText_UpsertGraphWithExtraFields_DC850647E2E2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocHeaderText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocHeaderText" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocHeaderText" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocHeaderText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocHeaderText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocHeaderText" } } } } } } }, "/api/DocPosition": { "get": { "tags": [ "DocPosition" ], "summary": "DocPosition: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPosition_GetAll_8DDA7D65C9A5", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocPosition" } } } } } }, "post": { "tags": [ "DocPosition" ], "summary": "DocPosition: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPosition-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPosition_Post_EBE37CFD63B6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPosition" } } } } } }, "put": { "tags": [ "DocPosition" ], "summary": "DocPosition: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPosition-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPosition_Put_CC88D5940852", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPosition" } } } } } } }, "/api/DocPosition/{DocId}/GetPageDocPositionsOpenOrPartially": { "get": { "tags": [ "DocPosition" ], "summary": "DocPosition: GetPageDocPositionsOpenOrPartially", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPosition-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPosition_GetPageDocPositionsOpenOrPartially_1106B6A090BE", "parameters": [ { "name": "DocId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocPosition/{DocId}/GetPageDocPositionsTransferableToPurchase": { "get": { "tags": [ "DocPosition" ], "summary": "DocPosition: GetPageDocPositionsTransferableToPurchase", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPosition-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPosition_GetPageDocPositionsTransferableToPurchase_A66CFB2CB415", "parameters": [ { "name": "DocId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocPosition/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "DocPosition" ], "summary": "DocPosition: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPosition_GetPageByValue_0BCBB465C975", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocPosition/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "DocPosition" ], "summary": "DocPosition: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPosition_GetPageByValue2_4F060C2DDCC8", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocPosition/CloseDocPositionManually": { "post": { "tags": [ "DocPosition" ], "summary": "DocPosition: CloseDocPositionManually", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPosition-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPosition_CloseDocPositionManually_6496B1A6D479", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition_CloseManuallyRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition_CloseManuallyRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition_CloseManuallyRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/DocPosition/DeleteByFilter": { "post": { "tags": [ "DocPosition" ], "summary": "DocPosition: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPosition-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPosition_DeleteByFilter_8C34371B4B54", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/DocPosition/GetAllByValue": { "post": { "tags": [ "DocPosition" ], "summary": "DocPosition: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPosition_GetAllByValue_0A6668A66C4E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocPosition" } } } } } } }, "/api/DocPosition/GetAllGraphByValue": { "post": { "tags": [ "DocPosition" ], "summary": "DocPosition: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPosition_GetAllGraphByValue_AC7064803C0F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocPosition" } } } } } } }, "/api/DocPosition/GetByValue": { "post": { "tags": [ "DocPosition" ], "summary": "DocPosition: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPosition_GetByValue_D19C8055B55C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPosition" } } } } } } }, "/api/DocPosition/GetDocPositionWithQuantities": { "post": { "tags": [ "DocPosition" ], "summary": "DocPosition: GetDocPositionWithQuantities", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPosition-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPosition_GetDocPositionWithQuantities_C6CE1322C432", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition_GetWithQuantitiesRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition_GetWithQuantitiesRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition_GetWithQuantitiesRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW220_DocPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW220_DocPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW220_DocPosition" } } } } } } }, "/api/DocPosition/GetIntrastat": { "get": { "tags": [ "DocPosition" ], "summary": "DocPosition: GetIntrastat", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPosition-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPosition_GetIntrastat_A5EE0E3E36B8", "parameters": [ { "name": "docPositionId", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionIntrastatRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionIntrastatRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionIntrastatRequest" } } } } } } }, "/api/DocPosition/GetLookup": { "post": { "tags": [ "DocPosition" ], "summary": "DocPosition: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPosition_GetLookup_3A8E34BC0AF5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/DocPosition/GetLookupByValue": { "post": { "tags": [ "DocPosition" ], "summary": "DocPosition: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPosition_GetLookupByValue_170362082159", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/DocPosition/Page": { "get": { "tags": [ "DocPosition" ], "summary": "DocPosition: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPosition_GetPage_A1D203FA3853", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocPosition/PageAsc": { "get": { "tags": [ "DocPosition" ], "summary": "DocPosition: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPosition_GetPageAsc_0487970E62FA", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocPosition/SaveIntrastat": { "put": { "tags": [ "DocPosition" ], "summary": "DocPosition: SaveIntrastat", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPosition-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPosition_SaveIntrastat_3928C925A1C5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionIntrastatRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionIntrastatRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionIntrastatRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionIntrastatRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionIntrastatRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionIntrastatRequest" } } } } } } }, "/api/DocPosition/SearchByValue": { "post": { "tags": [ "DocPosition" ], "summary": "DocPosition: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPosition_SearchByValue_D58A7CB1BEC1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocPosition" } } } } } } }, "/api/DocPosition/Sproc_Delete": { "post": { "tags": [ "DocPosition" ], "summary": "DocPosition: Sproc_Delete", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPosition-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPosition_Sproc_Delete_B29DF74655B8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition_SprocDeleteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition_SprocDeleteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition_SprocDeleteRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/DocPosition/Sproc_DeleteTransfer": { "post": { "tags": [ "DocPosition" ], "summary": "DocPosition: Sproc_DeleteTransfer", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPosition-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPosition_Sproc_DeleteTransfer_C619353089A0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition_SprocDeleteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition_SprocDeleteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition_SprocDeleteRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/DocPosition/Sproc_FinanceGroupArticleId": { "post": { "tags": [ "DocPosition" ], "summary": "DocPosition: Sproc_FinanceGroupArticleId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPosition-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPosition_Sproc_FinanceGroupArticleId_DEF0587E79A8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition_SprocFinanceGroupArticleIdRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition_SprocFinanceGroupArticleIdRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition_SprocFinanceGroupArticleIdRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceGroupArticleIdResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceGroupArticleIdResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceGroupArticleIdResult" } } } } } } }, "/api/DocPosition/Sproc_ForeignCurrencyPrice": { "post": { "tags": [ "DocPosition" ], "summary": "DocPosition: Sproc_ForeignCurrencyPrice", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPosition-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPosition_Sproc_ForeignCurrencyPrice_7BD3508C8E9D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition_SprocForeignCurrencyPriceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition_SprocForeignCurrencyPriceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition_SprocForeignCurrencyPriceRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ForeignCurrencyPriceResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ForeignCurrencyPriceResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ForeignCurrencyPriceResult" } } } } } } }, "/api/DocPosition/Sproc_InsertArticle": { "post": { "tags": [ "DocPosition" ], "summary": "DocPosition: Sproc_InsertArticle", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPosition-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPosition_Sproc_InsertArticle_AB4DA9AEEDF9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition_SprocInsertArticleRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition_SprocInsertArticleRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition_SprocInsertArticleRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.InsertArticleResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.InsertArticleResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.InsertArticleResult" } } } } } } }, "/api/DocPosition/Sproc_InsertText": { "post": { "tags": [ "DocPosition" ], "summary": "DocPosition: Sproc_InsertText", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPosition-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPosition_Sproc_InsertText_D31796C34F63", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition_SprocInsertTextRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition_SprocInsertTextRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition_SprocInsertTextRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.InsertTextResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.InsertTextResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.InsertTextResult" } } } } } } }, "/api/DocPosition/Sproc_PositionTypeId": { "post": { "tags": [ "DocPosition" ], "summary": "DocPosition: Sproc_PositionTypeId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPosition-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPosition_Sproc_PositionTypeId_4D1CD8C4F3D5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition_SprocPositionTypeIdRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition_SprocPositionTypeIdRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition_SprocPositionTypeIdRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PositionTypeIdResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PositionTypeIdResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PositionTypeIdResult" } } } } } } }, "/api/DocPosition/Sproc_SalesPersonId": { "post": { "tags": [ "DocPosition" ], "summary": "DocPosition: Sproc_SalesPersonId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPosition-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPosition_Sproc_SalesPersonId_3F8C46515EAB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition_SprocSalesPersonIdRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition_SprocSalesPersonIdRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition_SprocSalesPersonIdRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SalesPersonIdResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SalesPersonIdResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SalesPersonIdResult" } } } } } } }, "/api/DocPosition/Sproc_StatusId": { "post": { "tags": [ "DocPosition" ], "summary": "DocPosition: Sproc_StatusId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPosition-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPosition_Sproc_StatusId_604969DCD416", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition_SprocStatusIdRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition_SprocStatusIdRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition_SprocStatusIdRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.StatusIdResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.StatusIdResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.StatusIdResult" } } } } } } }, "/api/DocPosition/Sproc_TaxKeyId": { "post": { "tags": [ "DocPosition" ], "summary": "DocPosition: Sproc_TaxKeyId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPosition-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPosition_Sproc_TaxKeyId_8FFD39B71282", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition_SprocTaxKeyIdRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition_SprocTaxKeyIdRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition_SprocTaxKeyIdRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TaxKeyIdResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TaxKeyIdResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TaxKeyIdResult" } } } } } } }, "/api/DocPosition/Sproc_Update": { "post": { "tags": [ "DocPosition" ], "summary": "DocPosition: Sproc_Update", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPosition-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPosition_Sproc_Update_727E1BDF63BC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition_SprocUpdateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition_SprocUpdateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition_SprocUpdateRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/DocPosition/Sproc_UpdateField": { "put": { "tags": [ "DocPosition" ], "summary": "DocPosition: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPosition-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPosition_Put_60B3184F20DD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition_Sproc_UpdateField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition_Sproc_UpdateField" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition_Sproc_UpdateField" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPosition_Sproc_UpdateField" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPosition_Sproc_UpdateField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPosition_Sproc_UpdateField" } } } } } } }, "/api/DocPosition/Sproc_UpdatePurchasePriceList": { "post": { "tags": [ "DocPosition" ], "summary": "DocPosition: Sproc_UpdatePurchasePriceList", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPosition-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPosition_Sproc_UpdatePurchasePriceList_40193B2FA041", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition_SprocUpdatePurchasePriceListRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition_SprocUpdatePurchasePriceListRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition_SprocUpdatePurchasePriceListRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/DocPosition/Sproc_UpdateTransfer": { "post": { "tags": [ "DocPosition" ], "summary": "DocPosition: Sproc_UpdateTransfer", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPosition-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPosition_Sproc_UpdateTransfer_4CC32B13557F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition_SprocUpdateTransferRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition_SprocUpdateTransferRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition_SprocUpdateTransferRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/DocPosition/TryGetByValue": { "post": { "tags": [ "DocPosition" ], "summary": "DocPosition: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPosition_TryGetByValue_1A36CF0A7D47", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPosition" } } } } } } }, "/api/DocPosition/UpdateSalesPriceList": { "post": { "tags": [ "DocPosition" ], "summary": "DocPosition: UpdateSalesPriceList", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPosition-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPosition_UpdateSalesPriceList_DAEEAD3E5ABC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition_UpdateSalesPriceListRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition_UpdateSalesPriceListRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition_UpdateSalesPriceListRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/DocPosition/UpsertGraph": { "put": { "tags": [ "DocPosition" ], "summary": "DocPosition: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPosition-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPosition_UpsertGraph_C5BED79D6F2E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPosition" } } } } } } }, "/api/DocPosition/UpsertGraphWithExtraFields": { "put": { "tags": [ "DocPosition" ], "summary": "DocPosition: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPosition-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPosition_UpsertGraphWithExtraFields_AEDE7F3C4E70", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocPosition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocPosition" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocPosition" } } } } } } }, "/api/DocPositionDimensionText": { "get": { "tags": [ "DocPositionDimensionText" ], "summary": "DocPositionDimensionText: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionDimensionText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionDimensionText_GetAll_85EE937D1569", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocPositionDimensionText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocPositionDimensionText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocPositionDimensionText" } } } } } }, "post": { "tags": [ "DocPositionDimensionText" ], "summary": "DocPositionDimensionText: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionDimensionText-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionDimensionText_Post_91E641AD5FC2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionDimensionText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionDimensionText" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionDimensionText" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionDimensionText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionDimensionText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionDimensionText" } } } } } }, "put": { "tags": [ "DocPositionDimensionText" ], "summary": "DocPositionDimensionText: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionDimensionText-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionDimensionText_Put_43A148F8C286", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionDimensionText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionDimensionText" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionDimensionText" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionDimensionText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionDimensionText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionDimensionText" } } } } } } }, "/api/DocPositionDimensionText/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "DocPositionDimensionText" ], "summary": "DocPositionDimensionText: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionDimensionText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionDimensionText_GetPageByValue_797C1BBD546B", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocPositionDimensionText/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "DocPositionDimensionText" ], "summary": "DocPositionDimensionText: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionDimensionText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionDimensionText_GetPageByValue2_13B3C93B4680", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocPositionDimensionText/DeleteByFilter": { "post": { "tags": [ "DocPositionDimensionText" ], "summary": "DocPositionDimensionText: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionDimensionText-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionDimensionText_DeleteByFilter_81C0EC76A2A5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/DocPositionDimensionText/GetAllByValue": { "post": { "tags": [ "DocPositionDimensionText" ], "summary": "DocPositionDimensionText: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionDimensionText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionDimensionText_GetAllByValue_C27D175002F7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocPositionDimensionText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocPositionDimensionText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocPositionDimensionText" } } } } } } }, "/api/DocPositionDimensionText/GetAllGraphByValue": { "post": { "tags": [ "DocPositionDimensionText" ], "summary": "DocPositionDimensionText: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionDimensionText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionDimensionText_GetAllGraphByValue_17D98D1CC110", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocPositionDimensionText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocPositionDimensionText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocPositionDimensionText" } } } } } } }, "/api/DocPositionDimensionText/GetByValue": { "post": { "tags": [ "DocPositionDimensionText" ], "summary": "DocPositionDimensionText: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionDimensionText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionDimensionText_GetByValue_5E46F2EA07AE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionDimensionText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionDimensionText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionDimensionText" } } } } } } }, "/api/DocPositionDimensionText/GetLookup": { "post": { "tags": [ "DocPositionDimensionText" ], "summary": "DocPositionDimensionText: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionDimensionText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionDimensionText_GetLookup_DD36BF558B56", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/DocPositionDimensionText/GetLookupByValue": { "post": { "tags": [ "DocPositionDimensionText" ], "summary": "DocPositionDimensionText: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionDimensionText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionDimensionText_GetLookupByValue_14A15CAFB219", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/DocPositionDimensionText/Page": { "get": { "tags": [ "DocPositionDimensionText" ], "summary": "DocPositionDimensionText: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionDimensionText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionDimensionText_GetPage_01526B075D2D", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocPositionDimensionText/PageAsc": { "get": { "tags": [ "DocPositionDimensionText" ], "summary": "DocPositionDimensionText: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionDimensionText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionDimensionText_GetPageAsc_C2053572D599", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocPositionDimensionText/SearchByValue": { "post": { "tags": [ "DocPositionDimensionText" ], "summary": "DocPositionDimensionText: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionDimensionText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionDimensionText_SearchByValue_6F35DA43D526", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocPositionDimensionText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocPositionDimensionText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocPositionDimensionText" } } } } } } }, "/api/DocPositionDimensionText/TryGetByValue": { "post": { "tags": [ "DocPositionDimensionText" ], "summary": "DocPositionDimensionText: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionDimensionText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionDimensionText_TryGetByValue_9AA444A8E1A8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionDimensionText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionDimensionText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionDimensionText" } } } } } } }, "/api/DocPositionDimensionText/UpsertGraph": { "put": { "tags": [ "DocPositionDimensionText" ], "summary": "DocPositionDimensionText: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionDimensionText-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionDimensionText_UpsertGraph_A23BAB8446AB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionDimensionText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionDimensionText" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionDimensionText" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionDimensionText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionDimensionText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionDimensionText" } } } } } } }, "/api/DocPositionDimensionText/UpsertGraphWithExtraFields": { "put": { "tags": [ "DocPositionDimensionText" ], "summary": "DocPositionDimensionText: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionDimensionText-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionDimensionText_UpsertGraphWithExtraFields_F20D4E24970D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocPositionDimensionText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocPositionDimensionText" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocPositionDimensionText" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocPositionDimensionText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocPositionDimensionText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocPositionDimensionText" } } } } } } }, "/api/DocPositionInfoText": { "get": { "tags": [ "DocPositionInfoText" ], "summary": "DocPositionInfoText: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionInfoText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionInfoText_GetAll_A95046EA2A90", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocPositionInfoText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocPositionInfoText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocPositionInfoText" } } } } } }, "post": { "tags": [ "DocPositionInfoText" ], "summary": "DocPositionInfoText: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionInfoText-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionInfoText_Post_5EC0DF2EF545", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionInfoText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionInfoText" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionInfoText" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionInfoText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionInfoText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionInfoText" } } } } } }, "put": { "tags": [ "DocPositionInfoText" ], "summary": "DocPositionInfoText: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionInfoText-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionInfoText_Put_7A10D2E805C9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionInfoText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionInfoText" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionInfoText" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionInfoText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionInfoText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionInfoText" } } } } } } }, "/api/DocPositionInfoText/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "DocPositionInfoText" ], "summary": "DocPositionInfoText: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionInfoText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionInfoText_GetPageByValue_534B4D932B88", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocPositionInfoText/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "DocPositionInfoText" ], "summary": "DocPositionInfoText: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionInfoText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionInfoText_GetPageByValue2_BB813CE881B9", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocPositionInfoText/DeleteByFilter": { "post": { "tags": [ "DocPositionInfoText" ], "summary": "DocPositionInfoText: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionInfoText-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionInfoText_DeleteByFilter_E6B25CC7D9E4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/DocPositionInfoText/GetAllByValue": { "post": { "tags": [ "DocPositionInfoText" ], "summary": "DocPositionInfoText: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionInfoText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionInfoText_GetAllByValue_E7AF54EE51E7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocPositionInfoText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocPositionInfoText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocPositionInfoText" } } } } } } }, "/api/DocPositionInfoText/GetAllGraphByValue": { "post": { "tags": [ "DocPositionInfoText" ], "summary": "DocPositionInfoText: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionInfoText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionInfoText_GetAllGraphByValue_6CF72AF02402", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocPositionInfoText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocPositionInfoText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocPositionInfoText" } } } } } } }, "/api/DocPositionInfoText/GetByValue": { "post": { "tags": [ "DocPositionInfoText" ], "summary": "DocPositionInfoText: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionInfoText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionInfoText_GetByValue_ED2C4C78E706", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionInfoText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionInfoText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionInfoText" } } } } } } }, "/api/DocPositionInfoText/GetLookup": { "post": { "tags": [ "DocPositionInfoText" ], "summary": "DocPositionInfoText: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionInfoText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionInfoText_GetLookup_A43F11A2C960", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/DocPositionInfoText/GetLookupByValue": { "post": { "tags": [ "DocPositionInfoText" ], "summary": "DocPositionInfoText: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionInfoText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionInfoText_GetLookupByValue_9C00C3E8DA44", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/DocPositionInfoText/Page": { "get": { "tags": [ "DocPositionInfoText" ], "summary": "DocPositionInfoText: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionInfoText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionInfoText_GetPage_3C1F833905CD", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocPositionInfoText/PageAsc": { "get": { "tags": [ "DocPositionInfoText" ], "summary": "DocPositionInfoText: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionInfoText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionInfoText_GetPageAsc_04CEA31D2785", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocPositionInfoText/SearchByValue": { "post": { "tags": [ "DocPositionInfoText" ], "summary": "DocPositionInfoText: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionInfoText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionInfoText_SearchByValue_F225A7FCD906", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocPositionInfoText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocPositionInfoText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocPositionInfoText" } } } } } } }, "/api/DocPositionInfoText/TryGetByValue": { "post": { "tags": [ "DocPositionInfoText" ], "summary": "DocPositionInfoText: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionInfoText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionInfoText_TryGetByValue_AB32D125CDB4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionInfoText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionInfoText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionInfoText" } } } } } } }, "/api/DocPositionInfoText/UpsertGraph": { "put": { "tags": [ "DocPositionInfoText" ], "summary": "DocPositionInfoText: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionInfoText-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionInfoText_UpsertGraph_51EFED5CD9B6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionInfoText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionInfoText" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionInfoText" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionInfoText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionInfoText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionInfoText" } } } } } } }, "/api/DocPositionInfoText/UpsertGraphWithExtraFields": { "put": { "tags": [ "DocPositionInfoText" ], "summary": "DocPositionInfoText: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionInfoText-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionInfoText_UpsertGraphWithExtraFields_242383E2CE14", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocPositionInfoText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocPositionInfoText" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocPositionInfoText" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocPositionInfoText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocPositionInfoText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocPositionInfoText" } } } } } } }, "/api/DocPositionOrderText": { "get": { "tags": [ "DocPositionOrderText" ], "summary": "DocPositionOrderText: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionOrderText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionOrderText_GetAll_9D68D6AC6B97", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocPositionOrderText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocPositionOrderText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocPositionOrderText" } } } } } }, "post": { "tags": [ "DocPositionOrderText" ], "summary": "DocPositionOrderText: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionOrderText-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionOrderText_Post_410D869E7268", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionOrderText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionOrderText" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionOrderText" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionOrderText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionOrderText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionOrderText" } } } } } }, "put": { "tags": [ "DocPositionOrderText" ], "summary": "DocPositionOrderText: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionOrderText-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionOrderText_Put_0B4B91293297", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionOrderText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionOrderText" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionOrderText" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionOrderText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionOrderText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionOrderText" } } } } } } }, "/api/DocPositionOrderText/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "DocPositionOrderText" ], "summary": "DocPositionOrderText: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionOrderText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionOrderText_GetPageByValue_673F04307E48", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocPositionOrderText/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "DocPositionOrderText" ], "summary": "DocPositionOrderText: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionOrderText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionOrderText_GetPageByValue2_1C953906536A", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocPositionOrderText/DeleteByFilter": { "post": { "tags": [ "DocPositionOrderText" ], "summary": "DocPositionOrderText: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionOrderText-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionOrderText_DeleteByFilter_C1A5B1B2E84C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/DocPositionOrderText/GetAllByValue": { "post": { "tags": [ "DocPositionOrderText" ], "summary": "DocPositionOrderText: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionOrderText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionOrderText_GetAllByValue_7E1057B0B25A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocPositionOrderText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocPositionOrderText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocPositionOrderText" } } } } } } }, "/api/DocPositionOrderText/GetAllGraphByValue": { "post": { "tags": [ "DocPositionOrderText" ], "summary": "DocPositionOrderText: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionOrderText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionOrderText_GetAllGraphByValue_D443DD5ED988", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocPositionOrderText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocPositionOrderText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocPositionOrderText" } } } } } } }, "/api/DocPositionOrderText/GetByValue": { "post": { "tags": [ "DocPositionOrderText" ], "summary": "DocPositionOrderText: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionOrderText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionOrderText_GetByValue_945017A89B92", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionOrderText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionOrderText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionOrderText" } } } } } } }, "/api/DocPositionOrderText/GetLookup": { "post": { "tags": [ "DocPositionOrderText" ], "summary": "DocPositionOrderText: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionOrderText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionOrderText_GetLookup_212BF2EE2906", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/DocPositionOrderText/GetLookupByValue": { "post": { "tags": [ "DocPositionOrderText" ], "summary": "DocPositionOrderText: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionOrderText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionOrderText_GetLookupByValue_BA18E9AB6FDA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/DocPositionOrderText/Page": { "get": { "tags": [ "DocPositionOrderText" ], "summary": "DocPositionOrderText: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionOrderText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionOrderText_GetPage_6737AD398DDE", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocPositionOrderText/PageAsc": { "get": { "tags": [ "DocPositionOrderText" ], "summary": "DocPositionOrderText: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionOrderText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionOrderText_GetPageAsc_D964EFEC64FE", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocPositionOrderText/SearchByValue": { "post": { "tags": [ "DocPositionOrderText" ], "summary": "DocPositionOrderText: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionOrderText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionOrderText_SearchByValue_E080CA44C113", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocPositionOrderText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocPositionOrderText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocPositionOrderText" } } } } } } }, "/api/DocPositionOrderText/TryGetByValue": { "post": { "tags": [ "DocPositionOrderText" ], "summary": "DocPositionOrderText: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionOrderText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionOrderText_TryGetByValue_74D43B18F87C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionOrderText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionOrderText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionOrderText" } } } } } } }, "/api/DocPositionOrderText/UpsertGraph": { "put": { "tags": [ "DocPositionOrderText" ], "summary": "DocPositionOrderText: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionOrderText-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionOrderText_UpsertGraph_7CDF4CED78BD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionOrderText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionOrderText" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionOrderText" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionOrderText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionOrderText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionOrderText" } } } } } } }, "/api/DocPositionOrderText/UpsertGraphWithExtraFields": { "put": { "tags": [ "DocPositionOrderText" ], "summary": "DocPositionOrderText: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionOrderText-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionOrderText_UpsertGraphWithExtraFields_EEC89D49D938", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocPositionOrderText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocPositionOrderText" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocPositionOrderText" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocPositionOrderText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocPositionOrderText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocPositionOrderText" } } } } } } }, "/api/DocPositionStatus": { "get": { "tags": [ "DocPositionStatus" ], "summary": "DocPositionStatus: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionStatus_GetAll_3B95DF78A7D4", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocPositionStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocPositionStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocPositionStatus" } } } } } }, "post": { "tags": [ "DocPositionStatus" ], "summary": "DocPositionStatus: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionStatus-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionStatus_Post_FF94E01F13A7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionStatus" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionStatus" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionStatus" } } } } } }, "put": { "tags": [ "DocPositionStatus" ], "summary": "DocPositionStatus: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionStatus-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionStatus_Put_3BCD9B9F3404", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionStatus" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionStatus" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionStatus" } } } } } } }, "/api/DocPositionStatus/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "DocPositionStatus" ], "summary": "DocPositionStatus: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionStatus_GetPageByValue_7AD04A03AF26", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocPositionStatus/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "DocPositionStatus" ], "summary": "DocPositionStatus: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionStatus_GetPageByValue2_81927216778C", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocPositionStatus/DeleteByFilter": { "post": { "tags": [ "DocPositionStatus" ], "summary": "DocPositionStatus: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionStatus-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionStatus_DeleteByFilter_25BC3026BCE8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/DocPositionStatus/GetAllByValue": { "post": { "tags": [ "DocPositionStatus" ], "summary": "DocPositionStatus: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionStatus_GetAllByValue_0E11EF03C0E3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocPositionStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocPositionStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocPositionStatus" } } } } } } }, "/api/DocPositionStatus/GetAllGraphByValue": { "post": { "tags": [ "DocPositionStatus" ], "summary": "DocPositionStatus: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionStatus_GetAllGraphByValue_DDFD60778606", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocPositionStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocPositionStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocPositionStatus" } } } } } } }, "/api/DocPositionStatus/GetByValue": { "post": { "tags": [ "DocPositionStatus" ], "summary": "DocPositionStatus: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionStatus_GetByValue_10A114B3D65B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionStatus" } } } } } } }, "/api/DocPositionStatus/GetLookup": { "post": { "tags": [ "DocPositionStatus" ], "summary": "DocPositionStatus: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionStatus_GetLookup_165449B6883E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/DocPositionStatus/GetLookupByValue": { "post": { "tags": [ "DocPositionStatus" ], "summary": "DocPositionStatus: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionStatus_GetLookupByValue_3B2A36ABDD9E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/DocPositionStatus/Page": { "get": { "tags": [ "DocPositionStatus" ], "summary": "DocPositionStatus: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionStatus_GetPage_3924D55CE488", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocPositionStatus/PageAsc": { "get": { "tags": [ "DocPositionStatus" ], "summary": "DocPositionStatus: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionStatus_GetPageAsc_D0ECC782F66E", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocPositionStatus/SearchByValue": { "post": { "tags": [ "DocPositionStatus" ], "summary": "DocPositionStatus: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionStatus_SearchByValue_4194F1C361D8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocPositionStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocPositionStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocPositionStatus" } } } } } } }, "/api/DocPositionStatus/TryGetByValue": { "post": { "tags": [ "DocPositionStatus" ], "summary": "DocPositionStatus: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionStatus_TryGetByValue_ED36AB1FED15", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionStatus" } } } } } } }, "/api/DocPositionStatus/UpsertGraph": { "put": { "tags": [ "DocPositionStatus" ], "summary": "DocPositionStatus: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionStatus-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionStatus_UpsertGraph_5846530F3F4C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionStatus" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionStatus" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionStatus" } } } } } } }, "/api/DocPositionStatus/UpsertGraphWithExtraFields": { "put": { "tags": [ "DocPositionStatus" ], "summary": "DocPositionStatus: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionStatus-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionStatus_UpsertGraphWithExtraFields_E55392C5B882", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocPositionStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocPositionStatus" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocPositionStatus" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocPositionStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocPositionStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocPositionStatus" } } } } } } }, "/api/DocPositionType": { "get": { "tags": [ "DocPositionType" ], "summary": "DocPositionType: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionType_GetAll_B4BDEFCD2541", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocPositionType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocPositionType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocPositionType" } } } } } }, "post": { "tags": [ "DocPositionType" ], "summary": "DocPositionType: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionType-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionType_Post_581A8EAB3862", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionType" } } } } } }, "put": { "tags": [ "DocPositionType" ], "summary": "DocPositionType: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionType_Put_67AA1FF53455", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionType" } } } } } } }, "/api/DocPositionType/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "DocPositionType" ], "summary": "DocPositionType: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionType_GetPageByValue_9294734EFD71", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocPositionType/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "DocPositionType" ], "summary": "DocPositionType: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionType_GetPageByValue2_0B6F2DFF2456", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocPositionType/DeleteByFilter": { "post": { "tags": [ "DocPositionType" ], "summary": "DocPositionType: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionType-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionType_DeleteByFilter_6EACBDF8079D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/DocPositionType/GetAllByValue": { "post": { "tags": [ "DocPositionType" ], "summary": "DocPositionType: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionType_GetAllByValue_1983A95D6441", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocPositionType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocPositionType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocPositionType" } } } } } } }, "/api/DocPositionType/GetAllGraphByValue": { "post": { "tags": [ "DocPositionType" ], "summary": "DocPositionType: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionType_GetAllGraphByValue_0972ABE052D3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocPositionType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocPositionType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocPositionType" } } } } } } }, "/api/DocPositionType/GetByValue": { "post": { "tags": [ "DocPositionType" ], "summary": "DocPositionType: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionType_GetByValue_751FE4865A62", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionType" } } } } } } }, "/api/DocPositionType/GetLookup": { "post": { "tags": [ "DocPositionType" ], "summary": "DocPositionType: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionType_GetLookup_1751A5E6B13E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/DocPositionType/GetLookupByValue": { "post": { "tags": [ "DocPositionType" ], "summary": "DocPositionType: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionType_GetLookupByValue_E8BB100B9EDE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/DocPositionType/Page": { "get": { "tags": [ "DocPositionType" ], "summary": "DocPositionType: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionType_GetPage_BE08C3A5C420", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocPositionType/PageAsc": { "get": { "tags": [ "DocPositionType" ], "summary": "DocPositionType: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionType_GetPageAsc_A9C4165CC856", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocPositionType/SearchByValue": { "post": { "tags": [ "DocPositionType" ], "summary": "DocPositionType: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionType_SearchByValue_B77B36B85441", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocPositionType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocPositionType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocPositionType" } } } } } } }, "/api/DocPositionType/TryGetByValue": { "post": { "tags": [ "DocPositionType" ], "summary": "DocPositionType: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionType_TryGetByValue_C564DAC4C8BA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionType" } } } } } } }, "/api/DocPositionType/UpsertGraph": { "put": { "tags": [ "DocPositionType" ], "summary": "DocPositionType: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionType_UpsertGraph_5896D864D051", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionType" } } } } } } }, "/api/DocPositionType/UpsertGraphWithExtraFields": { "put": { "tags": [ "DocPositionType" ], "summary": "DocPositionType: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionType_UpsertGraphWithExtraFields_4C18E41ED169", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocPositionType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocPositionType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocPositionType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocPositionType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocPositionType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocPositionType" } } } } } } }, "/api/DocPositionWarehousing": { "get": { "tags": [ "DocPositionWarehousing" ], "summary": "DocPositionWarehousing: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionWarehousing-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionWarehousing_GetAll_26817B76747E", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocPositionWarehousing" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocPositionWarehousing" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocPositionWarehousing" } } } } } }, "post": { "tags": [ "DocPositionWarehousing" ], "summary": "DocPositionWarehousing: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionWarehousing-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionWarehousing_Post_3A65F00E631E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionWarehousing" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionWarehousing" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionWarehousing" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionWarehousing" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionWarehousing" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionWarehousing" } } } } } }, "put": { "tags": [ "DocPositionWarehousing" ], "summary": "DocPositionWarehousing: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionWarehousing-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionWarehousing_Put_48EC5ACBC8F7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionWarehousing" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionWarehousing" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionWarehousing" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionWarehousing" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionWarehousing" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionWarehousing" } } } } } } }, "/api/DocPositionWarehousing/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "DocPositionWarehousing" ], "summary": "DocPositionWarehousing: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionWarehousing-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionWarehousing_GetPageByValue_5FFFCC8614CA", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocPositionWarehousing/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "DocPositionWarehousing" ], "summary": "DocPositionWarehousing: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionWarehousing-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionWarehousing_GetPageByValue2_105DDB1A76AC", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocPositionWarehousing/DeleteByFilter": { "post": { "tags": [ "DocPositionWarehousing" ], "summary": "DocPositionWarehousing: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionWarehousing-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionWarehousing_DeleteByFilter_C872B1D3922A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/DocPositionWarehousing/DeleteWarehousing": { "post": { "tags": [ "DocPositionWarehousing" ], "summary": "DocPositionWarehousing: DeleteWarehousing", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionWarehousing-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionWarehousing_DeleteWarehousing_B7064953EF41", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionWarehousing_DeleteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionWarehousing_DeleteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionWarehousing_DeleteRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/DocPositionWarehousing/GetAllByValue": { "post": { "tags": [ "DocPositionWarehousing" ], "summary": "DocPositionWarehousing: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionWarehousing-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionWarehousing_GetAllByValue_2D0F80A23751", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocPositionWarehousing" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocPositionWarehousing" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocPositionWarehousing" } } } } } } }, "/api/DocPositionWarehousing/GetAllFromViewByValue": { "post": { "tags": [ "DocPositionWarehousing" ], "summary": "DocPositionWarehousing: GetAllFromViewByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionWarehousing-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionWarehousing_GetAllFromViewByValue_9D5861C06D78", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionWarehousing_GetAllFromViewByValueRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionWarehousing_GetAllFromViewByValueRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionWarehousing_GetAllFromViewByValueRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW225_DocPositionWarehousing" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW225_DocPositionWarehousing" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW225_DocPositionWarehousing" } } } } } } }, "/api/DocPositionWarehousing/GetAllGraphByValue": { "post": { "tags": [ "DocPositionWarehousing" ], "summary": "DocPositionWarehousing: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionWarehousing-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionWarehousing_GetAllGraphByValue_BC3393C14FE7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocPositionWarehousing" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocPositionWarehousing" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocPositionWarehousing" } } } } } } }, "/api/DocPositionWarehousing/GetByValue": { "post": { "tags": [ "DocPositionWarehousing" ], "summary": "DocPositionWarehousing: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionWarehousing-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionWarehousing_GetByValue_888264126B4F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionWarehousing" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionWarehousing" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionWarehousing" } } } } } } }, "/api/DocPositionWarehousing/GetLookup": { "post": { "tags": [ "DocPositionWarehousing" ], "summary": "DocPositionWarehousing: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionWarehousing-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionWarehousing_GetLookup_5C8853DA18D4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/DocPositionWarehousing/GetLookupByValue": { "post": { "tags": [ "DocPositionWarehousing" ], "summary": "DocPositionWarehousing: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionWarehousing-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionWarehousing_GetLookupByValue_10A820723B08", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/DocPositionWarehousing/InsertWarehousing": { "post": { "tags": [ "DocPositionWarehousing" ], "summary": "DocPositionWarehousing: InsertWarehousing", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionWarehousing-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionWarehousing_InsertWarehousing_8D6272D2CDC2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionWarehousing_InsertRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionWarehousing_InsertRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionWarehousing_InsertRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xPROC229I_DocPositionWarehousingResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xPROC229I_DocPositionWarehousingResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xPROC229I_DocPositionWarehousingResult" } } } } } } }, "/api/DocPositionWarehousing/Page": { "get": { "tags": [ "DocPositionWarehousing" ], "summary": "DocPositionWarehousing: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionWarehousing-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionWarehousing_GetPage_74FF50FA7121", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocPositionWarehousing/PageAsc": { "get": { "tags": [ "DocPositionWarehousing" ], "summary": "DocPositionWarehousing: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionWarehousing-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionWarehousing_GetPageAsc_0AD4B1AE4DEA", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocPositionWarehousing/SaveDraftWarehousing": { "post": { "tags": [ "DocPositionWarehousing" ], "summary": "DocPositionWarehousing: SaveDraftWarehousingResult", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionWarehousing-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionWarehousing_SaveDraftWarehousingResult_5BB91FB21127", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionWarehousing_DocIdRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionWarehousing_DocIdRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionWarehousing_DocIdRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SaveDraftWarehousingResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SaveDraftWarehousingResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SaveDraftWarehousingResult" } } } } } } }, "/api/DocPositionWarehousing/SearchByValue": { "post": { "tags": [ "DocPositionWarehousing" ], "summary": "DocPositionWarehousing: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionWarehousing-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionWarehousing_SearchByValue_5D8A8E3227DF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocPositionWarehousing" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocPositionWarehousing" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocPositionWarehousing" } } } } } } }, "/api/DocPositionWarehousing/TryGetByValue": { "post": { "tags": [ "DocPositionWarehousing" ], "summary": "DocPositionWarehousing: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionWarehousing-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionWarehousing_TryGetByValue_D23E1F495F22", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionWarehousing" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionWarehousing" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionWarehousing" } } } } } } }, "/api/DocPositionWarehousing/Unpack": { "post": { "tags": [ "DocPositionWarehousing" ], "summary": "DocPositionWarehousing: Unpack", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionWarehousing-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionWarehousing_Unpack_D01AABAD2E14", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionWarehousing_DocIdRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionWarehousing_DocIdRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionWarehousing_DocIdRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/DocPositionWarehousing/UpdateWarehousing_BinLocationId": { "post": { "tags": [ "DocPositionWarehousing" ], "summary": "DocPositionWarehousing: UpdateWarehousing_BinLocationId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionWarehousing-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionWarehousing_UpdateWarehousing_BinLocationId_C4CF23ADFF3E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionWarehousing_UpdateBinLocationIdRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionWarehousing_UpdateBinLocationIdRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionWarehousing_UpdateBinLocationIdRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xPROC229U_DocPositionWarehousing_BinLocationIdResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xPROC229U_DocPositionWarehousing_BinLocationIdResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xPROC229U_DocPositionWarehousing_BinLocationIdResult" } } } } } } }, "/api/DocPositionWarehousing/UpdateWarehousing_IndividualizationNumberId": { "post": { "tags": [ "DocPositionWarehousing" ], "summary": "DocPositionWarehousing: UpdateWarehousing_IndividualizationNumberId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionWarehousing-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionWarehousing_UpdateWarehousing_IndividualizationNumberId_3FE06BFE28F7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionWarehousing_UpdateIndividualizationNumberIdRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionWarehousing_UpdateIndividualizationNumberIdRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionWarehousing_UpdateIndividualizationNumberIdRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/DocPositionWarehousing/UpdateWarehousing_Quantity": { "post": { "tags": [ "DocPositionWarehousing" ], "summary": "DocPositionWarehousing: UpdateWarehousing_Quantity", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionWarehousing-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionWarehousing_UpdateWarehousing_Quantity_A5CEE03EB9A3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionWarehousing_UpdateQuantityRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionWarehousing_UpdateQuantityRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionWarehousing_UpdateQuantityRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/DocPositionWarehousing/UpdateWarehousing_WarehouseId": { "post": { "tags": [ "DocPositionWarehousing" ], "summary": "DocPositionWarehousing: UpdateWarehousing_WarehouseId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionWarehousing-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionWarehousing_UpdateWarehousing_WarehouseId_2ADAAD99AC73", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionWarehousing_UpdateWarehouseIdRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionWarehousing_UpdateWarehouseIdRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionWarehousing_UpdateWarehouseIdRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xPROC229U_DocPositionWarehousing_WarehouseIdResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xPROC229U_DocPositionWarehousing_WarehouseIdResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xPROC229U_DocPositionWarehousing_WarehouseIdResult" } } } } } } }, "/api/DocPositionWarehousing/UpdateWarehousing_WarehouseMediumId": { "post": { "tags": [ "DocPositionWarehousing" ], "summary": "DocPositionWarehousing: UpdateWarehousing_WarehouseMediumId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionWarehousing-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionWarehousing_UpdateWarehousing_WarehouseMediumId_B2EA8A52B50F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionWarehousing_UpdateWarehouseMediumIdRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionWarehousing_UpdateWarehouseMediumIdRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionWarehousing_UpdateWarehouseMediumIdRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/DocPositionWarehousing/UpsertGraph": { "put": { "tags": [ "DocPositionWarehousing" ], "summary": "DocPositionWarehousing: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionWarehousing-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionWarehousing_UpsertGraph_320A80EFEEA6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionWarehousing" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionWarehousing" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionWarehousing" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionWarehousing" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionWarehousing" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionWarehousing" } } } } } } }, "/api/DocPositionWarehousing/UpsertGraphWithExtraFields": { "put": { "tags": [ "DocPositionWarehousing" ], "summary": "DocPositionWarehousing: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocPositionWarehousing-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocPositionWarehousing_UpsertGraphWithExtraFields_5B0ED9099983", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocPositionWarehousing" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocPositionWarehousing" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocPositionWarehousing" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocPositionWarehousing" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocPositionWarehousing" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocPositionWarehousing" } } } } } } }, "/api/DocStatus": { "get": { "tags": [ "DocStatus" ], "summary": "DocStatus: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocStatus_GetAll_A5A52F7DC48C", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocStatus" } } } } } }, "post": { "tags": [ "DocStatus" ], "summary": "DocStatus: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocStatus-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocStatus_Post_A4399C6A0393", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocStatus" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocStatus" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocStatus" } } } } } }, "put": { "tags": [ "DocStatus" ], "summary": "DocStatus: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocStatus-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocStatus_Put_D897CB556D58", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocStatus" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocStatus" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocStatus" } } } } } } }, "/api/DocStatus/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "DocStatus" ], "summary": "DocStatus: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocStatus_GetPageByValue_1903CD12BD73", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocStatus/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "DocStatus" ], "summary": "DocStatus: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocStatus_GetPageByValue2_93D6C66E4E8B", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocStatus/DeleteByFilter": { "post": { "tags": [ "DocStatus" ], "summary": "DocStatus: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocStatus-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocStatus_DeleteByFilter_1D823854211C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/DocStatus/GetAllByValue": { "post": { "tags": [ "DocStatus" ], "summary": "DocStatus: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocStatus_GetAllByValue_4FE94A4F1D7C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocStatus" } } } } } } }, "/api/DocStatus/GetAllGraphByValue": { "post": { "tags": [ "DocStatus" ], "summary": "DocStatus: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocStatus_GetAllGraphByValue_011895AEF7D8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocStatus" } } } } } } }, "/api/DocStatus/GetByValue": { "post": { "tags": [ "DocStatus" ], "summary": "DocStatus: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocStatus_GetByValue_D10C693A67CD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocStatus" } } } } } } }, "/api/DocStatus/GetLookup": { "post": { "tags": [ "DocStatus" ], "summary": "DocStatus: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocStatus_GetLookup_D8D807687878", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/DocStatus/GetLookupByValue": { "post": { "tags": [ "DocStatus" ], "summary": "DocStatus: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocStatus_GetLookupByValue_E63DBA06EFEF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/DocStatus/Page": { "get": { "tags": [ "DocStatus" ], "summary": "DocStatus: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocStatus_GetPage_9D714F02EC1D", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocStatus/PageAsc": { "get": { "tags": [ "DocStatus" ], "summary": "DocStatus: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocStatus_GetPageAsc_925B02641A68", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocStatus/SearchByValue": { "post": { "tags": [ "DocStatus" ], "summary": "DocStatus: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocStatus_SearchByValue_B6802208BC39", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocStatus" } } } } } } }, "/api/DocStatus/TryGetByValue": { "post": { "tags": [ "DocStatus" ], "summary": "DocStatus: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocStatus_TryGetByValue_16840F1E5868", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocStatus" } } } } } } }, "/api/DocStatus/UpsertGraph": { "put": { "tags": [ "DocStatus" ], "summary": "DocStatus: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocStatus-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocStatus_UpsertGraph_03CA0FBC884E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocStatus" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocStatus" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocStatus" } } } } } } }, "/api/DocStatus/UpsertGraphWithExtraFields": { "put": { "tags": [ "DocStatus" ], "summary": "DocStatus: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocStatus-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocStatus_UpsertGraphWithExtraFields_B0027CF7B6E4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocStatus" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocStatus" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocStatus" } } } } } } }, "/api/DocType": { "get": { "tags": [ "DocType" ], "summary": "DocType: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocType_GetAll_C6DFD61FFFB8", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocType" } } } } } }, "post": { "tags": [ "DocType" ], "summary": "DocType: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocType-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocType_Post_D69CC750F4B8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocType" } } } } } }, "put": { "tags": [ "DocType" ], "summary": "DocType: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocType_Put_4FC387BB6C22", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocType" } } } } } } }, "/api/DocType/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "DocType" ], "summary": "DocType: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocType_GetPageByValue_1D13D43004B5", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocType/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "DocType" ], "summary": "DocType: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocType_GetPageByValue2_10D92635876C", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocType/DeleteByFilter": { "post": { "tags": [ "DocType" ], "summary": "DocType: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocType-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocType_DeleteByFilter_5A40443AF83F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/DocType/GetAdminDocTypesWithDocCreated": { "post": { "tags": [ "DocType" ], "summary": "DocType: GetAdminDocTypesWithDocCreated", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocType-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocType_GetAdminDocTypesWithDocCreated_E5BB1526F944", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocType_GetAdminDocTypesWithDocCreatedRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocType_GetAdminDocTypesWithDocCreatedRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocType_GetAdminDocTypesWithDocCreatedRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocType" } } } } } } }, "/api/DocType/GetAllByValue": { "post": { "tags": [ "DocType" ], "summary": "DocType: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocType_GetAllByValue_0ECADDA64E63", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocType" } } } } } } }, "/api/DocType/GetAllGraphByValue": { "post": { "tags": [ "DocType" ], "summary": "DocType: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocType_GetAllGraphByValue_C706DDAFBE7E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocType" } } } } } } }, "/api/DocType/GetByValue": { "post": { "tags": [ "DocType" ], "summary": "DocType: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocType_GetByValue_8822BF401966", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocType" } } } } } } }, "/api/DocType/GetLookup": { "post": { "tags": [ "DocType" ], "summary": "DocType: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocType_GetLookup_90BBD84E56BD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/DocType/GetLookupByValue": { "post": { "tags": [ "DocType" ], "summary": "DocType: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocType_GetLookupByValue_7B74DC70B2F6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/DocType/Page": { "get": { "tags": [ "DocType" ], "summary": "DocType: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocType_GetPage_F9CD4310E26E", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocType/PageAsc": { "get": { "tags": [ "DocType" ], "summary": "DocType: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocType_GetPageAsc_F71D720BCD8F", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocType/SearchByValue": { "post": { "tags": [ "DocType" ], "summary": "DocType: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocType_SearchByValue_CB05516CE943", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocType" } } } } } } }, "/api/DocType/TryGetByValue": { "post": { "tags": [ "DocType" ], "summary": "DocType: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocType_TryGetByValue_B1A755BA1192", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocType" } } } } } } }, "/api/DocType/UpsertGraph": { "put": { "tags": [ "DocType" ], "summary": "DocType: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocType_UpsertGraph_5187ED3CE243", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocType" } } } } } } }, "/api/DocType/UpsertGraphWithExtraFields": { "put": { "tags": [ "DocType" ], "summary": "DocType: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocType_UpsertGraphWithExtraFields_6E9AE9CAE5FD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocType" } } } } } } }, "/api/DocTypeInventoryStatus": { "get": { "tags": [ "DocTypeInventoryStatus" ], "summary": "DocTypeInventoryStatus: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocTypeInventoryStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocTypeInventoryStatus_GetAll_4992F3D20268", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocTypeInventoryStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocTypeInventoryStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocTypeInventoryStatus" } } } } } }, "post": { "tags": [ "DocTypeInventoryStatus" ], "summary": "DocTypeInventoryStatus: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocTypeInventoryStatus-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocTypeInventoryStatus_Post_4820D7CEFDCA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocTypeInventoryStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocTypeInventoryStatus" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocTypeInventoryStatus" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocTypeInventoryStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocTypeInventoryStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocTypeInventoryStatus" } } } } } }, "put": { "tags": [ "DocTypeInventoryStatus" ], "summary": "DocTypeInventoryStatus: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocTypeInventoryStatus-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocTypeInventoryStatus_Put_105C751A62D6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocTypeInventoryStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocTypeInventoryStatus" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocTypeInventoryStatus" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocTypeInventoryStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocTypeInventoryStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocTypeInventoryStatus" } } } } } } }, "/api/DocTypeInventoryStatus/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "DocTypeInventoryStatus" ], "summary": "DocTypeInventoryStatus: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocTypeInventoryStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocTypeInventoryStatus_GetPageByValue_5D217CBAFE05", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocTypeInventoryStatus/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "DocTypeInventoryStatus" ], "summary": "DocTypeInventoryStatus: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocTypeInventoryStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocTypeInventoryStatus_GetPageByValue2_25DE9AE5886B", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocTypeInventoryStatus/DeleteByFilter": { "post": { "tags": [ "DocTypeInventoryStatus" ], "summary": "DocTypeInventoryStatus: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocTypeInventoryStatus-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocTypeInventoryStatus_DeleteByFilter_853E8B9612F2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/DocTypeInventoryStatus/GetAllByValue": { "post": { "tags": [ "DocTypeInventoryStatus" ], "summary": "DocTypeInventoryStatus: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocTypeInventoryStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocTypeInventoryStatus_GetAllByValue_2A26C944C37E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocTypeInventoryStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocTypeInventoryStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocTypeInventoryStatus" } } } } } } }, "/api/DocTypeInventoryStatus/GetAllGraphByValue": { "post": { "tags": [ "DocTypeInventoryStatus" ], "summary": "DocTypeInventoryStatus: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocTypeInventoryStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocTypeInventoryStatus_GetAllGraphByValue_83AB55212AE9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocTypeInventoryStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocTypeInventoryStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocTypeInventoryStatus" } } } } } } }, "/api/DocTypeInventoryStatus/GetByValue": { "post": { "tags": [ "DocTypeInventoryStatus" ], "summary": "DocTypeInventoryStatus: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocTypeInventoryStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocTypeInventoryStatus_GetByValue_ED39D333394E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocTypeInventoryStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocTypeInventoryStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocTypeInventoryStatus" } } } } } } }, "/api/DocTypeInventoryStatus/GetLookup": { "post": { "tags": [ "DocTypeInventoryStatus" ], "summary": "DocTypeInventoryStatus: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocTypeInventoryStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocTypeInventoryStatus_GetLookup_219E9A98624A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/DocTypeInventoryStatus/GetLookupByValue": { "post": { "tags": [ "DocTypeInventoryStatus" ], "summary": "DocTypeInventoryStatus: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocTypeInventoryStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocTypeInventoryStatus_GetLookupByValue_BC9B7BB71309", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/DocTypeInventoryStatus/Page": { "get": { "tags": [ "DocTypeInventoryStatus" ], "summary": "DocTypeInventoryStatus: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocTypeInventoryStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocTypeInventoryStatus_GetPage_3F9CF042D270", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocTypeInventoryStatus/PageAsc": { "get": { "tags": [ "DocTypeInventoryStatus" ], "summary": "DocTypeInventoryStatus: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocTypeInventoryStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocTypeInventoryStatus_GetPageAsc_61D20908A113", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocTypeInventoryStatus/SearchByValue": { "post": { "tags": [ "DocTypeInventoryStatus" ], "summary": "DocTypeInventoryStatus: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocTypeInventoryStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocTypeInventoryStatus_SearchByValue_E91431F88193", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocTypeInventoryStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocTypeInventoryStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocTypeInventoryStatus" } } } } } } }, "/api/DocTypeInventoryStatus/TryGetByValue": { "post": { "tags": [ "DocTypeInventoryStatus" ], "summary": "DocTypeInventoryStatus: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocTypeInventoryStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocTypeInventoryStatus_TryGetByValue_459340C3718C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocTypeInventoryStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocTypeInventoryStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocTypeInventoryStatus" } } } } } } }, "/api/DocTypeInventoryStatus/UpsertGraph": { "put": { "tags": [ "DocTypeInventoryStatus" ], "summary": "DocTypeInventoryStatus: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocTypeInventoryStatus-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocTypeInventoryStatus_UpsertGraph_337F50080765", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocTypeInventoryStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocTypeInventoryStatus" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocTypeInventoryStatus" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocTypeInventoryStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocTypeInventoryStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocTypeInventoryStatus" } } } } } } }, "/api/DocTypeInventoryStatus/UpsertGraphWithExtraFields": { "put": { "tags": [ "DocTypeInventoryStatus" ], "summary": "DocTypeInventoryStatus: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocTypeInventoryStatus-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocTypeInventoryStatus_UpsertGraphWithExtraFields_499561D077BE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocTypeInventoryStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocTypeInventoryStatus" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocTypeInventoryStatus" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocTypeInventoryStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocTypeInventoryStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocTypeInventoryStatus" } } } } } } }, "/api/DocTypePrepaymentFactor": { "get": { "tags": [ "DocTypePrepaymentFactor" ], "summary": "DocTypePrepaymentFactor: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocTypePrepaymentFactor-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocTypePrepaymentFactor_GetAll_F3D948CD304E", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocTypePrepaymentFactor" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocTypePrepaymentFactor" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocTypePrepaymentFactor" } } } } } }, "post": { "tags": [ "DocTypePrepaymentFactor" ], "summary": "DocTypePrepaymentFactor: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocTypePrepaymentFactor-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocTypePrepaymentFactor_Post_AEFC0E718996", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocTypePrepaymentFactor" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocTypePrepaymentFactor" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocTypePrepaymentFactor" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocTypePrepaymentFactor" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocTypePrepaymentFactor" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocTypePrepaymentFactor" } } } } } }, "put": { "tags": [ "DocTypePrepaymentFactor" ], "summary": "DocTypePrepaymentFactor: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocTypePrepaymentFactor-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocTypePrepaymentFactor_Put_E3F036F8E4F6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocTypePrepaymentFactor" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocTypePrepaymentFactor" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocTypePrepaymentFactor" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocTypePrepaymentFactor" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocTypePrepaymentFactor" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocTypePrepaymentFactor" } } } } } } }, "/api/DocTypePrepaymentFactor/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "DocTypePrepaymentFactor" ], "summary": "DocTypePrepaymentFactor: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocTypePrepaymentFactor-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocTypePrepaymentFactor_GetPageByValue_EA7385237939", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocTypePrepaymentFactor/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "DocTypePrepaymentFactor" ], "summary": "DocTypePrepaymentFactor: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocTypePrepaymentFactor-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocTypePrepaymentFactor_GetPageByValue2_8D0AD46FDE6B", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocTypePrepaymentFactor/DeleteByFilter": { "post": { "tags": [ "DocTypePrepaymentFactor" ], "summary": "DocTypePrepaymentFactor: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocTypePrepaymentFactor-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocTypePrepaymentFactor_DeleteByFilter_59C7AD86395F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/DocTypePrepaymentFactor/GetAllByValue": { "post": { "tags": [ "DocTypePrepaymentFactor" ], "summary": "DocTypePrepaymentFactor: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocTypePrepaymentFactor-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocTypePrepaymentFactor_GetAllByValue_88BDB80884D8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocTypePrepaymentFactor" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocTypePrepaymentFactor" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocTypePrepaymentFactor" } } } } } } }, "/api/DocTypePrepaymentFactor/GetAllGraphByValue": { "post": { "tags": [ "DocTypePrepaymentFactor" ], "summary": "DocTypePrepaymentFactor: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocTypePrepaymentFactor-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocTypePrepaymentFactor_GetAllGraphByValue_B9E8725B91A3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocTypePrepaymentFactor" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocTypePrepaymentFactor" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocTypePrepaymentFactor" } } } } } } }, "/api/DocTypePrepaymentFactor/GetByValue": { "post": { "tags": [ "DocTypePrepaymentFactor" ], "summary": "DocTypePrepaymentFactor: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocTypePrepaymentFactor-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocTypePrepaymentFactor_GetByValue_C7E6D9842D8E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocTypePrepaymentFactor" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocTypePrepaymentFactor" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocTypePrepaymentFactor" } } } } } } }, "/api/DocTypePrepaymentFactor/GetLookup": { "post": { "tags": [ "DocTypePrepaymentFactor" ], "summary": "DocTypePrepaymentFactor: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocTypePrepaymentFactor-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocTypePrepaymentFactor_GetLookup_7AF162C2BEA2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/DocTypePrepaymentFactor/GetLookupByValue": { "post": { "tags": [ "DocTypePrepaymentFactor" ], "summary": "DocTypePrepaymentFactor: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocTypePrepaymentFactor-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocTypePrepaymentFactor_GetLookupByValue_C5C189551DDB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/DocTypePrepaymentFactor/Page": { "get": { "tags": [ "DocTypePrepaymentFactor" ], "summary": "DocTypePrepaymentFactor: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocTypePrepaymentFactor-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocTypePrepaymentFactor_GetPage_B2BC1CFBA807", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocTypePrepaymentFactor/PageAsc": { "get": { "tags": [ "DocTypePrepaymentFactor" ], "summary": "DocTypePrepaymentFactor: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocTypePrepaymentFactor-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocTypePrepaymentFactor_GetPageAsc_FBFE2DCC9A3F", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocTypePrepaymentFactor/SearchByValue": { "post": { "tags": [ "DocTypePrepaymentFactor" ], "summary": "DocTypePrepaymentFactor: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocTypePrepaymentFactor-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocTypePrepaymentFactor_SearchByValue_CD579E95D67B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocTypePrepaymentFactor" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocTypePrepaymentFactor" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocTypePrepaymentFactor" } } } } } } }, "/api/DocTypePrepaymentFactor/TryGetByValue": { "post": { "tags": [ "DocTypePrepaymentFactor" ], "summary": "DocTypePrepaymentFactor: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocTypePrepaymentFactor-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocTypePrepaymentFactor_TryGetByValue_AA369D6A7F90", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocTypePrepaymentFactor" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocTypePrepaymentFactor" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocTypePrepaymentFactor" } } } } } } }, "/api/DocTypePrepaymentFactor/UpsertGraph": { "put": { "tags": [ "DocTypePrepaymentFactor" ], "summary": "DocTypePrepaymentFactor: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocTypePrepaymentFactor-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocTypePrepaymentFactor_UpsertGraph_407F0257C259", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocTypePrepaymentFactor" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocTypePrepaymentFactor" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocTypePrepaymentFactor" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocTypePrepaymentFactor" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocTypePrepaymentFactor" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocTypePrepaymentFactor" } } } } } } }, "/api/DocTypePrepaymentFactor/UpsertGraphWithExtraFields": { "put": { "tags": [ "DocTypePrepaymentFactor" ], "summary": "DocTypePrepaymentFactor: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocTypePrepaymentFactor-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocTypePrepaymentFactor_UpsertGraphWithExtraFields_95296A9E0CA5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocTypePrepaymentFactor" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocTypePrepaymentFactor" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocTypePrepaymentFactor" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocTypePrepaymentFactor" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocTypePrepaymentFactor" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocTypePrepaymentFactor" } } } } } } }, "/api/DocTypeRevenueEffective": { "get": { "tags": [ "DocTypeRevenueEffective" ], "summary": "DocTypeRevenueEffective: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocTypeRevenueEffective-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocTypeRevenueEffective_GetAll_CF5BB3F6D35F", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocTypeRevenueEffective" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocTypeRevenueEffective" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocTypeRevenueEffective" } } } } } }, "post": { "tags": [ "DocTypeRevenueEffective" ], "summary": "DocTypeRevenueEffective: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocTypeRevenueEffective-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocTypeRevenueEffective_Post_F56AEC541A17", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocTypeRevenueEffective" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocTypeRevenueEffective" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocTypeRevenueEffective" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocTypeRevenueEffective" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocTypeRevenueEffective" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocTypeRevenueEffective" } } } } } }, "put": { "tags": [ "DocTypeRevenueEffective" ], "summary": "DocTypeRevenueEffective: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocTypeRevenueEffective-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocTypeRevenueEffective_Put_D55A38177076", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocTypeRevenueEffective" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocTypeRevenueEffective" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocTypeRevenueEffective" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocTypeRevenueEffective" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocTypeRevenueEffective" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocTypeRevenueEffective" } } } } } } }, "/api/DocTypeRevenueEffective/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "DocTypeRevenueEffective" ], "summary": "DocTypeRevenueEffective: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocTypeRevenueEffective-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocTypeRevenueEffective_GetPageByValue_8794B88346DC", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocTypeRevenueEffective/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "DocTypeRevenueEffective" ], "summary": "DocTypeRevenueEffective: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocTypeRevenueEffective-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocTypeRevenueEffective_GetPageByValue2_FAE0E42BCD3C", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocTypeRevenueEffective/DeleteByFilter": { "post": { "tags": [ "DocTypeRevenueEffective" ], "summary": "DocTypeRevenueEffective: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocTypeRevenueEffective-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocTypeRevenueEffective_DeleteByFilter_7B336A22EEC6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/DocTypeRevenueEffective/GetAllByValue": { "post": { "tags": [ "DocTypeRevenueEffective" ], "summary": "DocTypeRevenueEffective: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocTypeRevenueEffective-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocTypeRevenueEffective_GetAllByValue_D2506FAA948F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocTypeRevenueEffective" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocTypeRevenueEffective" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocTypeRevenueEffective" } } } } } } }, "/api/DocTypeRevenueEffective/GetAllGraphByValue": { "post": { "tags": [ "DocTypeRevenueEffective" ], "summary": "DocTypeRevenueEffective: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocTypeRevenueEffective-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocTypeRevenueEffective_GetAllGraphByValue_E63B6C256E69", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocTypeRevenueEffective" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocTypeRevenueEffective" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocTypeRevenueEffective" } } } } } } }, "/api/DocTypeRevenueEffective/GetByValue": { "post": { "tags": [ "DocTypeRevenueEffective" ], "summary": "DocTypeRevenueEffective: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocTypeRevenueEffective-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocTypeRevenueEffective_GetByValue_28CF6525588E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocTypeRevenueEffective" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocTypeRevenueEffective" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocTypeRevenueEffective" } } } } } } }, "/api/DocTypeRevenueEffective/GetLookup": { "post": { "tags": [ "DocTypeRevenueEffective" ], "summary": "DocTypeRevenueEffective: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocTypeRevenueEffective-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocTypeRevenueEffective_GetLookup_D76A874C3E3D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/DocTypeRevenueEffective/GetLookupByValue": { "post": { "tags": [ "DocTypeRevenueEffective" ], "summary": "DocTypeRevenueEffective: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocTypeRevenueEffective-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocTypeRevenueEffective_GetLookupByValue_C8F9F4CDD355", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/DocTypeRevenueEffective/Page": { "get": { "tags": [ "DocTypeRevenueEffective" ], "summary": "DocTypeRevenueEffective: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocTypeRevenueEffective-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocTypeRevenueEffective_GetPage_0C12FC4D803E", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocTypeRevenueEffective/PageAsc": { "get": { "tags": [ "DocTypeRevenueEffective" ], "summary": "DocTypeRevenueEffective: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocTypeRevenueEffective-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocTypeRevenueEffective_GetPageAsc_3D7EBA512825", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocTypeRevenueEffective/SearchByValue": { "post": { "tags": [ "DocTypeRevenueEffective" ], "summary": "DocTypeRevenueEffective: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocTypeRevenueEffective-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocTypeRevenueEffective_SearchByValue_F79BA18BA7E7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocTypeRevenueEffective" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocTypeRevenueEffective" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocTypeRevenueEffective" } } } } } } }, "/api/DocTypeRevenueEffective/TryGetByValue": { "post": { "tags": [ "DocTypeRevenueEffective" ], "summary": "DocTypeRevenueEffective: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocTypeRevenueEffective-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocTypeRevenueEffective_TryGetByValue_746F8EEEAAD5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocTypeRevenueEffective" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocTypeRevenueEffective" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocTypeRevenueEffective" } } } } } } }, "/api/DocTypeRevenueEffective/UpsertGraph": { "put": { "tags": [ "DocTypeRevenueEffective" ], "summary": "DocTypeRevenueEffective: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocTypeRevenueEffective-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocTypeRevenueEffective_UpsertGraph_7FE43AA61A3D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocTypeRevenueEffective" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocTypeRevenueEffective" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocTypeRevenueEffective" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocTypeRevenueEffective" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocTypeRevenueEffective" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocTypeRevenueEffective" } } } } } } }, "/api/DocTypeRevenueEffective/UpsertGraphWithExtraFields": { "put": { "tags": [ "DocTypeRevenueEffective" ], "summary": "DocTypeRevenueEffective: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocTypeRevenueEffective-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocTypeRevenueEffective_UpsertGraphWithExtraFields_EF8FCC60D75B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocTypeRevenueEffective" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocTypeRevenueEffective" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocTypeRevenueEffective" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocTypeRevenueEffective" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocTypeRevenueEffective" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocTypeRevenueEffective" } } } } } } }, "/api/DocTypeWarehousingEffective": { "get": { "tags": [ "DocTypeWarehousingEffective" ], "summary": "DocTypeWarehousingEffective: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocTypeWarehousingEffective-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocTypeWarehousingEffective_GetAll_A206771D07CD", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocTypeWarehousingEffective" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocTypeWarehousingEffective" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocTypeWarehousingEffective" } } } } } }, "post": { "tags": [ "DocTypeWarehousingEffective" ], "summary": "DocTypeWarehousingEffective: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocTypeWarehousingEffective-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocTypeWarehousingEffective_Post_9AE84866C554", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocTypeWarehousingEffective" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocTypeWarehousingEffective" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocTypeWarehousingEffective" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocTypeWarehousingEffective" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocTypeWarehousingEffective" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocTypeWarehousingEffective" } } } } } }, "put": { "tags": [ "DocTypeWarehousingEffective" ], "summary": "DocTypeWarehousingEffective: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocTypeWarehousingEffective-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocTypeWarehousingEffective_Put_BC9991743EE5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocTypeWarehousingEffective" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocTypeWarehousingEffective" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocTypeWarehousingEffective" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocTypeWarehousingEffective" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocTypeWarehousingEffective" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocTypeWarehousingEffective" } } } } } } }, "/api/DocTypeWarehousingEffective/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "DocTypeWarehousingEffective" ], "summary": "DocTypeWarehousingEffective: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocTypeWarehousingEffective-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocTypeWarehousingEffective_GetPageByValue_17D65634A33B", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocTypeWarehousingEffective/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "DocTypeWarehousingEffective" ], "summary": "DocTypeWarehousingEffective: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocTypeWarehousingEffective-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocTypeWarehousingEffective_GetPageByValue2_64EE92E03DBF", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocTypeWarehousingEffective/DeleteByFilter": { "post": { "tags": [ "DocTypeWarehousingEffective" ], "summary": "DocTypeWarehousingEffective: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocTypeWarehousingEffective-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocTypeWarehousingEffective_DeleteByFilter_23192B5C50FD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/DocTypeWarehousingEffective/GetAllByValue": { "post": { "tags": [ "DocTypeWarehousingEffective" ], "summary": "DocTypeWarehousingEffective: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocTypeWarehousingEffective-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocTypeWarehousingEffective_GetAllByValue_0B49FC27E0A8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocTypeWarehousingEffective" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocTypeWarehousingEffective" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocTypeWarehousingEffective" } } } } } } }, "/api/DocTypeWarehousingEffective/GetAllGraphByValue": { "post": { "tags": [ "DocTypeWarehousingEffective" ], "summary": "DocTypeWarehousingEffective: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocTypeWarehousingEffective-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocTypeWarehousingEffective_GetAllGraphByValue_BAA4D228E5BC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocTypeWarehousingEffective" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocTypeWarehousingEffective" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocTypeWarehousingEffective" } } } } } } }, "/api/DocTypeWarehousingEffective/GetByValue": { "post": { "tags": [ "DocTypeWarehousingEffective" ], "summary": "DocTypeWarehousingEffective: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocTypeWarehousingEffective-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocTypeWarehousingEffective_GetByValue_7C52B3CE6DB9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocTypeWarehousingEffective" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocTypeWarehousingEffective" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocTypeWarehousingEffective" } } } } } } }, "/api/DocTypeWarehousingEffective/GetLookup": { "post": { "tags": [ "DocTypeWarehousingEffective" ], "summary": "DocTypeWarehousingEffective: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocTypeWarehousingEffective-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocTypeWarehousingEffective_GetLookup_C2CEADEDBA54", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/DocTypeWarehousingEffective/GetLookupByValue": { "post": { "tags": [ "DocTypeWarehousingEffective" ], "summary": "DocTypeWarehousingEffective: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocTypeWarehousingEffective-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocTypeWarehousingEffective_GetLookupByValue_B17343533044", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/DocTypeWarehousingEffective/Page": { "get": { "tags": [ "DocTypeWarehousingEffective" ], "summary": "DocTypeWarehousingEffective: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocTypeWarehousingEffective-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocTypeWarehousingEffective_GetPage_86869BD17BBB", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocTypeWarehousingEffective/PageAsc": { "get": { "tags": [ "DocTypeWarehousingEffective" ], "summary": "DocTypeWarehousingEffective: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocTypeWarehousingEffective-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocTypeWarehousingEffective_GetPageAsc_DBFF819DADE5", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocTypeWarehousingEffective/SearchByValue": { "post": { "tags": [ "DocTypeWarehousingEffective" ], "summary": "DocTypeWarehousingEffective: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocTypeWarehousingEffective-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocTypeWarehousingEffective_SearchByValue_480951454920", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocTypeWarehousingEffective" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocTypeWarehousingEffective" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocTypeWarehousingEffective" } } } } } } }, "/api/DocTypeWarehousingEffective/TryGetByValue": { "post": { "tags": [ "DocTypeWarehousingEffective" ], "summary": "DocTypeWarehousingEffective: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocTypeWarehousingEffective-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocTypeWarehousingEffective_TryGetByValue_CE7D421D3EDD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocTypeWarehousingEffective" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocTypeWarehousingEffective" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocTypeWarehousingEffective" } } } } } } }, "/api/DocTypeWarehousingEffective/UpsertGraph": { "put": { "tags": [ "DocTypeWarehousingEffective" ], "summary": "DocTypeWarehousingEffective: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocTypeWarehousingEffective-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocTypeWarehousingEffective_UpsertGraph_32184A9C4CC3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocTypeWarehousingEffective" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocTypeWarehousingEffective" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocTypeWarehousingEffective" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocTypeWarehousingEffective" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocTypeWarehousingEffective" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocTypeWarehousingEffective" } } } } } } }, "/api/DocTypeWarehousingEffective/UpsertGraphWithExtraFields": { "put": { "tags": [ "DocTypeWarehousingEffective" ], "summary": "DocTypeWarehousingEffective: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocTypeWarehousingEffective-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocTypeWarehousingEffective_UpsertGraphWithExtraFields_797188E9B4DD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocTypeWarehousingEffective" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocTypeWarehousingEffective" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocTypeWarehousingEffective" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocTypeWarehousingEffective" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocTypeWarehousingEffective" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocTypeWarehousingEffective" } } } } } } }, "/api/DocXml": { "get": { "tags": [ "DocXml" ], "summary": "DocXml: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocXml-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocXml_GetAll_BB2D04DD64F1", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocXml" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocXml" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocXml" } } } } } }, "post": { "tags": [ "DocXml" ], "summary": "DocXml: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocXml-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocXml_Post_9F8D50EC8C16", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXml" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXml" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXml" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocXml" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocXml" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocXml" } } } } } }, "put": { "tags": [ "DocXml" ], "summary": "DocXml: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocXml-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocXml_Put_B8B05C352627", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXml" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXml" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXml" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocXml" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocXml" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocXml" } } } } } } }, "/api/DocXml/{DocCategoryId}/{UnprocessedOnly}/PageFromView": { "get": { "tags": [ "DocXml" ], "summary": "DocXml: GetPageFromView", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocXml-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocXml_GetPageFromView_11D73095BE42", "parameters": [ { "name": "DocCategoryId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "UnprocessedOnly", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocXml/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "DocXml" ], "summary": "DocXml: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocXml-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocXml_GetPageByValue_340CEEA30521", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocXml/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "DocXml" ], "summary": "DocXml: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocXml-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocXml_GetPageByValue2_20380CBED5E4", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocXml/ApplyPredecessorLinks": { "post": { "tags": [ "DocXml" ], "summary": "DocXml: ApplyPredecessorLinks", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocXml-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocXml_ApplyPredecessorLinks_E13ADC18658D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXml_ApplyPredecessorLinksRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXml_ApplyPredecessorLinksRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXml_ApplyPredecessorLinksRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/DocXml/CreateNewDoc": { "post": { "tags": [ "DocXml" ], "summary": "DocXml: CreateNewDoc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocXml-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocXml_CreateNewDoc_EF5581434898", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXml_CreateNewDocRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXml_CreateNewDocRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXml_CreateNewDocRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TransferDocXmlToDocErrorMessages" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TransferDocXmlToDocErrorMessages" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TransferDocXmlToDocErrorMessages" } } } } } } }, "/api/DocXml/DeleteByFilter": { "post": { "tags": [ "DocXml" ], "summary": "DocXml: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocXml-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocXml_DeleteByFilter_44DEE141AFC1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/DocXml/DownloadDocXmlFile/{DocXmlId}": { "get": { "tags": [ "DocXml" ], "summary": "DocXml: DownloadDocXmlFile", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocXml-Read.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocXml_DownloadDocXmlFile_B3EF9B7BCACC", "parameters": [ { "name": "DocXmlId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocXml/GetAllByValue": { "post": { "tags": [ "DocXml" ], "summary": "DocXml: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocXml-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocXml_GetAllByValue_335BA45E4D86", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocXml" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocXml" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocXml" } } } } } } }, "/api/DocXml/GetAllGraphByValue": { "post": { "tags": [ "DocXml" ], "summary": "DocXml: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocXml-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocXml_GetAllGraphByValue_ACFD707B681D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocXml" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocXml" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocXml" } } } } } } }, "/api/DocXml/GetByValue": { "post": { "tags": [ "DocXml" ], "summary": "DocXml: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocXml-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocXml_GetByValue_CFCF69502A88", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocXml" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocXml" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocXml" } } } } } } }, "/api/DocXml/GetLookup": { "post": { "tags": [ "DocXml" ], "summary": "DocXml: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocXml-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocXml_GetLookup_5136DEB89D4F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/DocXml/GetLookupByValue": { "post": { "tags": [ "DocXml" ], "summary": "DocXml: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocXml-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocXml_GetLookupByValue_B93F6B7A226B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/DocXml/GetPredecessorCandidates/{DocXmlId}": { "get": { "tags": [ "DocXml" ], "summary": "DocXml: GetPredecessorCandidates", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocXml-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocXml_GetPredecessorCandidates_21303637C0D5", "parameters": [ { "name": "DocXmlId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocXmlPredecessorData" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocXmlPredecessorData" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocXmlPredecessorData" } } } } } } }, "/api/DocXml/ImportDocXml": { "post": { "tags": [ "DocXml" ], "summary": "DocXml: ImportDocXml", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocXml-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocXml_ImportDocXml_4E6F7F019E49", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXml_ImportRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXml_ImportRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXml_ImportRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/DocXml/MatchPartner": { "post": { "tags": [ "DocXml" ], "summary": "DocXml: MatchPartner", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocXml-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocXml_MatchPartner_BED0DBDB14DF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXml_MatchPartnerRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXml_MatchPartnerRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXml_MatchPartnerRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/DocXml/Page": { "get": { "tags": [ "DocXml" ], "summary": "DocXml: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocXml-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocXml_GetPage_AF7469C857E9", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocXml/PageAsc": { "get": { "tags": [ "DocXml" ], "summary": "DocXml: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocXml-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocXml_GetPageAsc_CC95224EA498", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocXml/SavePredecessorLink": { "post": { "tags": [ "DocXml" ], "summary": "DocXml: SavePredecessorLink", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocXml-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocXml_SavePredecessorLink_2A9E7EA81DA0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXml_SavePredecessorLinkRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXml_SavePredecessorLinkRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXml_SavePredecessorLinkRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/DocXml/SearchByValue": { "post": { "tags": [ "DocXml" ], "summary": "DocXml: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocXml-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocXml_SearchByValue_B52383FEF0A6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocXml" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocXml" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocXml" } } } } } } }, "/api/DocXml/TryGetByValue": { "post": { "tags": [ "DocXml" ], "summary": "DocXml: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocXml-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocXml_TryGetByValue_9ED4583AABE6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocXml" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocXml" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocXml" } } } } } } }, "/api/DocXml/UpsertGraph": { "put": { "tags": [ "DocXml" ], "summary": "DocXml: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocXml-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocXml_UpsertGraph_BCB42D0B7289", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXml" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXml" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXml" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocXml" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocXml" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocXml" } } } } } } }, "/api/DocXml/UpsertGraphWithExtraFields": { "put": { "tags": [ "DocXml" ], "summary": "DocXml: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocXml-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocXml_UpsertGraphWithExtraFields_98E0043EEC38", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocXml" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocXml" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocXml" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocXml" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocXml" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocXml" } } } } } } }, "/api/DocXmlAssignment": { "get": { "tags": [ "DocXmlAssignment" ], "summary": "DocXmlAssignment: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocXmlAssignment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocXmlAssignment_GetAll_09FA54B0E434", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocXmlAssignment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocXmlAssignment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocXmlAssignment" } } } } } }, "post": { "tags": [ "DocXmlAssignment" ], "summary": "DocXmlAssignment: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocXmlAssignment-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocXmlAssignment_Post_06335FA46117", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXmlAssignment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXmlAssignment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXmlAssignment" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocXmlAssignment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocXmlAssignment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocXmlAssignment" } } } } } }, "put": { "tags": [ "DocXmlAssignment" ], "summary": "DocXmlAssignment: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocXmlAssignment-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocXmlAssignment_Put_888DF7EAFFCE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXmlAssignment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXmlAssignment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXmlAssignment" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocXmlAssignment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocXmlAssignment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocXmlAssignment" } } } } } } }, "/api/DocXmlAssignment/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "DocXmlAssignment" ], "summary": "DocXmlAssignment: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocXmlAssignment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocXmlAssignment_GetPageByValue_235FBCB0E73A", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocXmlAssignment/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "DocXmlAssignment" ], "summary": "DocXmlAssignment: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocXmlAssignment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocXmlAssignment_GetPageByValue2_C0E91D86E23B", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocXmlAssignment/DeleteByFilter": { "post": { "tags": [ "DocXmlAssignment" ], "summary": "DocXmlAssignment: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocXmlAssignment-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocXmlAssignment_DeleteByFilter_558033891D82", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/DocXmlAssignment/GetAllByValue": { "post": { "tags": [ "DocXmlAssignment" ], "summary": "DocXmlAssignment: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocXmlAssignment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocXmlAssignment_GetAllByValue_F412ABFB5285", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocXmlAssignment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocXmlAssignment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocXmlAssignment" } } } } } } }, "/api/DocXmlAssignment/GetAllGraphByValue": { "post": { "tags": [ "DocXmlAssignment" ], "summary": "DocXmlAssignment: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocXmlAssignment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocXmlAssignment_GetAllGraphByValue_1E7C39E49D91", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocXmlAssignment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocXmlAssignment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocXmlAssignment" } } } } } } }, "/api/DocXmlAssignment/GetByValue": { "post": { "tags": [ "DocXmlAssignment" ], "summary": "DocXmlAssignment: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocXmlAssignment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocXmlAssignment_GetByValue_F20C091A2A91", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocXmlAssignment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocXmlAssignment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocXmlAssignment" } } } } } } }, "/api/DocXmlAssignment/GetLookup": { "post": { "tags": [ "DocXmlAssignment" ], "summary": "DocXmlAssignment: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocXmlAssignment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocXmlAssignment_GetLookup_409BE4AEF698", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/DocXmlAssignment/GetLookupByValue": { "post": { "tags": [ "DocXmlAssignment" ], "summary": "DocXmlAssignment: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocXmlAssignment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocXmlAssignment_GetLookupByValue_67BB909CAAA1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/DocXmlAssignment/Page": { "get": { "tags": [ "DocXmlAssignment" ], "summary": "DocXmlAssignment: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocXmlAssignment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocXmlAssignment_GetPage_9385C8E6033F", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocXmlAssignment/PageAsc": { "get": { "tags": [ "DocXmlAssignment" ], "summary": "DocXmlAssignment: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocXmlAssignment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocXmlAssignment_GetPageAsc_CFC59D10BD22", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocXmlAssignment/SearchByValue": { "post": { "tags": [ "DocXmlAssignment" ], "summary": "DocXmlAssignment: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocXmlAssignment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocXmlAssignment_SearchByValue_A40A2F558D31", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocXmlAssignment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocXmlAssignment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocXmlAssignment" } } } } } } }, "/api/DocXmlAssignment/TryGetByValue": { "post": { "tags": [ "DocXmlAssignment" ], "summary": "DocXmlAssignment: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocXmlAssignment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocXmlAssignment_TryGetByValue_4E7623CF1D94", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocXmlAssignment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocXmlAssignment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocXmlAssignment" } } } } } } }, "/api/DocXmlAssignment/UpsertGraph": { "put": { "tags": [ "DocXmlAssignment" ], "summary": "DocXmlAssignment: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocXmlAssignment-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocXmlAssignment_UpsertGraph_E9E815006C5E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXmlAssignment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXmlAssignment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXmlAssignment" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocXmlAssignment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocXmlAssignment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocXmlAssignment" } } } } } } }, "/api/DocXmlAssignment/UpsertGraphWithExtraFields": { "put": { "tags": [ "DocXmlAssignment" ], "summary": "DocXmlAssignment: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocXmlAssignment-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocXmlAssignment_UpsertGraphWithExtraFields_F3E2D2EDAF12", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocXmlAssignment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocXmlAssignment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocXmlAssignment" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocXmlAssignment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocXmlAssignment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocXmlAssignment" } } } } } } }, "/api/DocXmlPosition": { "get": { "tags": [ "DocXmlPosition" ], "summary": "DocXmlPosition: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocXmlPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocXmlPosition_GetAll_5A0301CFF6CD", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocXmlPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocXmlPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocXmlPosition" } } } } } }, "post": { "tags": [ "DocXmlPosition" ], "summary": "DocXmlPosition: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocXmlPosition-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocXmlPosition_Post_F45E37094E6B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXmlPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXmlPosition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXmlPosition" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocXmlPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocXmlPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocXmlPosition" } } } } } }, "put": { "tags": [ "DocXmlPosition" ], "summary": "DocXmlPosition: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocXmlPosition-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocXmlPosition_Put_89B357807CEC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXmlPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXmlPosition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXmlPosition" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocXmlPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocXmlPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocXmlPosition" } } } } } } }, "/api/DocXmlPosition/{DocId}/GetPageDocXmlPositionsOpenOrPartially": { "get": { "tags": [ "DocXmlPosition" ], "summary": "DocXmlPosition: GetPageDocXmlPositionsOpenOrPartially", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocXmlPosition-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocXmlPosition_GetPageDocXmlPositionsOpenOrPartially_426AA7C6BE5F", "parameters": [ { "name": "DocId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocXmlPosition/{DocId}/GetPageDocXmlPositionsTransferableToPurchase": { "get": { "tags": [ "DocXmlPosition" ], "summary": "DocXmlPosition: GetPageDocXmlPositionsTransferableToPurchase", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocXmlPosition-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocXmlPosition_GetPageDocXmlPositionsTransferableToPurchase_3B2DC2FB1622", "parameters": [ { "name": "DocId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocXmlPosition/{DocXmlId}/MatchCatalogAndSave": { "post": { "tags": [ "DocXmlPosition" ], "summary": "DocXmlPosition: MatchCatalogAndSave", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocXmlPosition-Create.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocXmlPosition_MatchCatalogAndSave_339661C9DDD1", "parameters": [ { "name": "DocXmlId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "CatalogConflictResolution", "in": "query", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXmlPositionSaveDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXmlPositionSaveDto" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXmlPositionSaveDto" } } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xPROC263_DocXml_Positions_SaveResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xPROC263_DocXml_Positions_SaveResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xPROC263_DocXml_Positions_SaveResult" } } } } } } }, "/api/DocXmlPosition/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "DocXmlPosition" ], "summary": "DocXmlPosition: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocXmlPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocXmlPosition_GetPageByValue_CCA67A76D074", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocXmlPosition/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "DocXmlPosition" ], "summary": "DocXmlPosition: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocXmlPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocXmlPosition_GetPageByValue2_EE592C27475A", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocXmlPosition/DeleteByFilter": { "post": { "tags": [ "DocXmlPosition" ], "summary": "DocXmlPosition: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocXmlPosition-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocXmlPosition_DeleteByFilter_773AE56C2328", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/DocXmlPosition/GetAllByValue": { "post": { "tags": [ "DocXmlPosition" ], "summary": "DocXmlPosition: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocXmlPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocXmlPosition_GetAllByValue_232A5CCC0386", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocXmlPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocXmlPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocXmlPosition" } } } } } } }, "/api/DocXmlPosition/GetAllGraphByValue": { "post": { "tags": [ "DocXmlPosition" ], "summary": "DocXmlPosition: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocXmlPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocXmlPosition_GetAllGraphByValue_D951CDCD4A7A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocXmlPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocXmlPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocXmlPosition" } } } } } } }, "/api/DocXmlPosition/GetByValue": { "post": { "tags": [ "DocXmlPosition" ], "summary": "DocXmlPosition: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocXmlPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocXmlPosition_GetByValue_0187EE2631A4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocXmlPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocXmlPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocXmlPosition" } } } } } } }, "/api/DocXmlPosition/GetDocXmlPositionWithQuantities": { "post": { "tags": [ "DocXmlPosition" ], "summary": "DocXmlPosition: GetDocXmlPositionWithQuantities", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocXmlPosition-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocXmlPosition_GetDocXmlPositionWithQuantities_841CCAD33E1B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXmlPosition_GetWithQuantitiesRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXmlPosition_GetWithQuantitiesRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXmlPosition_GetWithQuantitiesRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW265_DocXmlPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW265_DocXmlPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW265_DocXmlPosition" } } } } } } }, "/api/DocXmlPosition/GetLookup": { "post": { "tags": [ "DocXmlPosition" ], "summary": "DocXmlPosition: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocXmlPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocXmlPosition_GetLookup_68DE91E73BA8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/DocXmlPosition/GetLookupByValue": { "post": { "tags": [ "DocXmlPosition" ], "summary": "DocXmlPosition: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocXmlPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocXmlPosition_GetLookupByValue_B0EEFF5783B1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/DocXmlPosition/Page": { "get": { "tags": [ "DocXmlPosition" ], "summary": "DocXmlPosition: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocXmlPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocXmlPosition_GetPage_24A7BDDC82F7", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocXmlPosition/PageAsc": { "get": { "tags": [ "DocXmlPosition" ], "summary": "DocXmlPosition: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocXmlPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocXmlPosition_GetPageAsc_8D819439F563", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocXmlPosition/SearchByValue": { "post": { "tags": [ "DocXmlPosition" ], "summary": "DocXmlPosition: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocXmlPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocXmlPosition_SearchByValue_131163FF46DC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocXmlPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocXmlPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocXmlPosition" } } } } } } }, "/api/DocXmlPosition/Sproc_FinanceGroupArticleId": { "post": { "tags": [ "DocXmlPosition" ], "summary": "DocXmlPosition: Sproc_FinanceGroupArticleId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocXmlPosition-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocXmlPosition_Sproc_FinanceGroupArticleId_5981717A0489", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXmlPosition_SprocFinanceGroupArticleIdRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXmlPosition_SprocFinanceGroupArticleIdRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXmlPosition_SprocFinanceGroupArticleIdRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceGroupArticleIdResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceGroupArticleIdResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceGroupArticleIdResult" } } } } } } }, "/api/DocXmlPosition/Sproc_InsertText": { "post": { "tags": [ "DocXmlPosition" ], "summary": "DocXmlPosition: Sproc_InsertText", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocXmlPosition-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocXmlPosition_Sproc_InsertText_356D51BBBFBB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXmlPosition_SprocInsertTextRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXmlPosition_SprocInsertTextRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXmlPosition_SprocInsertTextRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.InsertTextResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.InsertTextResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.InsertTextResult" } } } } } } }, "/api/DocXmlPosition/Sproc_PositionTypeId": { "post": { "tags": [ "DocXmlPosition" ], "summary": "DocXmlPosition: Sproc_PositionTypeId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocXmlPosition-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocXmlPosition_Sproc_PositionTypeId_F1D47513457C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXmlPosition_SprocPositionTypeIdRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXmlPosition_SprocPositionTypeIdRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXmlPosition_SprocPositionTypeIdRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PositionTypeIdResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PositionTypeIdResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PositionTypeIdResult" } } } } } } }, "/api/DocXmlPosition/Sproc_SalesPersonId": { "post": { "tags": [ "DocXmlPosition" ], "summary": "DocXmlPosition: Sproc_SalesPersonId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocXmlPosition-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocXmlPosition_Sproc_SalesPersonId_8D319BE01CD2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXmlPosition_SprocSalesPersonIdRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXmlPosition_SprocSalesPersonIdRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXmlPosition_SprocSalesPersonIdRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SalesPersonIdResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SalesPersonIdResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SalesPersonIdResult" } } } } } } }, "/api/DocXmlPosition/Sproc_StatusId": { "post": { "tags": [ "DocXmlPosition" ], "summary": "DocXmlPosition: Sproc_StatusId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocXmlPosition-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocXmlPosition_Sproc_StatusId_0295A507C661", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXmlPosition_SprocStatusIdRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXmlPosition_SprocStatusIdRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXmlPosition_SprocStatusIdRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.StatusIdResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.StatusIdResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.StatusIdResult" } } } } } } }, "/api/DocXmlPosition/Sproc_TaxKeyId": { "post": { "tags": [ "DocXmlPosition" ], "summary": "DocXmlPosition: Sproc_TaxKeyId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocXmlPosition-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocXmlPosition_Sproc_TaxKeyId_5B2FEDC8E303", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXmlPosition_SprocTaxKeyIdRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXmlPosition_SprocTaxKeyIdRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXmlPosition_SprocTaxKeyIdRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TaxKeyIdResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TaxKeyIdResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TaxKeyIdResult" } } } } } } }, "/api/DocXmlPosition/Sproc_UpdateTransfer": { "post": { "tags": [ "DocXmlPosition" ], "summary": "DocXmlPosition: Sproc_UpdateTransfer", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocXmlPosition-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocXmlPosition_Sproc_UpdateTransfer_93153CF681FE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXmlPosition_SprocUpdateTransferRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXmlPosition_SprocUpdateTransferRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXmlPosition_SprocUpdateTransferRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/DocXmlPosition/TryGetByValue": { "post": { "tags": [ "DocXmlPosition" ], "summary": "DocXmlPosition: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocXmlPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocXmlPosition_TryGetByValue_09AE638BBF90", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocXmlPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocXmlPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocXmlPosition" } } } } } } }, "/api/DocXmlPosition/UpsertGraph": { "put": { "tags": [ "DocXmlPosition" ], "summary": "DocXmlPosition: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocXmlPosition-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocXmlPosition_UpsertGraph_107CFBEEA87A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXmlPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXmlPosition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXmlPosition" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocXmlPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocXmlPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocXmlPosition" } } } } } } }, "/api/DocXmlPosition/UpsertGraphWithExtraFields": { "put": { "tags": [ "DocXmlPosition" ], "summary": "DocXmlPosition: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DocXmlPosition-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DocXmlPosition_UpsertGraphWithExtraFields_11149072194B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocXmlPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocXmlPosition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocXmlPosition" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocXmlPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocXmlPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocXmlPosition" } } } } } } }, "/api/Email": { "get": { "tags": [ "Email" ], "summary": "Email: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Email-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Email_GetAll_04B37751B832", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Email" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Email" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Email" } } } } } }, "post": { "tags": [ "Email" ], "summary": "Email: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Email-Create.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Email_Post_0405966552E3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Email" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Email" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Email" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Email" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Email" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Email" } } } } } }, "put": { "tags": [ "Email" ], "summary": "Email: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Email-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Email_Put_4AA5D26798E1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Email" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Email" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Email" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Email" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Email" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Email" } } } } } } }, "/api/Email/{EmailId}/BodyImage/{ImageIndex}": { "get": { "tags": [ "Email" ], "summary": "Email: GetBodyImage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Email-Read.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Email_GetBodyImage_8D49E4942E8A", "parameters": [ { "name": "EmailId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "ImageIndex", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Email/{EmailId}/CreateAnswerEmail": { "get": { "tags": [ "Email" ], "summary": "Email: CreateAnswerEmail", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Email-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Email_CreateAnswerEmail_DA1AF5A220A2", "parameters": [ { "name": "EmailId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "language", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/Email/{EmailId}/CreateForwardEmail": { "get": { "tags": [ "Email" ], "summary": "Email: CreateForwardEmail", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Email-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Email_CreateForwardEmail_3EB217240AD7", "parameters": [ { "name": "EmailId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "language", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/Email/{EmailId}/GetBody": { "get": { "tags": [ "Email" ], "summary": "Email: GetBody", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Email-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Email_GetBody_FA7B2646B02C", "parameters": [ { "name": "EmailId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dto.EmailBodyDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dto.EmailBodyDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dto.EmailBodyDto" } } } } } } }, "/api/Email/{EmailId}/GetCalendarInviteStatus": { "get": { "tags": [ "Email" ], "summary": "Email: GetCalendarInviteStatus", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Email-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Email_GetCalendarInviteStatus_C86983C9B49B", "parameters": [ { "name": "EmailId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dto.EmailCalendarInviteStatusDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dto.EmailCalendarInviteStatusDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dto.EmailCalendarInviteStatusDto" } } } } } } }, "/api/Email/{EmailId}/GetEmailWithoutBody": { "get": { "tags": [ "Email" ], "summary": "Email: GetEmailWithoutBody", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Email-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Email_GetEmailWithoutBody_8DBFBA159B3E", "parameters": [ { "name": "EmailId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Email" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Email" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Email" } } } } } } }, "/api/Email/{EmailId}/MarkAsSeen": { "get": { "tags": [ "Email" ], "summary": "Email: MarkAsSeen", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Email-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Email_MarkAsSeen_843ABFE0DCC5", "parameters": [ { "name": "EmailId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/Email/{EmailId}/ProcessCalendarInvite": { "post": { "tags": [ "Email" ], "summary": "Email: ProcessCalendarInvite", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Email-Create.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Email_ProcessCalendarInvite_D0C00D037BF0", "parameters": [ { "name": "EmailId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dto.EmailCalendarInviteStatusDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dto.EmailCalendarInviteStatusDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dto.EmailCalendarInviteStatusDto" } } } } } } }, "/api/Email/{EmailId}/RespondToCalendarInvite/{response}": { "post": { "tags": [ "Email" ], "summary": "Email: RespondToCalendarInvite", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Email-Create.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Email_RespondToCalendarInvite_2051E09CC743", "parameters": [ { "name": "EmailId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "response", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dto.EmailCalendarInviteStatusDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dto.EmailCalendarInviteStatusDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dto.EmailCalendarInviteStatusDto" } } } } } } }, "/api/Email/{EmailId}/Send": { "get": { "tags": [ "Email" ], "summary": "Email: Send", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Email-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Email_Send_BE8C7CBC98BF", "parameters": [ { "name": "EmailId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/Email/{FolderId}/{IncludeSubFolders}/PageFromViewByFolder": { "get": { "tags": [ "Email" ], "summary": "Email: GetPageFromViewByFolder", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Email-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Email_GetPageFromViewByFolder_F93608247DA1", "parameters": [ { "name": "FolderId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "IncludeSubFolders", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "bodySearchText", "in": "query", "schema": { "type": "string" } }, { "name": "searchFolderIdsCsv", "in": "query", "schema": { "type": "string" } }, { "name": "unseenOnly", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Email/{NewFolder}/ChangeFolder": { "post": { "tags": [ "Email" ], "summary": "Email: ChangeFolder", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Email-Create.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Email_ChangeFolder_2F3F1B93248E", "parameters": [ { "name": "NewFolder", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/X_ERP_Common.EmailFolderIds" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/Email/{NewFolderId}/ChangeFolderById": { "post": { "tags": [ "Email" ], "summary": "Email: ChangeFolderById", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Email-Create.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Email_ChangeFolderById_4B0AFF7BFC67", "parameters": [ { "name": "NewFolderId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/Email/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "Email" ], "summary": "Email: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Email-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Email_GetPageByValue_6D0286BE3981", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Email/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "Email" ], "summary": "Email: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Email-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Email_GetPageByValue2_E52772A6533B", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Email/{searchText}/PageFromViewByBodySearch": { "get": { "tags": [ "Email" ], "summary": "Email: GetPageFromViewByBodySearch", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Email-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Email_GetPageFromViewByBodySearch_81A4B197565F", "parameters": [ { "name": "searchText", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Email/DeleteByFilter": { "post": { "tags": [ "Email" ], "summary": "Email: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Email-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Email_DeleteByFilter_99AFB280DB37", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/Email/GetAllByValue": { "post": { "tags": [ "Email" ], "summary": "Email: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Email-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Email_GetAllByValue_EE419B83541C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Email" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Email" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Email" } } } } } } }, "/api/Email/GetAllGraphByValue": { "post": { "tags": [ "Email" ], "summary": "Email: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Email-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Email_GetAllGraphByValue_55A73326C780", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Email" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Email" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Email" } } } } } } }, "/api/Email/GetByValue": { "post": { "tags": [ "Email" ], "summary": "Email: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Email-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Email_GetByValue_10B67646C34B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Email" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Email" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Email" } } } } } } }, "/api/Email/GetLookup": { "post": { "tags": [ "Email" ], "summary": "Email: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Email-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Email_GetLookup_5D82B8411B04", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/Email/GetLookupByValue": { "post": { "tags": [ "Email" ], "summary": "Email: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Email-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Email_GetLookupByValue_BFC7D0F1B05E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/Email/OutboxCount": { "get": { "tags": [ "Email" ], "summary": "Email: GetOutboxCount", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Email-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Email_GetOutboxCount_4378B5699900", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/Email/Page": { "get": { "tags": [ "Email" ], "summary": "Email: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Email-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Email_GetPage_5498DD5D8A4D", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Email/PageAsc": { "get": { "tags": [ "Email" ], "summary": "Email: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Email-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Email_GetPageAsc_945F905FCDE4", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Email/PageFromViewByPartnerEmail": { "get": { "tags": [ "Email" ], "summary": "Email: GetPageFromViewByPartnerEmail", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Email-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Email_GetPageFromViewByPartnerEmail_12E2B7FEE279", "parameters": [ { "name": "partnerEmails", "in": "query", "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Email/SearchByValue": { "post": { "tags": [ "Email" ], "summary": "Email: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Email-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Email_SearchByValue_5DDCA800F6A5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.Email" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.Email" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.Email" } } } } } } }, "/api/Email/SendErrorEmail": { "post": { "tags": [ "Email" ], "summary": "Email: SendErrorEmail", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Email-Create.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Email_SendErrorEmail_363C1EB44224", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ClientExceptionDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ClientExceptionDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ClientExceptionDto" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Email" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Email" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Email" } } } } } } }, "/api/Email/SendServerInternalErrorEmail": { "post": { "tags": [ "Email" ], "summary": "Email: SendServerInternalErrorEmail", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Email-Create.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Email_SendServerInternalErrorEmail_DD06D3DABA6F", "requestBody": { "content": { "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } }, "application/*+json": { "schema": { "type": "string" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Email" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Email" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Email" } } } } } } }, "/api/Email/Synchronize": { "get": { "tags": [ "Email" ], "summary": "Email: Synchronize", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Email-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Email_Synchronize_E8746F216273", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/Email/TryGetByValue": { "post": { "tags": [ "Email" ], "summary": "Email: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Email-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Email_TryGetByValue_9C41C996DCE4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Email" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Email" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Email" } } } } } } }, "/api/Email/UnseenCount": { "get": { "tags": [ "Email" ], "summary": "Email: GetUnseenCount", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Email-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Email_GetUnseenCount_85AF5BC402CB", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/Email/UpdateMailBody": { "put": { "tags": [ "Email" ], "summary": "Email: UpdateMailBody", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Email-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Email_UpdateMailBody_2BF4291F41DD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Dto.EmailBodyUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Dto.EmailBodyUpdateDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Dto.EmailBodyUpdateDto" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dto.EmailBodyDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dto.EmailBodyDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dto.EmailBodyDto" } } } } } } }, "/api/Email/UpdateWithOptionalBody": { "put": { "tags": [ "Email" ], "summary": "Email: UpdateWithOptionalBody", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Email-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Email_UpdateWithOptionalBody_65D06F5D7486", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Dto.EmailUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Dto.EmailUpdateDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Dto.EmailUpdateDto" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Email" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Email" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Email" } } } } } } }, "/api/Email/UploadChunkFile/{EmailId}": { "post": { "tags": [ "Email" ], "summary": "Email: UploadChunkFile", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Email-Create.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Email_UploadChunkFile_003AFF19B770", "parameters": [ { "name": "EmailId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "fileChunk": { "type": "string", "format": "binary" } } }, "encoding": { "fileChunk": { "style": "form" } } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/Email/UpsertGraph": { "put": { "tags": [ "Email" ], "summary": "Email: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Email-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Email_UpsertGraph_6B57974A1BF1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Email" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Email" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Email" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Email" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Email" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Email" } } } } } } }, "/api/Email/UpsertGraphWithExtraFields": { "put": { "tags": [ "Email" ], "summary": "Email: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Email-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Email_UpsertGraphWithExtraFields_5CF9CC85F08F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Email" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Email" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Email" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Email" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Email" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Email" } } } } } } }, "/api/EmailAccount": { "get": { "tags": [ "EmailAccount" ], "summary": "EmailAccount: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailAccount-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailAccount_GetAll_B7C2AE294566", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailAccount" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailAccount" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailAccount" } } } } } }, "post": { "tags": [ "EmailAccount" ], "summary": "EmailAccount: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailAccount-Create.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailAccount_Post_66E2DA5F9C75", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailAccount" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailAccount" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailAccount" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailAccount" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailAccount" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailAccount" } } } } } }, "put": { "tags": [ "EmailAccount" ], "summary": "EmailAccount: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailAccount-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailAccount_Put_E01077C7F27D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailAccount" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailAccount" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailAccount" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailAccount" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailAccount" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailAccount" } } } } } } }, "/api/EmailAccount/{EmailAccountId}/TestPop3": { "get": { "tags": [ "EmailAccount" ], "summary": "EmailAccount: TestPop3", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailAccount-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailAccount_TestPop3_7A8D19FF17DA", "parameters": [ { "name": "EmailAccountId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dto.EmailAccountTestResultDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dto.EmailAccountTestResultDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dto.EmailAccountTestResultDto" } } } } } } }, "/api/EmailAccount/{EmailAccountId}/TestSmtp": { "get": { "tags": [ "EmailAccount" ], "summary": "EmailAccount: TestSmtp", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailAccount-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailAccount_TestSmtp_B26D164CA5AD", "parameters": [ { "name": "EmailAccountId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dto.EmailAccountTestResultDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dto.EmailAccountTestResultDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dto.EmailAccountTestResultDto" } } } } } } }, "/api/EmailAccount/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "EmailAccount" ], "summary": "EmailAccount: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailAccount-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailAccount_GetPageByValue_E033314071B9", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmailAccount/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "EmailAccount" ], "summary": "EmailAccount: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailAccount-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailAccount_GetPageByValue2_0157AD4216D7", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmailAccount/DeleteByFilter": { "post": { "tags": [ "EmailAccount" ], "summary": "EmailAccount: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailAccount-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailAccount_DeleteByFilter_B237F4EAA948", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/EmailAccount/GetAllByValue": { "post": { "tags": [ "EmailAccount" ], "summary": "EmailAccount: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailAccount-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailAccount_GetAllByValue_9CC3EE51F7C5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailAccount" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailAccount" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailAccount" } } } } } } }, "/api/EmailAccount/GetAllGraphByValue": { "post": { "tags": [ "EmailAccount" ], "summary": "EmailAccount: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailAccount-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailAccount_GetAllGraphByValue_BE2491399578", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailAccount" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailAccount" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailAccount" } } } } } } }, "/api/EmailAccount/GetByValue": { "post": { "tags": [ "EmailAccount" ], "summary": "EmailAccount: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailAccount-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailAccount_GetByValue_6B3B5ED5BA56", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailAccount" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailAccount" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailAccount" } } } } } } }, "/api/EmailAccount/GetLookup": { "post": { "tags": [ "EmailAccount" ], "summary": "EmailAccount: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailAccount-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailAccount_GetLookup_3A0F63557DA3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/EmailAccount/GetLookupByValue": { "post": { "tags": [ "EmailAccount" ], "summary": "EmailAccount: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailAccount-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailAccount_GetLookupByValue_0697EA7355D8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/EmailAccount/Page": { "get": { "tags": [ "EmailAccount" ], "summary": "EmailAccount: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailAccount-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailAccount_GetPage_8FF0EAE0B52B", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmailAccount/PageAsc": { "get": { "tags": [ "EmailAccount" ], "summary": "EmailAccount: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailAccount-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailAccount_GetPageAsc_45463FC0341B", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmailAccount/SearchByValue": { "post": { "tags": [ "EmailAccount" ], "summary": "EmailAccount: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailAccount-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailAccount_SearchByValue_FCF6F1FC0308", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmailAccount" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmailAccount" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmailAccount" } } } } } } }, "/api/EmailAccount/TryGetByValue": { "post": { "tags": [ "EmailAccount" ], "summary": "EmailAccount: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailAccount-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailAccount_TryGetByValue_58377A76CBDB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailAccount" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailAccount" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailAccount" } } } } } } }, "/api/EmailAccount/UpsertGraph": { "put": { "tags": [ "EmailAccount" ], "summary": "EmailAccount: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailAccount-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailAccount_UpsertGraph_2F04C75FCE46", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailAccount" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailAccount" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailAccount" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailAccount" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailAccount" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailAccount" } } } } } } }, "/api/EmailAccount/UpsertGraphWithExtraFields": { "put": { "tags": [ "EmailAccount" ], "summary": "EmailAccount: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailAccount-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailAccount_UpsertGraphWithExtraFields_F70665E49184", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailAccount" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailAccount" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailAccount" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailAccount" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailAccount" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailAccount" } } } } } } }, "/api/EmailAttachment": { "get": { "tags": [ "EmailAttachment" ], "summary": "EmailAttachment: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailAttachment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailAttachment_GetAll_AF37FA86E29B", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailAttachment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailAttachment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailAttachment" } } } } } }, "post": { "tags": [ "EmailAttachment" ], "summary": "EmailAttachment: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailAttachment-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailAttachment_Post_E21FEA49CAFB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailAttachment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailAttachment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailAttachment" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailAttachment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailAttachment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailAttachment" } } } } } }, "put": { "tags": [ "EmailAttachment" ], "summary": "EmailAttachment: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailAttachment-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailAttachment_Put_22DE2FB073CC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailAttachment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailAttachment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailAttachment" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailAttachment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailAttachment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailAttachment" } } } } } } }, "/api/EmailAttachment/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "EmailAttachment" ], "summary": "EmailAttachment: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailAttachment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailAttachment_GetPageByValue_3023C6E6C71D", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmailAttachment/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "EmailAttachment" ], "summary": "EmailAttachment: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailAttachment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailAttachment_GetPageByValue2_CF6CD9C598F7", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmailAttachment/DeleteByFilter": { "post": { "tags": [ "EmailAttachment" ], "summary": "EmailAttachment: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailAttachment-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailAttachment_DeleteByFilter_1AC29F7FBE87", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/EmailAttachment/DownloadEmailAttachment/{EmailAttachmentId}": { "get": { "tags": [ "EmailAttachment" ], "summary": "EmailAttachment: DownloadEmailAttachment", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailAttachment-Read.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailAttachment_DownloadEmailAttachment_2F45A4AD8016", "parameters": [ { "name": "EmailAttachmentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmailAttachment/GetAllByValue": { "post": { "tags": [ "EmailAttachment" ], "summary": "EmailAttachment: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailAttachment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailAttachment_GetAllByValue_76E7AF63A48D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailAttachment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailAttachment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailAttachment" } } } } } } }, "/api/EmailAttachment/GetAllGraphByValue": { "post": { "tags": [ "EmailAttachment" ], "summary": "EmailAttachment: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailAttachment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailAttachment_GetAllGraphByValue_8EF00300A8EB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailAttachment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailAttachment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailAttachment" } } } } } } }, "/api/EmailAttachment/GetByValue": { "post": { "tags": [ "EmailAttachment" ], "summary": "EmailAttachment: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailAttachment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailAttachment_GetByValue_475B3A01FF64", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailAttachment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailAttachment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailAttachment" } } } } } } }, "/api/EmailAttachment/GetLookup": { "post": { "tags": [ "EmailAttachment" ], "summary": "EmailAttachment: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailAttachment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailAttachment_GetLookup_FE0266FF81F0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/EmailAttachment/GetLookupByValue": { "post": { "tags": [ "EmailAttachment" ], "summary": "EmailAttachment: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailAttachment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailAttachment_GetLookupByValue_3B46A9EBB707", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/EmailAttachment/Page": { "get": { "tags": [ "EmailAttachment" ], "summary": "EmailAttachment: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailAttachment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailAttachment_GetPage_D336F8E3385B", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmailAttachment/PageAsc": { "get": { "tags": [ "EmailAttachment" ], "summary": "EmailAttachment: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailAttachment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailAttachment_GetPageAsc_341A9DFFE333", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmailAttachment/SearchByValue": { "post": { "tags": [ "EmailAttachment" ], "summary": "EmailAttachment: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailAttachment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailAttachment_SearchByValue_213DB845FB70", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmailAttachment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmailAttachment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmailAttachment" } } } } } } }, "/api/EmailAttachment/TryGetByValue": { "post": { "tags": [ "EmailAttachment" ], "summary": "EmailAttachment: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailAttachment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailAttachment_TryGetByValue_37A8159D76DD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailAttachment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailAttachment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailAttachment" } } } } } } }, "/api/EmailAttachment/UpsertGraph": { "put": { "tags": [ "EmailAttachment" ], "summary": "EmailAttachment: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailAttachment-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailAttachment_UpsertGraph_D030769033D5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailAttachment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailAttachment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailAttachment" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailAttachment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailAttachment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailAttachment" } } } } } } }, "/api/EmailAttachment/UpsertGraphWithExtraFields": { "put": { "tags": [ "EmailAttachment" ], "summary": "EmailAttachment: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailAttachment-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailAttachment_UpsertGraphWithExtraFields_4370F06A1CA8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailAttachment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailAttachment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailAttachment" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailAttachment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailAttachment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailAttachment" } } } } } } }, "/api/EmailFolder": { "get": { "tags": [ "EmailFolder" ], "summary": "EmailFolder: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailFolder-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailFolder_GetAll_E970ECB05EDF", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailFolder" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailFolder" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailFolder" } } } } } }, "post": { "tags": [ "EmailFolder" ], "summary": "EmailFolder: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailFolder-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailFolder_Post_B195B891713B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailFolder" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailFolder" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailFolder" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailFolder" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailFolder" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailFolder" } } } } } }, "put": { "tags": [ "EmailFolder" ], "summary": "EmailFolder: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailFolder-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailFolder_Put_20304274870F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailFolder" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailFolder" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailFolder" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailFolder" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailFolder" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailFolder" } } } } } } }, "/api/EmailFolder/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "EmailFolder" ], "summary": "EmailFolder: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailFolder-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailFolder_GetPageByValue_2EA48B5D1DD4", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmailFolder/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "EmailFolder" ], "summary": "EmailFolder: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailFolder-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailFolder_GetPageByValue2_4D9684B05AD7", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmailFolder/DeleteByFilter": { "post": { "tags": [ "EmailFolder" ], "summary": "EmailFolder: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailFolder-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailFolder_DeleteByFilter_80B00FB60831", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/EmailFolder/GetAllByValue": { "post": { "tags": [ "EmailFolder" ], "summary": "EmailFolder: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailFolder-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailFolder_GetAllByValue_7194DF1FAF84", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailFolder" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailFolder" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailFolder" } } } } } } }, "/api/EmailFolder/GetAllGraphByValue": { "post": { "tags": [ "EmailFolder" ], "summary": "EmailFolder: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailFolder-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailFolder_GetAllGraphByValue_DB03A9D3BFFE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailFolder" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailFolder" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailFolder" } } } } } } }, "/api/EmailFolder/GetByValue": { "post": { "tags": [ "EmailFolder" ], "summary": "EmailFolder: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailFolder-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailFolder_GetByValue_3A19B77DEA95", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailFolder" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailFolder" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailFolder" } } } } } } }, "/api/EmailFolder/GetEmailFoldersWithCount": { "get": { "tags": [ "EmailFolder" ], "summary": "EmailFolder: GetEmailFoldersWithCount", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailFolder-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailFolder_GetEmailFoldersWithCount_03758D1C99AD", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailFolderCountDto" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailFolderCountDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailFolderCountDto" } } } } } } } }, "/api/EmailFolder/GetLookup": { "post": { "tags": [ "EmailFolder" ], "summary": "EmailFolder: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailFolder-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailFolder_GetLookup_F0415187A6E1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/EmailFolder/GetLookupByValue": { "post": { "tags": [ "EmailFolder" ], "summary": "EmailFolder: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailFolder-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailFolder_GetLookupByValue_D6A87F4238CE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/EmailFolder/Page": { "get": { "tags": [ "EmailFolder" ], "summary": "EmailFolder: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailFolder-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailFolder_GetPage_1627D8B7F045", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmailFolder/PageAsc": { "get": { "tags": [ "EmailFolder" ], "summary": "EmailFolder: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailFolder-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailFolder_GetPageAsc_901019DB0840", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmailFolder/SearchByValue": { "post": { "tags": [ "EmailFolder" ], "summary": "EmailFolder: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailFolder-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailFolder_SearchByValue_FF4DAEF7F01E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmailFolder" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmailFolder" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmailFolder" } } } } } } }, "/api/EmailFolder/TryGetByValue": { "post": { "tags": [ "EmailFolder" ], "summary": "EmailFolder: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailFolder-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailFolder_TryGetByValue_CB961A240EB8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailFolder" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailFolder" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailFolder" } } } } } } }, "/api/EmailFolder/UpsertGraph": { "put": { "tags": [ "EmailFolder" ], "summary": "EmailFolder: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailFolder-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailFolder_UpsertGraph_7681EBF978E0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailFolder" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailFolder" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailFolder" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailFolder" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailFolder" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailFolder" } } } } } } }, "/api/EmailFolder/UpsertGraphWithExtraFields": { "put": { "tags": [ "EmailFolder" ], "summary": "EmailFolder: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailFolder-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailFolder_UpsertGraphWithExtraFields_113D1DD09791", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailFolder" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailFolder" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailFolder" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailFolder" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailFolder" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailFolder" } } } } } } }, "/api/EmailLog": { "get": { "tags": [ "EmailLog" ], "summary": "EmailLog: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailLog-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailLog_GetAll_367527474E33", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailLog" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailLog" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailLog" } } } } } }, "post": { "tags": [ "EmailLog" ], "summary": "EmailLog: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailLog-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailLog_Post_CDD2D967C870", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailLog" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailLog" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailLog" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailLog" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailLog" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailLog" } } } } } }, "put": { "tags": [ "EmailLog" ], "summary": "EmailLog: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailLog-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailLog_Put_C757271FB614", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailLog" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailLog" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailLog" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailLog" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailLog" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailLog" } } } } } } }, "/api/EmailLog/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "EmailLog" ], "summary": "EmailLog: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailLog-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailLog_GetPageByValue_5AC39B6A3FCC", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmailLog/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "EmailLog" ], "summary": "EmailLog: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailLog-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailLog_GetPageByValue2_5454D8C9D48F", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmailLog/DeleteByFilter": { "post": { "tags": [ "EmailLog" ], "summary": "EmailLog: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailLog-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailLog_DeleteByFilter_4C8ECBFE5D71", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/EmailLog/GetAllByValue": { "post": { "tags": [ "EmailLog" ], "summary": "EmailLog: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailLog-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailLog_GetAllByValue_3CD475F0C1C2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailLog" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailLog" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailLog" } } } } } } }, "/api/EmailLog/GetAllGraphByValue": { "post": { "tags": [ "EmailLog" ], "summary": "EmailLog: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailLog-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailLog_GetAllGraphByValue_FCFC86CED0E1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailLog" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailLog" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailLog" } } } } } } }, "/api/EmailLog/GetByValue": { "post": { "tags": [ "EmailLog" ], "summary": "EmailLog: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailLog-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailLog_GetByValue_D376417D7E9F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailLog" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailLog" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailLog" } } } } } } }, "/api/EmailLog/GetLookup": { "post": { "tags": [ "EmailLog" ], "summary": "EmailLog: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailLog-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailLog_GetLookup_C60E0C452FC6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/EmailLog/GetLookupByValue": { "post": { "tags": [ "EmailLog" ], "summary": "EmailLog: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailLog-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailLog_GetLookupByValue_7A925052A2A2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/EmailLog/Page": { "get": { "tags": [ "EmailLog" ], "summary": "EmailLog: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailLog-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailLog_GetPage_FC5B23145F0E", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmailLog/PageAsc": { "get": { "tags": [ "EmailLog" ], "summary": "EmailLog: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailLog-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailLog_GetPageAsc_B3A47A9F81AE", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmailLog/SearchByValue": { "post": { "tags": [ "EmailLog" ], "summary": "EmailLog: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailLog-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailLog_SearchByValue_30CF2E4DDB01", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmailLog" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmailLog" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmailLog" } } } } } } }, "/api/EmailLog/TryGetByValue": { "post": { "tags": [ "EmailLog" ], "summary": "EmailLog: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailLog-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailLog_TryGetByValue_A8EA3D489D2E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailLog" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailLog" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailLog" } } } } } } }, "/api/EmailLog/UpsertGraph": { "put": { "tags": [ "EmailLog" ], "summary": "EmailLog: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailLog-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailLog_UpsertGraph_823D7B6DB605", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailLog" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailLog" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailLog" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailLog" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailLog" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailLog" } } } } } } }, "/api/EmailLog/UpsertGraphWithExtraFields": { "put": { "tags": [ "EmailLog" ], "summary": "EmailLog: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailLog-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailLog_UpsertGraphWithExtraFields_B5DE41DCEDBE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailLog" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailLog" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailLog" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailLog" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailLog" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailLog" } } } } } } }, "/api/EmailRuleField": { "get": { "tags": [ "EmailRuleField" ], "summary": "EmailRuleField: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailRuleField-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailRuleField_GetAll_7BD837EC9E23", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailRuleField" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailRuleField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailRuleField" } } } } } }, "post": { "tags": [ "EmailRuleField" ], "summary": "EmailRuleField: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailRuleField-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailRuleField_Post_C42B32E5FC51", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailRuleField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailRuleField" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailRuleField" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailRuleField" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailRuleField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailRuleField" } } } } } }, "put": { "tags": [ "EmailRuleField" ], "summary": "EmailRuleField: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailRuleField-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailRuleField_Put_2869E47CB31B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailRuleField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailRuleField" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailRuleField" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailRuleField" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailRuleField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailRuleField" } } } } } } }, "/api/EmailRuleField/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "EmailRuleField" ], "summary": "EmailRuleField: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailRuleField-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailRuleField_GetPageByValue_24FF45B68309", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmailRuleField/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "EmailRuleField" ], "summary": "EmailRuleField: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailRuleField-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailRuleField_GetPageByValue2_6A917F642CC7", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmailRuleField/DeleteByFilter": { "post": { "tags": [ "EmailRuleField" ], "summary": "EmailRuleField: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailRuleField-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailRuleField_DeleteByFilter_93BC81D2AE4E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/EmailRuleField/GetAllByValue": { "post": { "tags": [ "EmailRuleField" ], "summary": "EmailRuleField: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailRuleField-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailRuleField_GetAllByValue_0943D7079649", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailRuleField" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailRuleField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailRuleField" } } } } } } }, "/api/EmailRuleField/GetAllGraphByValue": { "post": { "tags": [ "EmailRuleField" ], "summary": "EmailRuleField: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailRuleField-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailRuleField_GetAllGraphByValue_8DC3B80DBB33", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailRuleField" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailRuleField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailRuleField" } } } } } } }, "/api/EmailRuleField/GetByValue": { "post": { "tags": [ "EmailRuleField" ], "summary": "EmailRuleField: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailRuleField-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailRuleField_GetByValue_288A15854B95", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailRuleField" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailRuleField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailRuleField" } } } } } } }, "/api/EmailRuleField/GetLookup": { "post": { "tags": [ "EmailRuleField" ], "summary": "EmailRuleField: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailRuleField-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailRuleField_GetLookup_CE91F76BEEFD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/EmailRuleField/GetLookupByValue": { "post": { "tags": [ "EmailRuleField" ], "summary": "EmailRuleField: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailRuleField-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailRuleField_GetLookupByValue_CB02DF9026ED", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/EmailRuleField/Page": { "get": { "tags": [ "EmailRuleField" ], "summary": "EmailRuleField: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailRuleField-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailRuleField_GetPage_D50C93D0ADED", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmailRuleField/PageAsc": { "get": { "tags": [ "EmailRuleField" ], "summary": "EmailRuleField: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailRuleField-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailRuleField_GetPageAsc_03007522164E", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmailRuleField/SearchByValue": { "post": { "tags": [ "EmailRuleField" ], "summary": "EmailRuleField: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailRuleField-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailRuleField_SearchByValue_7BB40D1E5564", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmailRuleField" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmailRuleField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmailRuleField" } } } } } } }, "/api/EmailRuleField/TryGetByValue": { "post": { "tags": [ "EmailRuleField" ], "summary": "EmailRuleField: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailRuleField-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailRuleField_TryGetByValue_DE6736633412", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailRuleField" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailRuleField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailRuleField" } } } } } } }, "/api/EmailRuleField/UpsertGraph": { "put": { "tags": [ "EmailRuleField" ], "summary": "EmailRuleField: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailRuleField-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailRuleField_UpsertGraph_4A39EE87E272", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailRuleField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailRuleField" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailRuleField" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailRuleField" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailRuleField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailRuleField" } } } } } } }, "/api/EmailRuleField/UpsertGraphWithExtraFields": { "put": { "tags": [ "EmailRuleField" ], "summary": "EmailRuleField: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailRuleField-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailRuleField_UpsertGraphWithExtraFields_BE9E11EFCD38", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailRuleField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailRuleField" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailRuleField" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailRuleField" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailRuleField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailRuleField" } } } } } } }, "/api/EmailRuleIn": { "get": { "tags": [ "EmailRuleIn" ], "summary": "EmailRuleIn: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailRuleIn-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailRuleIn_GetAll_39429BB03261", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailRuleIn" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailRuleIn" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailRuleIn" } } } } } }, "post": { "tags": [ "EmailRuleIn" ], "summary": "EmailRuleIn: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailRuleIn-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailRuleIn_Post_7243FF826E2A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailRuleIn" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailRuleIn" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailRuleIn" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailRuleIn" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailRuleIn" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailRuleIn" } } } } } }, "put": { "tags": [ "EmailRuleIn" ], "summary": "EmailRuleIn: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailRuleIn-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailRuleIn_Put_F6869D9C566B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailRuleIn" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailRuleIn" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailRuleIn" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailRuleIn" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailRuleIn" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailRuleIn" } } } } } } }, "/api/EmailRuleIn/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "EmailRuleIn" ], "summary": "EmailRuleIn: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailRuleIn-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailRuleIn_GetPageByValue_0BA15F17B690", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmailRuleIn/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "EmailRuleIn" ], "summary": "EmailRuleIn: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailRuleIn-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailRuleIn_GetPageByValue2_D917B277F9C8", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmailRuleIn/DeleteByFilter": { "post": { "tags": [ "EmailRuleIn" ], "summary": "EmailRuleIn: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailRuleIn-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailRuleIn_DeleteByFilter_34F7EA8B7176", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/EmailRuleIn/GetAllByValue": { "post": { "tags": [ "EmailRuleIn" ], "summary": "EmailRuleIn: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailRuleIn-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailRuleIn_GetAllByValue_B94D753E2394", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailRuleIn" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailRuleIn" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailRuleIn" } } } } } } }, "/api/EmailRuleIn/GetAllGraphByValue": { "post": { "tags": [ "EmailRuleIn" ], "summary": "EmailRuleIn: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailRuleIn-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailRuleIn_GetAllGraphByValue_223F9EC58BE9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailRuleIn" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailRuleIn" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailRuleIn" } } } } } } }, "/api/EmailRuleIn/GetByValue": { "post": { "tags": [ "EmailRuleIn" ], "summary": "EmailRuleIn: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailRuleIn-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailRuleIn_GetByValue_3082D39F5DD2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailRuleIn" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailRuleIn" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailRuleIn" } } } } } } }, "/api/EmailRuleIn/GetLookup": { "post": { "tags": [ "EmailRuleIn" ], "summary": "EmailRuleIn: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailRuleIn-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailRuleIn_GetLookup_288F9E7C46BF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/EmailRuleIn/GetLookupByValue": { "post": { "tags": [ "EmailRuleIn" ], "summary": "EmailRuleIn: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailRuleIn-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailRuleIn_GetLookupByValue_579D5E825238", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/EmailRuleIn/Page": { "get": { "tags": [ "EmailRuleIn" ], "summary": "EmailRuleIn: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailRuleIn-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailRuleIn_GetPage_FF0E3C3FFBDB", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmailRuleIn/PageAsc": { "get": { "tags": [ "EmailRuleIn" ], "summary": "EmailRuleIn: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailRuleIn-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailRuleIn_GetPageAsc_1F95779934EF", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmailRuleIn/SearchByValue": { "post": { "tags": [ "EmailRuleIn" ], "summary": "EmailRuleIn: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailRuleIn-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailRuleIn_SearchByValue_860DE62F9CD0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmailRuleIn" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmailRuleIn" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmailRuleIn" } } } } } } }, "/api/EmailRuleIn/TryGetByValue": { "post": { "tags": [ "EmailRuleIn" ], "summary": "EmailRuleIn: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailRuleIn-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailRuleIn_TryGetByValue_7B5F3ACDCC0A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailRuleIn" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailRuleIn" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailRuleIn" } } } } } } }, "/api/EmailRuleIn/UpsertGraph": { "put": { "tags": [ "EmailRuleIn" ], "summary": "EmailRuleIn: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailRuleIn-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailRuleIn_UpsertGraph_32E7D69F51A4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailRuleIn" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailRuleIn" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailRuleIn" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailRuleIn" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailRuleIn" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailRuleIn" } } } } } } }, "/api/EmailRuleIn/UpsertGraphWithExtraFields": { "put": { "tags": [ "EmailRuleIn" ], "summary": "EmailRuleIn: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailRuleIn-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailRuleIn_UpsertGraphWithExtraFields_8CFD8FBD869E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailRuleIn" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailRuleIn" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailRuleIn" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailRuleIn" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailRuleIn" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailRuleIn" } } } } } } }, "/api/EmailRuleOut": { "get": { "tags": [ "EmailRuleOut" ], "summary": "EmailRuleOut: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailRuleOut-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailRuleOut_GetAll_D86E7900F4FD", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailRuleOut" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailRuleOut" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailRuleOut" } } } } } }, "post": { "tags": [ "EmailRuleOut" ], "summary": "EmailRuleOut: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailRuleOut-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailRuleOut_Post_FEF27C662E58", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailRuleOut" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailRuleOut" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailRuleOut" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailRuleOut" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailRuleOut" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailRuleOut" } } } } } }, "put": { "tags": [ "EmailRuleOut" ], "summary": "EmailRuleOut: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailRuleOut-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailRuleOut_Put_69BCEED3E282", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailRuleOut" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailRuleOut" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailRuleOut" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailRuleOut" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailRuleOut" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailRuleOut" } } } } } } }, "/api/EmailRuleOut/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "EmailRuleOut" ], "summary": "EmailRuleOut: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailRuleOut-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailRuleOut_GetPageByValue_30A09EE1BEF0", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmailRuleOut/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "EmailRuleOut" ], "summary": "EmailRuleOut: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailRuleOut-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailRuleOut_GetPageByValue2_AB4C01844747", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmailRuleOut/DeleteByFilter": { "post": { "tags": [ "EmailRuleOut" ], "summary": "EmailRuleOut: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailRuleOut-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailRuleOut_DeleteByFilter_87AAD95A57F9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/EmailRuleOut/GetAllByValue": { "post": { "tags": [ "EmailRuleOut" ], "summary": "EmailRuleOut: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailRuleOut-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailRuleOut_GetAllByValue_F83422E42488", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailRuleOut" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailRuleOut" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailRuleOut" } } } } } } }, "/api/EmailRuleOut/GetAllGraphByValue": { "post": { "tags": [ "EmailRuleOut" ], "summary": "EmailRuleOut: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailRuleOut-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailRuleOut_GetAllGraphByValue_9357BA5DBF50", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailRuleOut" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailRuleOut" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailRuleOut" } } } } } } }, "/api/EmailRuleOut/GetByValue": { "post": { "tags": [ "EmailRuleOut" ], "summary": "EmailRuleOut: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailRuleOut-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailRuleOut_GetByValue_EB3592BEBBA1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailRuleOut" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailRuleOut" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailRuleOut" } } } } } } }, "/api/EmailRuleOut/GetLookup": { "post": { "tags": [ "EmailRuleOut" ], "summary": "EmailRuleOut: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailRuleOut-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailRuleOut_GetLookup_6C456A857EC1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/EmailRuleOut/GetLookupByValue": { "post": { "tags": [ "EmailRuleOut" ], "summary": "EmailRuleOut: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailRuleOut-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailRuleOut_GetLookupByValue_F2482D69D351", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/EmailRuleOut/Page": { "get": { "tags": [ "EmailRuleOut" ], "summary": "EmailRuleOut: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailRuleOut-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailRuleOut_GetPage_5DD73F39114C", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmailRuleOut/PageAsc": { "get": { "tags": [ "EmailRuleOut" ], "summary": "EmailRuleOut: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailRuleOut-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailRuleOut_GetPageAsc_1EFA6FC7E653", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmailRuleOut/SearchByValue": { "post": { "tags": [ "EmailRuleOut" ], "summary": "EmailRuleOut: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailRuleOut-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailRuleOut_SearchByValue_E97CCB11AAEE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmailRuleOut" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmailRuleOut" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmailRuleOut" } } } } } } }, "/api/EmailRuleOut/TryGetByValue": { "post": { "tags": [ "EmailRuleOut" ], "summary": "EmailRuleOut: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailRuleOut-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailRuleOut_TryGetByValue_F1D73FDA9A02", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailRuleOut" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailRuleOut" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailRuleOut" } } } } } } }, "/api/EmailRuleOut/UpsertGraph": { "put": { "tags": [ "EmailRuleOut" ], "summary": "EmailRuleOut: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailRuleOut-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailRuleOut_UpsertGraph_239F210B709E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailRuleOut" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailRuleOut" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailRuleOut" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailRuleOut" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailRuleOut" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailRuleOut" } } } } } } }, "/api/EmailRuleOut/UpsertGraphWithExtraFields": { "put": { "tags": [ "EmailRuleOut" ], "summary": "EmailRuleOut: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailRuleOut-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailRuleOut_UpsertGraphWithExtraFields_543A24BDC5A2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailRuleOut" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailRuleOut" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailRuleOut" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailRuleOut" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailRuleOut" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailRuleOut" } } } } } } }, "/api/EmailSignature": { "get": { "tags": [ "EmailSignature" ], "summary": "EmailSignature: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailSignature-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailSignature_GetAll_2A318CDB4BEF", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailSignature" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailSignature" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailSignature" } } } } } }, "post": { "tags": [ "EmailSignature" ], "summary": "EmailSignature: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailSignature-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailSignature_Post_C1B7DD796A5B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailSignature" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailSignature" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailSignature" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailSignature" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailSignature" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailSignature" } } } } } }, "put": { "tags": [ "EmailSignature" ], "summary": "EmailSignature: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailSignature-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailSignature_Put_2BAA9C8AF488", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailSignature" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailSignature" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailSignature" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailSignature" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailSignature" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailSignature" } } } } } } }, "/api/EmailSignature/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "EmailSignature" ], "summary": "EmailSignature: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailSignature-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailSignature_GetPageByValue_56FF271056AB", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmailSignature/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "EmailSignature" ], "summary": "EmailSignature: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailSignature-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailSignature_GetPageByValue2_C0D7175A7DB6", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmailSignature/DeleteByFilter": { "post": { "tags": [ "EmailSignature" ], "summary": "EmailSignature: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailSignature-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailSignature_DeleteByFilter_BE7727440677", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/EmailSignature/GetAllByValue": { "post": { "tags": [ "EmailSignature" ], "summary": "EmailSignature: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailSignature-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailSignature_GetAllByValue_774D5224304B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailSignature" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailSignature" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailSignature" } } } } } } }, "/api/EmailSignature/GetAllGraphByValue": { "post": { "tags": [ "EmailSignature" ], "summary": "EmailSignature: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailSignature-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailSignature_GetAllGraphByValue_ADD984580471", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailSignature" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailSignature" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailSignature" } } } } } } }, "/api/EmailSignature/GetByValue": { "post": { "tags": [ "EmailSignature" ], "summary": "EmailSignature: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailSignature-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailSignature_GetByValue_70511EF1705C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailSignature" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailSignature" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailSignature" } } } } } } }, "/api/EmailSignature/GetLookup": { "post": { "tags": [ "EmailSignature" ], "summary": "EmailSignature: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailSignature-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailSignature_GetLookup_242688BF2B8E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/EmailSignature/GetLookupByValue": { "post": { "tags": [ "EmailSignature" ], "summary": "EmailSignature: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailSignature-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailSignature_GetLookupByValue_5A023780E229", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/EmailSignature/Page": { "get": { "tags": [ "EmailSignature" ], "summary": "EmailSignature: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailSignature-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailSignature_GetPage_970392B836C2", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmailSignature/PageAsc": { "get": { "tags": [ "EmailSignature" ], "summary": "EmailSignature: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailSignature-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailSignature_GetPageAsc_620BC0043498", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmailSignature/SearchByValue": { "post": { "tags": [ "EmailSignature" ], "summary": "EmailSignature: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailSignature-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailSignature_SearchByValue_409A890589C8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmailSignature" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmailSignature" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmailSignature" } } } } } } }, "/api/EmailSignature/TryGetByValue": { "post": { "tags": [ "EmailSignature" ], "summary": "EmailSignature: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailSignature-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailSignature_TryGetByValue_BB9599748CD1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailSignature" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailSignature" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailSignature" } } } } } } }, "/api/EmailSignature/UpsertGraph": { "put": { "tags": [ "EmailSignature" ], "summary": "EmailSignature: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailSignature-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailSignature_UpsertGraph_41D7D77D99AB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailSignature" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailSignature" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailSignature" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailSignature" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailSignature" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailSignature" } } } } } } }, "/api/EmailSignature/UpsertGraphWithExtraFields": { "put": { "tags": [ "EmailSignature" ], "summary": "EmailSignature: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailSignature-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailSignature_UpsertGraphWithExtraFields_E5A23EE752DE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailSignature" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailSignature" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailSignature" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailSignature" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailSignature" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailSignature" } } } } } } }, "/api/EmailSignatureAttachment": { "get": { "tags": [ "EmailSignatureAttachment" ], "summary": "EmailSignatureAttachment: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailSignatureAttachment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailSignatureAttachment_GetAll_BD960C87264F", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailSignatureAttachment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailSignatureAttachment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailSignatureAttachment" } } } } } }, "post": { "tags": [ "EmailSignatureAttachment" ], "summary": "EmailSignatureAttachment: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailSignatureAttachment-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailSignatureAttachment_Post_8694174E2201", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailSignatureAttachment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailSignatureAttachment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailSignatureAttachment" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailSignatureAttachment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailSignatureAttachment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailSignatureAttachment" } } } } } }, "put": { "tags": [ "EmailSignatureAttachment" ], "summary": "EmailSignatureAttachment: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailSignatureAttachment-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailSignatureAttachment_Put_1BA4ACD1885A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailSignatureAttachment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailSignatureAttachment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailSignatureAttachment" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailSignatureAttachment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailSignatureAttachment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailSignatureAttachment" } } } } } } }, "/api/EmailSignatureAttachment/{EmailSignatureId}/CopyToEmail/{EmailId}": { "post": { "tags": [ "EmailSignatureAttachment" ], "summary": "EmailSignatureAttachment: CopyToEmail", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailSignatureAttachment-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailSignatureAttachment_CopyToEmail_7959EEC8E8F5", "parameters": [ { "name": "EmailSignatureId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "EmailId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/EmailSignatureAttachment/{EmailSignatureId}/UploadChunkFile": { "post": { "tags": [ "EmailSignatureAttachment" ], "summary": "EmailSignatureAttachment: UploadChunkFile", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailSignatureAttachment-Create.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailSignatureAttachment_UploadChunkFile_85EE68DD188C", "parameters": [ { "name": "EmailSignatureId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "fileChunk": { "type": "string", "format": "binary" } } }, "encoding": { "fileChunk": { "style": "form" } } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/EmailSignatureAttachment/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "EmailSignatureAttachment" ], "summary": "EmailSignatureAttachment: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailSignatureAttachment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailSignatureAttachment_GetPageByValue_6313C281555D", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmailSignatureAttachment/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "EmailSignatureAttachment" ], "summary": "EmailSignatureAttachment: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailSignatureAttachment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailSignatureAttachment_GetPageByValue2_720D52BC678B", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmailSignatureAttachment/DeleteByFilter": { "post": { "tags": [ "EmailSignatureAttachment" ], "summary": "EmailSignatureAttachment: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailSignatureAttachment-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailSignatureAttachment_DeleteByFilter_832A3B82C707", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/EmailSignatureAttachment/DownloadAttachment/{EmailSignatureAttachmentId}": { "get": { "tags": [ "EmailSignatureAttachment" ], "summary": "EmailSignatureAttachment: DownloadAttachment", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailSignatureAttachment-Read.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailSignatureAttachment_DownloadAttachment_FA0D9E39DEF6", "parameters": [ { "name": "EmailSignatureAttachmentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmailSignatureAttachment/GetAllByValue": { "post": { "tags": [ "EmailSignatureAttachment" ], "summary": "EmailSignatureAttachment: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailSignatureAttachment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailSignatureAttachment_GetAllByValue_5075028187D4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailSignatureAttachment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailSignatureAttachment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailSignatureAttachment" } } } } } } }, "/api/EmailSignatureAttachment/GetAllGraphByValue": { "post": { "tags": [ "EmailSignatureAttachment" ], "summary": "EmailSignatureAttachment: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailSignatureAttachment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailSignatureAttachment_GetAllGraphByValue_D1E8308A4595", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailSignatureAttachment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailSignatureAttachment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailSignatureAttachment" } } } } } } }, "/api/EmailSignatureAttachment/GetByValue": { "post": { "tags": [ "EmailSignatureAttachment" ], "summary": "EmailSignatureAttachment: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailSignatureAttachment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailSignatureAttachment_GetByValue_1E480F83EDF8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailSignatureAttachment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailSignatureAttachment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailSignatureAttachment" } } } } } } }, "/api/EmailSignatureAttachment/GetLookup": { "post": { "tags": [ "EmailSignatureAttachment" ], "summary": "EmailSignatureAttachment: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailSignatureAttachment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailSignatureAttachment_GetLookup_71AB258B01D5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/EmailSignatureAttachment/GetLookupByValue": { "post": { "tags": [ "EmailSignatureAttachment" ], "summary": "EmailSignatureAttachment: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailSignatureAttachment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailSignatureAttachment_GetLookupByValue_3C778FFA6B7E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/EmailSignatureAttachment/Page": { "get": { "tags": [ "EmailSignatureAttachment" ], "summary": "EmailSignatureAttachment: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailSignatureAttachment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailSignatureAttachment_GetPage_4771E5643152", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmailSignatureAttachment/PageAsc": { "get": { "tags": [ "EmailSignatureAttachment" ], "summary": "EmailSignatureAttachment: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailSignatureAttachment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailSignatureAttachment_GetPageAsc_4FA678C2BBA8", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmailSignatureAttachment/SearchByValue": { "post": { "tags": [ "EmailSignatureAttachment" ], "summary": "EmailSignatureAttachment: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailSignatureAttachment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailSignatureAttachment_SearchByValue_5139216125D5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmailSignatureAttachment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmailSignatureAttachment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmailSignatureAttachment" } } } } } } }, "/api/EmailSignatureAttachment/TryGetByValue": { "post": { "tags": [ "EmailSignatureAttachment" ], "summary": "EmailSignatureAttachment: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailSignatureAttachment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailSignatureAttachment_TryGetByValue_939AC2ECEDAA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailSignatureAttachment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailSignatureAttachment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailSignatureAttachment" } } } } } } }, "/api/EmailSignatureAttachment/UpsertGraph": { "put": { "tags": [ "EmailSignatureAttachment" ], "summary": "EmailSignatureAttachment: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailSignatureAttachment-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailSignatureAttachment_UpsertGraph_9B07B8A0B15F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailSignatureAttachment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailSignatureAttachment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailSignatureAttachment" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailSignatureAttachment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailSignatureAttachment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailSignatureAttachment" } } } } } } }, "/api/EmailSignatureAttachment/UpsertGraphWithExtraFields": { "put": { "tags": [ "EmailSignatureAttachment" ], "summary": "EmailSignatureAttachment: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailSignatureAttachment-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailSignatureAttachment_UpsertGraphWithExtraFields_69525F257870", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailSignatureAttachment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailSignatureAttachment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailSignatureAttachment" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailSignatureAttachment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailSignatureAttachment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailSignatureAttachment" } } } } } } }, "/api/EmailSpamProtectionSender": { "get": { "tags": [ "EmailSpamProtectionSender" ], "summary": "EmailSpamProtectionSender: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailSpamProtectionSender-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailSpamProtectionSender_GetAll_7676839EFB5E", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailSpamProtectionSender" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailSpamProtectionSender" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailSpamProtectionSender" } } } } } }, "post": { "tags": [ "EmailSpamProtectionSender" ], "summary": "EmailSpamProtectionSender: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailSpamProtectionSender-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailSpamProtectionSender_Post_05F923810BC6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailSpamProtectionSender" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailSpamProtectionSender" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailSpamProtectionSender" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailSpamProtectionSender" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailSpamProtectionSender" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailSpamProtectionSender" } } } } } }, "put": { "tags": [ "EmailSpamProtectionSender" ], "summary": "EmailSpamProtectionSender: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailSpamProtectionSender-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailSpamProtectionSender_Put_F10ECEC9FF8D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailSpamProtectionSender" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailSpamProtectionSender" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailSpamProtectionSender" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailSpamProtectionSender" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailSpamProtectionSender" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailSpamProtectionSender" } } } } } } }, "/api/EmailSpamProtectionSender/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "EmailSpamProtectionSender" ], "summary": "EmailSpamProtectionSender: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailSpamProtectionSender-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailSpamProtectionSender_GetPageByValue_57793BDA655D", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmailSpamProtectionSender/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "EmailSpamProtectionSender" ], "summary": "EmailSpamProtectionSender: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailSpamProtectionSender-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailSpamProtectionSender_GetPageByValue2_9A97F6F3DFAC", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmailSpamProtectionSender/DeleteByFilter": { "post": { "tags": [ "EmailSpamProtectionSender" ], "summary": "EmailSpamProtectionSender: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailSpamProtectionSender-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailSpamProtectionSender_DeleteByFilter_A6FA988C38A6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/EmailSpamProtectionSender/GetAllByValue": { "post": { "tags": [ "EmailSpamProtectionSender" ], "summary": "EmailSpamProtectionSender: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailSpamProtectionSender-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailSpamProtectionSender_GetAllByValue_386FEE08A66E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailSpamProtectionSender" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailSpamProtectionSender" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailSpamProtectionSender" } } } } } } }, "/api/EmailSpamProtectionSender/GetAllGraphByValue": { "post": { "tags": [ "EmailSpamProtectionSender" ], "summary": "EmailSpamProtectionSender: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailSpamProtectionSender-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailSpamProtectionSender_GetAllGraphByValue_7A8FBC84EA37", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailSpamProtectionSender" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailSpamProtectionSender" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailSpamProtectionSender" } } } } } } }, "/api/EmailSpamProtectionSender/GetByValue": { "post": { "tags": [ "EmailSpamProtectionSender" ], "summary": "EmailSpamProtectionSender: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailSpamProtectionSender-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailSpamProtectionSender_GetByValue_0E4EE62662D1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailSpamProtectionSender" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailSpamProtectionSender" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailSpamProtectionSender" } } } } } } }, "/api/EmailSpamProtectionSender/GetLookup": { "post": { "tags": [ "EmailSpamProtectionSender" ], "summary": "EmailSpamProtectionSender: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailSpamProtectionSender-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailSpamProtectionSender_GetLookup_C3CE580233F1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/EmailSpamProtectionSender/GetLookupByValue": { "post": { "tags": [ "EmailSpamProtectionSender" ], "summary": "EmailSpamProtectionSender: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailSpamProtectionSender-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailSpamProtectionSender_GetLookupByValue_7C685CD2B0D1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/EmailSpamProtectionSender/Page": { "get": { "tags": [ "EmailSpamProtectionSender" ], "summary": "EmailSpamProtectionSender: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailSpamProtectionSender-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailSpamProtectionSender_GetPage_97F22ABB31DE", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmailSpamProtectionSender/PageAsc": { "get": { "tags": [ "EmailSpamProtectionSender" ], "summary": "EmailSpamProtectionSender: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailSpamProtectionSender-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailSpamProtectionSender_GetPageAsc_D181EDCA4A10", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmailSpamProtectionSender/SearchByValue": { "post": { "tags": [ "EmailSpamProtectionSender" ], "summary": "EmailSpamProtectionSender: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailSpamProtectionSender-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailSpamProtectionSender_SearchByValue_647634B7C872", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmailSpamProtectionSender" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmailSpamProtectionSender" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmailSpamProtectionSender" } } } } } } }, "/api/EmailSpamProtectionSender/TryGetByValue": { "post": { "tags": [ "EmailSpamProtectionSender" ], "summary": "EmailSpamProtectionSender: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailSpamProtectionSender-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailSpamProtectionSender_TryGetByValue_562EB43E5424", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailSpamProtectionSender" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailSpamProtectionSender" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailSpamProtectionSender" } } } } } } }, "/api/EmailSpamProtectionSender/UpsertGraph": { "put": { "tags": [ "EmailSpamProtectionSender" ], "summary": "EmailSpamProtectionSender: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailSpamProtectionSender-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailSpamProtectionSender_UpsertGraph_BC2BAAE3E9AE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailSpamProtectionSender" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailSpamProtectionSender" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailSpamProtectionSender" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailSpamProtectionSender" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailSpamProtectionSender" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailSpamProtectionSender" } } } } } } }, "/api/EmailSpamProtectionSender/UpsertGraphWithExtraFields": { "put": { "tags": [ "EmailSpamProtectionSender" ], "summary": "EmailSpamProtectionSender: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailSpamProtectionSender-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailSpamProtectionSender_UpsertGraphWithExtraFields_C1FBCBFA030D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailSpamProtectionSender" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailSpamProtectionSender" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailSpamProtectionSender" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailSpamProtectionSender" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailSpamProtectionSender" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailSpamProtectionSender" } } } } } } }, "/api/EmailSpamProtectionSubject": { "get": { "tags": [ "EmailSpamProtectionSubject" ], "summary": "EmailSpamProtectionSubject: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailSpamProtectionSubject-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailSpamProtectionSubject_GetAll_7F57E6800251", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailSpamProtectionSubject" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailSpamProtectionSubject" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailSpamProtectionSubject" } } } } } }, "post": { "tags": [ "EmailSpamProtectionSubject" ], "summary": "EmailSpamProtectionSubject: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailSpamProtectionSubject-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailSpamProtectionSubject_Post_92E9B5C9C750", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailSpamProtectionSubject" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailSpamProtectionSubject" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailSpamProtectionSubject" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailSpamProtectionSubject" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailSpamProtectionSubject" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailSpamProtectionSubject" } } } } } }, "put": { "tags": [ "EmailSpamProtectionSubject" ], "summary": "EmailSpamProtectionSubject: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailSpamProtectionSubject-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailSpamProtectionSubject_Put_41D712F08BF2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailSpamProtectionSubject" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailSpamProtectionSubject" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailSpamProtectionSubject" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailSpamProtectionSubject" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailSpamProtectionSubject" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailSpamProtectionSubject" } } } } } } }, "/api/EmailSpamProtectionSubject/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "EmailSpamProtectionSubject" ], "summary": "EmailSpamProtectionSubject: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailSpamProtectionSubject-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailSpamProtectionSubject_GetPageByValue_5A19F76F52F5", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmailSpamProtectionSubject/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "EmailSpamProtectionSubject" ], "summary": "EmailSpamProtectionSubject: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailSpamProtectionSubject-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailSpamProtectionSubject_GetPageByValue2_A41676372AB9", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmailSpamProtectionSubject/DeleteByFilter": { "post": { "tags": [ "EmailSpamProtectionSubject" ], "summary": "EmailSpamProtectionSubject: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailSpamProtectionSubject-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailSpamProtectionSubject_DeleteByFilter_9C7C660A379F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/EmailSpamProtectionSubject/GetAllByValue": { "post": { "tags": [ "EmailSpamProtectionSubject" ], "summary": "EmailSpamProtectionSubject: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailSpamProtectionSubject-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailSpamProtectionSubject_GetAllByValue_135E5861FC23", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailSpamProtectionSubject" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailSpamProtectionSubject" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailSpamProtectionSubject" } } } } } } }, "/api/EmailSpamProtectionSubject/GetAllGraphByValue": { "post": { "tags": [ "EmailSpamProtectionSubject" ], "summary": "EmailSpamProtectionSubject: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailSpamProtectionSubject-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailSpamProtectionSubject_GetAllGraphByValue_4C38F2392BF0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailSpamProtectionSubject" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailSpamProtectionSubject" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailSpamProtectionSubject" } } } } } } }, "/api/EmailSpamProtectionSubject/GetByValue": { "post": { "tags": [ "EmailSpamProtectionSubject" ], "summary": "EmailSpamProtectionSubject: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailSpamProtectionSubject-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailSpamProtectionSubject_GetByValue_461F5EC5AC97", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailSpamProtectionSubject" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailSpamProtectionSubject" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailSpamProtectionSubject" } } } } } } }, "/api/EmailSpamProtectionSubject/GetLookup": { "post": { "tags": [ "EmailSpamProtectionSubject" ], "summary": "EmailSpamProtectionSubject: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailSpamProtectionSubject-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailSpamProtectionSubject_GetLookup_5AC63778CA14", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/EmailSpamProtectionSubject/GetLookupByValue": { "post": { "tags": [ "EmailSpamProtectionSubject" ], "summary": "EmailSpamProtectionSubject: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailSpamProtectionSubject-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailSpamProtectionSubject_GetLookupByValue_9CCBAAD57C0F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/EmailSpamProtectionSubject/Page": { "get": { "tags": [ "EmailSpamProtectionSubject" ], "summary": "EmailSpamProtectionSubject: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailSpamProtectionSubject-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailSpamProtectionSubject_GetPage_B247D816AB95", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmailSpamProtectionSubject/PageAsc": { "get": { "tags": [ "EmailSpamProtectionSubject" ], "summary": "EmailSpamProtectionSubject: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailSpamProtectionSubject-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailSpamProtectionSubject_GetPageAsc_E9B8405B7D3F", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmailSpamProtectionSubject/SearchByValue": { "post": { "tags": [ "EmailSpamProtectionSubject" ], "summary": "EmailSpamProtectionSubject: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailSpamProtectionSubject-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailSpamProtectionSubject_SearchByValue_52CD0B3E944B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmailSpamProtectionSubject" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmailSpamProtectionSubject" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmailSpamProtectionSubject" } } } } } } }, "/api/EmailSpamProtectionSubject/TryGetByValue": { "post": { "tags": [ "EmailSpamProtectionSubject" ], "summary": "EmailSpamProtectionSubject: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailSpamProtectionSubject-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailSpamProtectionSubject_TryGetByValue_01208ACCB5EE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailSpamProtectionSubject" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailSpamProtectionSubject" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailSpamProtectionSubject" } } } } } } }, "/api/EmailSpamProtectionSubject/UpsertGraph": { "put": { "tags": [ "EmailSpamProtectionSubject" ], "summary": "EmailSpamProtectionSubject: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailSpamProtectionSubject-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailSpamProtectionSubject_UpsertGraph_19A64545433A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailSpamProtectionSubject" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailSpamProtectionSubject" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailSpamProtectionSubject" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailSpamProtectionSubject" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailSpamProtectionSubject" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailSpamProtectionSubject" } } } } } } }, "/api/EmailSpamProtectionSubject/UpsertGraphWithExtraFields": { "put": { "tags": [ "EmailSpamProtectionSubject" ], "summary": "EmailSpamProtectionSubject: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailSpamProtectionSubject-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailSpamProtectionSubject_UpsertGraphWithExtraFields_35351DAF62A8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailSpamProtectionSubject" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailSpamProtectionSubject" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailSpamProtectionSubject" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailSpamProtectionSubject" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailSpamProtectionSubject" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailSpamProtectionSubject" } } } } } } }, "/api/EmailSystem": { "get": { "tags": [ "EmailSystem" ], "summary": "EmailSystem: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailSystem-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailSystem_GetAll_FC9913690AF9", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailSystem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailSystem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailSystem" } } } } } }, "post": { "tags": [ "EmailSystem" ], "summary": "EmailSystem: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailSystem-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailSystem_Post_081539EAB218", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailSystem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailSystem" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailSystem" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailSystem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailSystem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailSystem" } } } } } }, "put": { "tags": [ "EmailSystem" ], "summary": "EmailSystem: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailSystem-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailSystem_Put_28924D31D03F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailSystem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailSystem" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailSystem" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailSystem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailSystem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailSystem" } } } } } } }, "/api/EmailSystem/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "EmailSystem" ], "summary": "EmailSystem: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailSystem-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailSystem_GetPageByValue_569A2DAFE64A", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmailSystem/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "EmailSystem" ], "summary": "EmailSystem: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailSystem-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailSystem_GetPageByValue2_7BD6F5877D14", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmailSystem/DeleteByFilter": { "post": { "tags": [ "EmailSystem" ], "summary": "EmailSystem: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailSystem-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailSystem_DeleteByFilter_D065E100579D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/EmailSystem/GetAllByValue": { "post": { "tags": [ "EmailSystem" ], "summary": "EmailSystem: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailSystem-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailSystem_GetAllByValue_73B569537337", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailSystem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailSystem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailSystem" } } } } } } }, "/api/EmailSystem/GetAllGraphByValue": { "post": { "tags": [ "EmailSystem" ], "summary": "EmailSystem: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailSystem-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailSystem_GetAllGraphByValue_2863C53135F6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailSystem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailSystem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailSystem" } } } } } } }, "/api/EmailSystem/GetByValue": { "post": { "tags": [ "EmailSystem" ], "summary": "EmailSystem: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailSystem-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailSystem_GetByValue_F5D77D88DC35", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailSystem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailSystem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailSystem" } } } } } } }, "/api/EmailSystem/GetLookup": { "post": { "tags": [ "EmailSystem" ], "summary": "EmailSystem: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailSystem-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailSystem_GetLookup_AF348995BF63", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/EmailSystem/GetLookupByValue": { "post": { "tags": [ "EmailSystem" ], "summary": "EmailSystem: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailSystem-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailSystem_GetLookupByValue_78DF78256DFB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/EmailSystem/Page": { "get": { "tags": [ "EmailSystem" ], "summary": "EmailSystem: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailSystem-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailSystem_GetPage_E45472FC18D8", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmailSystem/PageAsc": { "get": { "tags": [ "EmailSystem" ], "summary": "EmailSystem: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailSystem-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailSystem_GetPageAsc_FF056A30EA5F", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmailSystem/SearchByValue": { "post": { "tags": [ "EmailSystem" ], "summary": "EmailSystem: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailSystem-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailSystem_SearchByValue_4F323DF5A9F1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmailSystem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmailSystem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmailSystem" } } } } } } }, "/api/EmailSystem/TryGetByValue": { "post": { "tags": [ "EmailSystem" ], "summary": "EmailSystem: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailSystem-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailSystem_TryGetByValue_891A0B94120E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailSystem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailSystem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailSystem" } } } } } } }, "/api/EmailSystem/UpsertGraph": { "put": { "tags": [ "EmailSystem" ], "summary": "EmailSystem: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailSystem-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailSystem_UpsertGraph_61B2007366F3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailSystem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailSystem" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailSystem" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailSystem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailSystem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailSystem" } } } } } } }, "/api/EmailSystem/UpsertGraphWithExtraFields": { "put": { "tags": [ "EmailSystem" ], "summary": "EmailSystem: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailSystem-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailSystem_UpsertGraphWithExtraFields_09F3C48BDCD8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailSystem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailSystem" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailSystem" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailSystem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailSystem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailSystem" } } } } } } }, "/api/EmailTemplate": { "get": { "tags": [ "EmailTemplate" ], "summary": "EmailTemplate: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailTemplate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailTemplate_GetAll_25F4A0A41034", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailTemplate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailTemplate" } } } } } }, "post": { "tags": [ "EmailTemplate" ], "summary": "EmailTemplate: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailTemplate-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailTemplate_Post_E1B9C9F37BE0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailTemplate" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailTemplate" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailTemplate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailTemplate" } } } } } }, "put": { "tags": [ "EmailTemplate" ], "summary": "EmailTemplate: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailTemplate-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailTemplate_Put_51A92CAC85F2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailTemplate" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailTemplate" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailTemplate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailTemplate" } } } } } } }, "/api/EmailTemplate/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "EmailTemplate" ], "summary": "EmailTemplate: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailTemplate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailTemplate_GetPageByValue_2EF91B66BB4D", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmailTemplate/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "EmailTemplate" ], "summary": "EmailTemplate: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailTemplate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailTemplate_GetPageByValue2_201C1AC0B387", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmailTemplate/DeleteByFilter": { "post": { "tags": [ "EmailTemplate" ], "summary": "EmailTemplate: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailTemplate-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailTemplate_DeleteByFilter_7D2E1B3063B3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/EmailTemplate/GetAllByValue": { "post": { "tags": [ "EmailTemplate" ], "summary": "EmailTemplate: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailTemplate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailTemplate_GetAllByValue_5A8FDFFF2409", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailTemplate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailTemplate" } } } } } } }, "/api/EmailTemplate/GetAllGraphByValue": { "post": { "tags": [ "EmailTemplate" ], "summary": "EmailTemplate: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailTemplate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailTemplate_GetAllGraphByValue_0F86DC474D16", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailTemplate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailTemplate" } } } } } } }, "/api/EmailTemplate/GetByDocTypeAndLanguage": { "get": { "tags": [ "EmailTemplate" ], "summary": "EmailTemplate: GetByDocTypeAndLanguage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailTemplate-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailTemplate_GetByDocTypeAndLanguage_10F80977BD92", "parameters": [ { "name": "docTypeId", "in": "query", "schema": { "type": "string" } }, { "name": "languageId", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailTemplate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailTemplate" } } } } } } }, "/api/EmailTemplate/GetByValue": { "post": { "tags": [ "EmailTemplate" ], "summary": "EmailTemplate: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailTemplate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailTemplate_GetByValue_F8665E803625", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailTemplate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailTemplate" } } } } } } }, "/api/EmailTemplate/GetLookup": { "post": { "tags": [ "EmailTemplate" ], "summary": "EmailTemplate: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailTemplate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailTemplate_GetLookup_1D60251A8D53", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/EmailTemplate/GetLookupByValue": { "post": { "tags": [ "EmailTemplate" ], "summary": "EmailTemplate: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailTemplate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailTemplate_GetLookupByValue_220CE6D218EF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/EmailTemplate/Page": { "get": { "tags": [ "EmailTemplate" ], "summary": "EmailTemplate: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailTemplate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailTemplate_GetPage_5856A6A6DB8C", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmailTemplate/PageAsc": { "get": { "tags": [ "EmailTemplate" ], "summary": "EmailTemplate: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailTemplate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailTemplate_GetPageAsc_277C41C529C2", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmailTemplate/PageEmailTemplatesByGroup/{GroupId}/{IncludeSubNodes}/{TopGroupsOnly}": { "get": { "tags": [ "EmailTemplate" ], "summary": "EmailTemplate: GetPageEmailTemplatesByGroup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailTemplate-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailTemplate_GetPageEmailTemplatesByGroup_7B168022629A", "parameters": [ { "name": "GroupId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "IncludeSubNodes", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "TopGroupsOnly", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmailTemplate/SearchByValue": { "post": { "tags": [ "EmailTemplate" ], "summary": "EmailTemplate: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailTemplate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailTemplate_SearchByValue_DD170481D651", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmailTemplate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmailTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmailTemplate" } } } } } } }, "/api/EmailTemplate/TryGetByValue": { "post": { "tags": [ "EmailTemplate" ], "summary": "EmailTemplate: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailTemplate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailTemplate_TryGetByValue_3230DEE444FE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailTemplate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailTemplate" } } } } } } }, "/api/EmailTemplate/UpsertGraph": { "put": { "tags": [ "EmailTemplate" ], "summary": "EmailTemplate: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailTemplate-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailTemplate_UpsertGraph_75673DBE22E4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailTemplate" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailTemplate" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailTemplate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailTemplate" } } } } } } }, "/api/EmailTemplate/UpsertGraphWithExtraFields": { "put": { "tags": [ "EmailTemplate" ], "summary": "EmailTemplate: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailTemplate-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailTemplate_UpsertGraphWithExtraFields_2EE85DC9526C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailTemplate" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailTemplate" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailTemplate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailTemplate" } } } } } } }, "/api/EmailTemplateAttachment": { "get": { "tags": [ "EmailTemplateAttachment" ], "summary": "EmailTemplateAttachment: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailTemplateAttachment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailTemplateAttachment_GetAll_0776C0582225", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailTemplateAttachment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailTemplateAttachment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailTemplateAttachment" } } } } } }, "post": { "tags": [ "EmailTemplateAttachment" ], "summary": "EmailTemplateAttachment: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailTemplateAttachment-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailTemplateAttachment_Post_AA54FA431F62", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailTemplateAttachment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailTemplateAttachment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailTemplateAttachment" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailTemplateAttachment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailTemplateAttachment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailTemplateAttachment" } } } } } }, "put": { "tags": [ "EmailTemplateAttachment" ], "summary": "EmailTemplateAttachment: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailTemplateAttachment-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailTemplateAttachment_Put_FD897287FADD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailTemplateAttachment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailTemplateAttachment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailTemplateAttachment" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailTemplateAttachment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailTemplateAttachment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailTemplateAttachment" } } } } } } }, "/api/EmailTemplateAttachment/{EmailTemplateId}/CopyToEmail/{EmailId}": { "post": { "tags": [ "EmailTemplateAttachment" ], "summary": "EmailTemplateAttachment: CopyToEmail", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailTemplateAttachment-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailTemplateAttachment_CopyToEmail_F3AB7E3B6035", "parameters": [ { "name": "EmailTemplateId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "EmailId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/EmailTemplateAttachment/{EmailTemplateId}/UploadChunkFile": { "post": { "tags": [ "EmailTemplateAttachment" ], "summary": "EmailTemplateAttachment: UploadChunkFile", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailTemplateAttachment-Create.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailTemplateAttachment_UploadChunkFile_A719E6521659", "parameters": [ { "name": "EmailTemplateId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "fileChunk": { "type": "string", "format": "binary" } } }, "encoding": { "fileChunk": { "style": "form" } } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/EmailTemplateAttachment/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "EmailTemplateAttachment" ], "summary": "EmailTemplateAttachment: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailTemplateAttachment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailTemplateAttachment_GetPageByValue_33BCA0A10089", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmailTemplateAttachment/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "EmailTemplateAttachment" ], "summary": "EmailTemplateAttachment: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailTemplateAttachment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailTemplateAttachment_GetPageByValue2_1C3CE8B5259E", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmailTemplateAttachment/DeleteByFilter": { "post": { "tags": [ "EmailTemplateAttachment" ], "summary": "EmailTemplateAttachment: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailTemplateAttachment-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailTemplateAttachment_DeleteByFilter_9C90D57B61E6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/EmailTemplateAttachment/DownloadAttachment/{EmailTemplateAttachmentId}": { "get": { "tags": [ "EmailTemplateAttachment" ], "summary": "EmailTemplateAttachment: DownloadAttachment", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailTemplateAttachment-Read.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailTemplateAttachment_DownloadAttachment_B30BE08A80C5", "parameters": [ { "name": "EmailTemplateAttachmentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmailTemplateAttachment/GetAllByValue": { "post": { "tags": [ "EmailTemplateAttachment" ], "summary": "EmailTemplateAttachment: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailTemplateAttachment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailTemplateAttachment_GetAllByValue_E0F742C01D0B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailTemplateAttachment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailTemplateAttachment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailTemplateAttachment" } } } } } } }, "/api/EmailTemplateAttachment/GetAllGraphByValue": { "post": { "tags": [ "EmailTemplateAttachment" ], "summary": "EmailTemplateAttachment: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailTemplateAttachment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailTemplateAttachment_GetAllGraphByValue_9FBD5807266D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailTemplateAttachment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailTemplateAttachment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailTemplateAttachment" } } } } } } }, "/api/EmailTemplateAttachment/GetByValue": { "post": { "tags": [ "EmailTemplateAttachment" ], "summary": "EmailTemplateAttachment: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailTemplateAttachment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailTemplateAttachment_GetByValue_DB57B4C02D91", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailTemplateAttachment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailTemplateAttachment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailTemplateAttachment" } } } } } } }, "/api/EmailTemplateAttachment/GetLookup": { "post": { "tags": [ "EmailTemplateAttachment" ], "summary": "EmailTemplateAttachment: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailTemplateAttachment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailTemplateAttachment_GetLookup_2A2A0486B448", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/EmailTemplateAttachment/GetLookupByValue": { "post": { "tags": [ "EmailTemplateAttachment" ], "summary": "EmailTemplateAttachment: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailTemplateAttachment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailTemplateAttachment_GetLookupByValue_E9C2AC3BA8FF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/EmailTemplateAttachment/Page": { "get": { "tags": [ "EmailTemplateAttachment" ], "summary": "EmailTemplateAttachment: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailTemplateAttachment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailTemplateAttachment_GetPage_96ECCB14D09C", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmailTemplateAttachment/PageAsc": { "get": { "tags": [ "EmailTemplateAttachment" ], "summary": "EmailTemplateAttachment: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailTemplateAttachment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailTemplateAttachment_GetPageAsc_B4F041C617AB", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmailTemplateAttachment/SearchByValue": { "post": { "tags": [ "EmailTemplateAttachment" ], "summary": "EmailTemplateAttachment: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailTemplateAttachment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailTemplateAttachment_SearchByValue_F314D7D05F70", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmailTemplateAttachment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmailTemplateAttachment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmailTemplateAttachment" } } } } } } }, "/api/EmailTemplateAttachment/TryGetByValue": { "post": { "tags": [ "EmailTemplateAttachment" ], "summary": "EmailTemplateAttachment: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailTemplateAttachment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailTemplateAttachment_TryGetByValue_4F44F775930E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailTemplateAttachment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailTemplateAttachment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailTemplateAttachment" } } } } } } }, "/api/EmailTemplateAttachment/UpsertGraph": { "put": { "tags": [ "EmailTemplateAttachment" ], "summary": "EmailTemplateAttachment: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailTemplateAttachment-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailTemplateAttachment_UpsertGraph_A712E882C0C0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailTemplateAttachment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailTemplateAttachment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailTemplateAttachment" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailTemplateAttachment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailTemplateAttachment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailTemplateAttachment" } } } } } } }, "/api/EmailTemplateAttachment/UpsertGraphWithExtraFields": { "put": { "tags": [ "EmailTemplateAttachment" ], "summary": "EmailTemplateAttachment: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailTemplateAttachment-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailTemplateAttachment_UpsertGraphWithExtraFields_D12FCB5B6EA3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailTemplateAttachment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailTemplateAttachment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailTemplateAttachment" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailTemplateAttachment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailTemplateAttachment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailTemplateAttachment" } } } } } } }, "/api/EmailTemplateGroup": { "get": { "tags": [ "EmailTemplateGroup" ], "summary": "EmailTemplateGroup: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailTemplateGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailTemplateGroup_GetAll_5D415BB5AA93", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailTemplateGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailTemplateGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailTemplateGroup" } } } } } }, "post": { "tags": [ "EmailTemplateGroup" ], "summary": "EmailTemplateGroup: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailTemplateGroup-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailTemplateGroup_Post_0C1FE538D856", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailTemplateGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailTemplateGroup" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailTemplateGroup" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailTemplateGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailTemplateGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailTemplateGroup" } } } } } }, "put": { "tags": [ "EmailTemplateGroup" ], "summary": "EmailTemplateGroup: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailTemplateGroup-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailTemplateGroup_Put_1989E0E6271C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailTemplateGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailTemplateGroup" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailTemplateGroup" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailTemplateGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailTemplateGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailTemplateGroup" } } } } } } }, "/api/EmailTemplateGroup/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "EmailTemplateGroup" ], "summary": "EmailTemplateGroup: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailTemplateGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailTemplateGroup_GetPageByValue_7877A604D342", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmailTemplateGroup/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "EmailTemplateGroup" ], "summary": "EmailTemplateGroup: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailTemplateGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailTemplateGroup_GetPageByValue2_0BDF43FB7730", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmailTemplateGroup/DeleteByFilter": { "post": { "tags": [ "EmailTemplateGroup" ], "summary": "EmailTemplateGroup: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailTemplateGroup-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailTemplateGroup_DeleteByFilter_F05D82009544", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/EmailTemplateGroup/GetAllByValue": { "post": { "tags": [ "EmailTemplateGroup" ], "summary": "EmailTemplateGroup: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailTemplateGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailTemplateGroup_GetAllByValue_1AAA39539A23", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailTemplateGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailTemplateGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailTemplateGroup" } } } } } } }, "/api/EmailTemplateGroup/GetAllGraphByValue": { "post": { "tags": [ "EmailTemplateGroup" ], "summary": "EmailTemplateGroup: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailTemplateGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailTemplateGroup_GetAllGraphByValue_F8D9482EC990", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailTemplateGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailTemplateGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailTemplateGroup" } } } } } } }, "/api/EmailTemplateGroup/GetByValue": { "post": { "tags": [ "EmailTemplateGroup" ], "summary": "EmailTemplateGroup: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailTemplateGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailTemplateGroup_GetByValue_92B2A7A0677D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailTemplateGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailTemplateGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailTemplateGroup" } } } } } } }, "/api/EmailTemplateGroup/GetLookup": { "post": { "tags": [ "EmailTemplateGroup" ], "summary": "EmailTemplateGroup: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailTemplateGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailTemplateGroup_GetLookup_60DB5E13DF14", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/EmailTemplateGroup/GetLookupByValue": { "post": { "tags": [ "EmailTemplateGroup" ], "summary": "EmailTemplateGroup: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailTemplateGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailTemplateGroup_GetLookupByValue_3B69BC4C78DC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/EmailTemplateGroup/Page": { "get": { "tags": [ "EmailTemplateGroup" ], "summary": "EmailTemplateGroup: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailTemplateGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailTemplateGroup_GetPage_5E04E57D7B08", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmailTemplateGroup/PageAsc": { "get": { "tags": [ "EmailTemplateGroup" ], "summary": "EmailTemplateGroup: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailTemplateGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailTemplateGroup_GetPageAsc_A5738E11EBFD", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmailTemplateGroup/SearchByValue": { "post": { "tags": [ "EmailTemplateGroup" ], "summary": "EmailTemplateGroup: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailTemplateGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailTemplateGroup_SearchByValue_0E781A99912F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmailTemplateGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmailTemplateGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmailTemplateGroup" } } } } } } }, "/api/EmailTemplateGroup/TryGetByValue": { "post": { "tags": [ "EmailTemplateGroup" ], "summary": "EmailTemplateGroup: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailTemplateGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailTemplateGroup_TryGetByValue_1C5412A395C3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailTemplateGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailTemplateGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailTemplateGroup" } } } } } } }, "/api/EmailTemplateGroup/UpsertGraph": { "put": { "tags": [ "EmailTemplateGroup" ], "summary": "EmailTemplateGroup: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailTemplateGroup-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailTemplateGroup_UpsertGraph_FB2C7CE4CC86", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailTemplateGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailTemplateGroup" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailTemplateGroup" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailTemplateGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailTemplateGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailTemplateGroup" } } } } } } }, "/api/EmailTemplateGroup/UpsertGraphWithExtraFields": { "put": { "tags": [ "EmailTemplateGroup" ], "summary": "EmailTemplateGroup: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmailTemplateGroup-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmailTemplateGroup_UpsertGraphWithExtraFields_B3B791661586", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailTemplateGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailTemplateGroup" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailTemplateGroup" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailTemplateGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailTemplateGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailTemplateGroup" } } } } } } }, "/api/Employee": { "get": { "tags": [ "Employee" ], "summary": "Employee: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Employee-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Employee_GetAll_77CE5A5292F1", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Employee" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Employee" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Employee" } } } } } }, "post": { "tags": [ "Employee" ], "summary": "Employee: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Employee-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Employee_Post_80B7A20FDC85", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Employee" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Employee" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Employee" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Employee" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Employee" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Employee" } } } } } }, "put": { "tags": [ "Employee" ], "summary": "Employee: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Employee-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Employee_Put_57349AAE43E7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Employee" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Employee" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Employee" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Employee" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Employee" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Employee" } } } } } } }, "/api/Employee/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "Employee" ], "summary": "Employee: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Employee-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Employee_GetPageByValue_1ED51481BA2D", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Employee/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "Employee" ], "summary": "Employee: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Employee-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Employee_GetPageByValue2_B7A90934F85B", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Employee/DeleteByFilter": { "post": { "tags": [ "Employee" ], "summary": "Employee: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Employee-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Employee_DeleteByFilter_325005DF81F1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/Employee/GetAllByValue": { "post": { "tags": [ "Employee" ], "summary": "Employee: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Employee-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Employee_GetAllByValue_489BF699AD52", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Employee" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Employee" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Employee" } } } } } } }, "/api/Employee/GetAllGraphByValue": { "post": { "tags": [ "Employee" ], "summary": "Employee: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Employee-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Employee_GetAllGraphByValue_271881376B10", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Employee" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Employee" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Employee" } } } } } } }, "/api/Employee/GetByValue": { "post": { "tags": [ "Employee" ], "summary": "Employee: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Employee-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Employee_GetByValue_0D3AA625A339", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Employee" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Employee" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Employee" } } } } } } }, "/api/Employee/GetCalendarColors": { "get": { "tags": [ "Employee" ], "summary": "Employee: GetCalendarColors", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Employee-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Employee_GetCalendarColors_46CEF930E9E2", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmployeeCalendarColorDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmployeeCalendarColorDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmployeeCalendarColorDto" } } } } } } }, "/api/Employee/GetEmployeesUnlinkedWithUser": { "get": { "tags": [ "Employee" ], "summary": "Employee: GetEmployeesUnlinkedWithUser", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Employee-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Employee_GetEmployeesUnlinkedWithUser_5C775BBC7C92", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Employee" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Employee" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Employee" } } } } } } }, "/api/Employee/GetLoggedInEmployee": { "get": { "tags": [ "Employee" ], "summary": "Employee: GetLoggedInEmployee", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Employee-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Employee_GetLoggedInEmployee_8E1A4C8DB57E", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Employee" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Employee" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Employee" } } } } } } }, "/api/Employee/GetLoggedInEmployeeCalendarInfo": { "get": { "tags": [ "Employee" ], "summary": "Employee: GetLoggedInEmployeeCalendarInfo", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Employee-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Employee_GetLoggedInEmployeeCalendarInfo_54D8D3EBF7FE", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.LoggedInEmployeeCalendarDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.LoggedInEmployeeCalendarDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.LoggedInEmployeeCalendarDto" } } } } } } }, "/api/Employee/GetLoggedInEmployeeId": { "get": { "tags": [ "Employee" ], "summary": "Employee: GetLoggedInEmployeeId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Employee-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Employee_GetLoggedInEmployeeId_289C7BB0AD15", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.LoggedInEmployeeIdDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.LoggedInEmployeeIdDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.LoggedInEmployeeIdDto" } } } } } } }, "/api/Employee/GetLookup": { "post": { "tags": [ "Employee" ], "summary": "Employee: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Employee-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Employee_GetLookup_AFAF82A7F6BC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/Employee/GetLookupByValue": { "post": { "tags": [ "Employee" ], "summary": "Employee: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Employee-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Employee_GetLookupByValue_38AD16C36EC9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/Employee/Page": { "get": { "tags": [ "Employee" ], "summary": "Employee: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Employee-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Employee_GetPage_321EF9DE2C4C", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Employee/PageAsc": { "get": { "tags": [ "Employee" ], "summary": "Employee: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Employee-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Employee_GetPageAsc_E1D4F268C42F", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Employee/PageFromView/{GroupId}/{IncludeSubNodes}/{activeOnly}/{favoriteOnly}/{unlinkedWithUser}": { "get": { "tags": [ "Employee" ], "summary": "Employee: GetPageFromView", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Employee-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Employee_GetPageFromView_47F41C2644A0", "parameters": [ { "name": "GroupId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "IncludeSubNodes", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "activeOnly", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "favoriteOnly", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "unlinkedWithUser", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Employee/SearchByValue": { "post": { "tags": [ "Employee" ], "summary": "Employee: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Employee-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Employee_SearchByValue_1C6035713C17", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.Employee" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.Employee" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.Employee" } } } } } } }, "/api/Employee/SendTimeTrackingInvitation": { "post": { "tags": [ "Employee" ], "summary": "Employee: SendTimeTrackingInvitation", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Employee-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Employee_SendTimeTrackingInvitation_6A02F0989274", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Dto.EmployeeTimeTrackingInvitationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Dto.EmployeeTimeTrackingInvitationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Dto.EmployeeTimeTrackingInvitationRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dto.EmployeeTimeTrackingInvitationResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dto.EmployeeTimeTrackingInvitationResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dto.EmployeeTimeTrackingInvitationResult" } } } } } } }, "/api/Employee/TryGetByValue": { "post": { "tags": [ "Employee" ], "summary": "Employee: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Employee-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Employee_TryGetByValue_7BDA9DF1C385", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Employee" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Employee" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Employee" } } } } } } }, "/api/Employee/UpsertGraph": { "put": { "tags": [ "Employee" ], "summary": "Employee: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Employee-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Employee_UpsertGraph_E79678C0164F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Employee" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Employee" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Employee" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Employee" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Employee" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Employee" } } } } } } }, "/api/Employee/UpsertGraphWithExtraFields": { "put": { "tags": [ "Employee" ], "summary": "Employee: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Employee-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Employee_UpsertGraphWithExtraFields_A91EEC3F23AC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Employee" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Employee" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Employee" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Employee" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Employee" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Employee" } } } } } } }, "/api/EmployeeCommissionGroup": { "get": { "tags": [ "EmployeeCommissionGroup" ], "summary": "EmployeeCommissionGroup: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeCommissionGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeCommissionGroup_GetAll_276FB145646A", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmployeeCommissionGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmployeeCommissionGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmployeeCommissionGroup" } } } } } }, "post": { "tags": [ "EmployeeCommissionGroup" ], "summary": "EmployeeCommissionGroup: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeCommissionGroup-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeCommissionGroup_Post_0715ECBA1CB8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeCommissionGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeCommissionGroup" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeCommissionGroup" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeCommissionGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeCommissionGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeCommissionGroup" } } } } } }, "put": { "tags": [ "EmployeeCommissionGroup" ], "summary": "EmployeeCommissionGroup: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeCommissionGroup-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeCommissionGroup_Put_D7E508B4F676", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeCommissionGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeCommissionGroup" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeCommissionGroup" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeCommissionGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeCommissionGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeCommissionGroup" } } } } } } }, "/api/EmployeeCommissionGroup/{EmployeeCommissionGroupNameId}/PageFromView": { "get": { "tags": [ "EmployeeCommissionGroup" ], "summary": "EmployeeCommissionGroup: GetPageFromView", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeCommissionGroup-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeCommissionGroup_GetPageFromView_4880BE02D7C0", "parameters": [ { "name": "EmployeeCommissionGroupNameId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmployeeCommissionGroup/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "EmployeeCommissionGroup" ], "summary": "EmployeeCommissionGroup: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeCommissionGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeCommissionGroup_GetPageByValue_197012DFFA3F", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmployeeCommissionGroup/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "EmployeeCommissionGroup" ], "summary": "EmployeeCommissionGroup: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeCommissionGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeCommissionGroup_GetPageByValue2_E23FE5C05022", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmployeeCommissionGroup/DeleteByFilter": { "post": { "tags": [ "EmployeeCommissionGroup" ], "summary": "EmployeeCommissionGroup: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeCommissionGroup-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeCommissionGroup_DeleteByFilter_7EB83165158D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/EmployeeCommissionGroup/GetAllByValue": { "post": { "tags": [ "EmployeeCommissionGroup" ], "summary": "EmployeeCommissionGroup: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeCommissionGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeCommissionGroup_GetAllByValue_54A6D1D74B16", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmployeeCommissionGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmployeeCommissionGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmployeeCommissionGroup" } } } } } } }, "/api/EmployeeCommissionGroup/GetAllGraphByValue": { "post": { "tags": [ "EmployeeCommissionGroup" ], "summary": "EmployeeCommissionGroup: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeCommissionGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeCommissionGroup_GetAllGraphByValue_3655AC09026E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmployeeCommissionGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmployeeCommissionGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmployeeCommissionGroup" } } } } } } }, "/api/EmployeeCommissionGroup/GetByValue": { "post": { "tags": [ "EmployeeCommissionGroup" ], "summary": "EmployeeCommissionGroup: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeCommissionGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeCommissionGroup_GetByValue_34E9239EFA89", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeCommissionGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeCommissionGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeCommissionGroup" } } } } } } }, "/api/EmployeeCommissionGroup/GetLookup": { "post": { "tags": [ "EmployeeCommissionGroup" ], "summary": "EmployeeCommissionGroup: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeCommissionGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeCommissionGroup_GetLookup_955929E894CA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/EmployeeCommissionGroup/GetLookupByValue": { "post": { "tags": [ "EmployeeCommissionGroup" ], "summary": "EmployeeCommissionGroup: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeCommissionGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeCommissionGroup_GetLookupByValue_0CAFC6E56FF4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/EmployeeCommissionGroup/Page": { "get": { "tags": [ "EmployeeCommissionGroup" ], "summary": "EmployeeCommissionGroup: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeCommissionGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeCommissionGroup_GetPage_523FE34C098F", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmployeeCommissionGroup/PageAsc": { "get": { "tags": [ "EmployeeCommissionGroup" ], "summary": "EmployeeCommissionGroup: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeCommissionGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeCommissionGroup_GetPageAsc_CB159ACA85A2", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmployeeCommissionGroup/SearchByValue": { "post": { "tags": [ "EmployeeCommissionGroup" ], "summary": "EmployeeCommissionGroup: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeCommissionGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeCommissionGroup_SearchByValue_516AE63CE18C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmployeeCommissionGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmployeeCommissionGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmployeeCommissionGroup" } } } } } } }, "/api/EmployeeCommissionGroup/TryGetByValue": { "post": { "tags": [ "EmployeeCommissionGroup" ], "summary": "EmployeeCommissionGroup: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeCommissionGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeCommissionGroup_TryGetByValue_1765CC8EEC99", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeCommissionGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeCommissionGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeCommissionGroup" } } } } } } }, "/api/EmployeeCommissionGroup/UpsertGraph": { "put": { "tags": [ "EmployeeCommissionGroup" ], "summary": "EmployeeCommissionGroup: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeCommissionGroup-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeCommissionGroup_UpsertGraph_1406E53FF9DB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeCommissionGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeCommissionGroup" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeCommissionGroup" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeCommissionGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeCommissionGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeCommissionGroup" } } } } } } }, "/api/EmployeeCommissionGroup/UpsertGraphWithExtraFields": { "put": { "tags": [ "EmployeeCommissionGroup" ], "summary": "EmployeeCommissionGroup: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeCommissionGroup-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeCommissionGroup_UpsertGraphWithExtraFields_63EFDE4AFE61", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmployeeCommissionGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmployeeCommissionGroup" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmployeeCommissionGroup" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmployeeCommissionGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmployeeCommissionGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmployeeCommissionGroup" } } } } } } }, "/api/EmployeeCommissionGroupName": { "get": { "tags": [ "EmployeeCommissionGroupName" ], "summary": "EmployeeCommissionGroupName: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeCommissionGroupName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeCommissionGroupName_GetAll_ADA5059657BF", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmployeeCommissionGroupName" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmployeeCommissionGroupName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmployeeCommissionGroupName" } } } } } }, "post": { "tags": [ "EmployeeCommissionGroupName" ], "summary": "EmployeeCommissionGroupName: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeCommissionGroupName-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeCommissionGroupName_Post_6D7F9813163A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeCommissionGroupName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeCommissionGroupName" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeCommissionGroupName" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeCommissionGroupName" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeCommissionGroupName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeCommissionGroupName" } } } } } }, "put": { "tags": [ "EmployeeCommissionGroupName" ], "summary": "EmployeeCommissionGroupName: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeCommissionGroupName-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeCommissionGroupName_Put_ECCF284DD4FB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeCommissionGroupName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeCommissionGroupName" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeCommissionGroupName" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeCommissionGroupName" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeCommissionGroupName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeCommissionGroupName" } } } } } } }, "/api/EmployeeCommissionGroupName/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "EmployeeCommissionGroupName" ], "summary": "EmployeeCommissionGroupName: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeCommissionGroupName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeCommissionGroupName_GetPageByValue_66B3211473A2", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmployeeCommissionGroupName/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "EmployeeCommissionGroupName" ], "summary": "EmployeeCommissionGroupName: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeCommissionGroupName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeCommissionGroupName_GetPageByValue2_ECD1870C08FD", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmployeeCommissionGroupName/DeleteByFilter": { "post": { "tags": [ "EmployeeCommissionGroupName" ], "summary": "EmployeeCommissionGroupName: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeCommissionGroupName-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeCommissionGroupName_DeleteByFilter_5EE5C63BFB73", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/EmployeeCommissionGroupName/GetAllByValue": { "post": { "tags": [ "EmployeeCommissionGroupName" ], "summary": "EmployeeCommissionGroupName: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeCommissionGroupName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeCommissionGroupName_GetAllByValue_5AC8408F214A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmployeeCommissionGroupName" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmployeeCommissionGroupName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmployeeCommissionGroupName" } } } } } } }, "/api/EmployeeCommissionGroupName/GetAllGraphByValue": { "post": { "tags": [ "EmployeeCommissionGroupName" ], "summary": "EmployeeCommissionGroupName: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeCommissionGroupName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeCommissionGroupName_GetAllGraphByValue_ADF4B1F046AE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmployeeCommissionGroupName" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmployeeCommissionGroupName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmployeeCommissionGroupName" } } } } } } }, "/api/EmployeeCommissionGroupName/GetByValue": { "post": { "tags": [ "EmployeeCommissionGroupName" ], "summary": "EmployeeCommissionGroupName: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeCommissionGroupName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeCommissionGroupName_GetByValue_66677415C278", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeCommissionGroupName" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeCommissionGroupName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeCommissionGroupName" } } } } } } }, "/api/EmployeeCommissionGroupName/GetLookup": { "post": { "tags": [ "EmployeeCommissionGroupName" ], "summary": "EmployeeCommissionGroupName: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeCommissionGroupName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeCommissionGroupName_GetLookup_28323047F434", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/EmployeeCommissionGroupName/GetLookupByValue": { "post": { "tags": [ "EmployeeCommissionGroupName" ], "summary": "EmployeeCommissionGroupName: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeCommissionGroupName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeCommissionGroupName_GetLookupByValue_B3ECBD2C4842", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/EmployeeCommissionGroupName/Page": { "get": { "tags": [ "EmployeeCommissionGroupName" ], "summary": "EmployeeCommissionGroupName: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeCommissionGroupName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeCommissionGroupName_GetPage_E4A85155E94B", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmployeeCommissionGroupName/PageAsc": { "get": { "tags": [ "EmployeeCommissionGroupName" ], "summary": "EmployeeCommissionGroupName: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeCommissionGroupName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeCommissionGroupName_GetPageAsc_8495840C73A1", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmployeeCommissionGroupName/SearchByValue": { "post": { "tags": [ "EmployeeCommissionGroupName" ], "summary": "EmployeeCommissionGroupName: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeCommissionGroupName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeCommissionGroupName_SearchByValue_119C6623FAAF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmployeeCommissionGroupName" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmployeeCommissionGroupName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmployeeCommissionGroupName" } } } } } } }, "/api/EmployeeCommissionGroupName/TryGetByValue": { "post": { "tags": [ "EmployeeCommissionGroupName" ], "summary": "EmployeeCommissionGroupName: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeCommissionGroupName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeCommissionGroupName_TryGetByValue_8A18E315993F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeCommissionGroupName" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeCommissionGroupName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeCommissionGroupName" } } } } } } }, "/api/EmployeeCommissionGroupName/UpsertGraph": { "put": { "tags": [ "EmployeeCommissionGroupName" ], "summary": "EmployeeCommissionGroupName: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeCommissionGroupName-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeCommissionGroupName_UpsertGraph_98506EE6AB29", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeCommissionGroupName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeCommissionGroupName" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeCommissionGroupName" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeCommissionGroupName" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeCommissionGroupName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeCommissionGroupName" } } } } } } }, "/api/EmployeeCommissionGroupName/UpsertGraphWithExtraFields": { "put": { "tags": [ "EmployeeCommissionGroupName" ], "summary": "EmployeeCommissionGroupName: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeCommissionGroupName-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeCommissionGroupName_UpsertGraphWithExtraFields_10239625CC3E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmployeeCommissionGroupName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmployeeCommissionGroupName" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmployeeCommissionGroupName" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmployeeCommissionGroupName" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmployeeCommissionGroupName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmployeeCommissionGroupName" } } } } } } }, "/api/EmployeeGroup": { "get": { "tags": [ "EmployeeGroup" ], "summary": "EmployeeGroup: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeGroup_GetAll_D349D615CF30", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmployeeGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmployeeGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmployeeGroup" } } } } } }, "post": { "tags": [ "EmployeeGroup" ], "summary": "EmployeeGroup: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeGroup-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeGroup_Post_CBEECD5C46EF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeGroup" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeGroup" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeGroup" } } } } } }, "put": { "tags": [ "EmployeeGroup" ], "summary": "EmployeeGroup: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeGroup-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeGroup_Put_AB02E9D80BB8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeGroup" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeGroup" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeGroup" } } } } } } }, "/api/EmployeeGroup/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "EmployeeGroup" ], "summary": "EmployeeGroup: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeGroup_GetPageByValue_AC7D426B9D4E", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmployeeGroup/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "EmployeeGroup" ], "summary": "EmployeeGroup: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeGroup_GetPageByValue2_853F8E3EC5FB", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmployeeGroup/DeleteByFilter": { "post": { "tags": [ "EmployeeGroup" ], "summary": "EmployeeGroup: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeGroup-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeGroup_DeleteByFilter_C4BA90E247B4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/EmployeeGroup/GetAllByValue": { "post": { "tags": [ "EmployeeGroup" ], "summary": "EmployeeGroup: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeGroup_GetAllByValue_1D07F466D9FE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmployeeGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmployeeGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmployeeGroup" } } } } } } }, "/api/EmployeeGroup/GetAllGraphByValue": { "post": { "tags": [ "EmployeeGroup" ], "summary": "EmployeeGroup: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeGroup_GetAllGraphByValue_17D721CE677A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmployeeGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmployeeGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmployeeGroup" } } } } } } }, "/api/EmployeeGroup/GetByValue": { "post": { "tags": [ "EmployeeGroup" ], "summary": "EmployeeGroup: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeGroup_GetByValue_AF4CD3EFC845", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeGroup" } } } } } } }, "/api/EmployeeGroup/GetLookup": { "post": { "tags": [ "EmployeeGroup" ], "summary": "EmployeeGroup: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeGroup_GetLookup_AE6CF94C1DFA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/EmployeeGroup/GetLookupByValue": { "post": { "tags": [ "EmployeeGroup" ], "summary": "EmployeeGroup: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeGroup_GetLookupByValue_5C70B70C3C12", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/EmployeeGroup/Page": { "get": { "tags": [ "EmployeeGroup" ], "summary": "EmployeeGroup: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeGroup_GetPage_BF9B9E83D934", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmployeeGroup/PageAsc": { "get": { "tags": [ "EmployeeGroup" ], "summary": "EmployeeGroup: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeGroup_GetPageAsc_A0473B69085C", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmployeeGroup/PageEmployeeGroupsByParent/{ParentId}/{IncludeSubNodes}/{TopParentsOnly}": { "get": { "tags": [ "EmployeeGroup" ], "summary": "EmployeeGroup: GetPageEmployeeGroupsByParent", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeGroup-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeGroup_GetPageEmployeeGroupsByParent_5B14F8E774C2", "parameters": [ { "name": "ParentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "IncludeSubNodes", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "TopParentsOnly", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmployeeGroup/SearchByValue": { "post": { "tags": [ "EmployeeGroup" ], "summary": "EmployeeGroup: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeGroup_SearchByValue_A63B72E895E9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmployeeGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmployeeGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmployeeGroup" } } } } } } }, "/api/EmployeeGroup/TryGetByValue": { "post": { "tags": [ "EmployeeGroup" ], "summary": "EmployeeGroup: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeGroup_TryGetByValue_729A5C9D8989", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeGroup" } } } } } } }, "/api/EmployeeGroup/UpsertGraph": { "put": { "tags": [ "EmployeeGroup" ], "summary": "EmployeeGroup: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeGroup-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeGroup_UpsertGraph_760B289A4456", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeGroup" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeGroup" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeGroup" } } } } } } }, "/api/EmployeeGroup/UpsertGraphWithExtraFields": { "put": { "tags": [ "EmployeeGroup" ], "summary": "EmployeeGroup: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeGroup-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeGroup_UpsertGraphWithExtraFields_DE01D4E66F41", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmployeeGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmployeeGroup" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmployeeGroup" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmployeeGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmployeeGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmployeeGroup" } } } } } } }, "/api/EmployeeVacationEntitlement": { "get": { "tags": [ "EmployeeVacationEntitlement" ], "summary": "EmployeeVacationEntitlement: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeVacationEntitlement-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeVacationEntitlement_GetAll_1351B48ABF72", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmployeeVacationEntitlement" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmployeeVacationEntitlement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmployeeVacationEntitlement" } } } } } }, "post": { "tags": [ "EmployeeVacationEntitlement" ], "summary": "EmployeeVacationEntitlement: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeVacationEntitlement-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeVacationEntitlement_Post_86517D20FDBB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeVacationEntitlement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeVacationEntitlement" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeVacationEntitlement" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeVacationEntitlement" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeVacationEntitlement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeVacationEntitlement" } } } } } }, "put": { "tags": [ "EmployeeVacationEntitlement" ], "summary": "EmployeeVacationEntitlement: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeVacationEntitlement-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeVacationEntitlement_Put_C29B9E27F562", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeVacationEntitlement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeVacationEntitlement" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeVacationEntitlement" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeVacationEntitlement" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeVacationEntitlement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeVacationEntitlement" } } } } } } }, "/api/EmployeeVacationEntitlement/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "EmployeeVacationEntitlement" ], "summary": "EmployeeVacationEntitlement: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeVacationEntitlement-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeVacationEntitlement_GetPageByValue_1352F6D0B262", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmployeeVacationEntitlement/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "EmployeeVacationEntitlement" ], "summary": "EmployeeVacationEntitlement: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeVacationEntitlement-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeVacationEntitlement_GetPageByValue2_44938D8BD4FC", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmployeeVacationEntitlement/DeleteByFilter": { "post": { "tags": [ "EmployeeVacationEntitlement" ], "summary": "EmployeeVacationEntitlement: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeVacationEntitlement-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeVacationEntitlement_DeleteByFilter_0B600E940314", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/EmployeeVacationEntitlement/GetAllByValue": { "post": { "tags": [ "EmployeeVacationEntitlement" ], "summary": "EmployeeVacationEntitlement: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeVacationEntitlement-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeVacationEntitlement_GetAllByValue_21669881FF2B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmployeeVacationEntitlement" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmployeeVacationEntitlement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmployeeVacationEntitlement" } } } } } } }, "/api/EmployeeVacationEntitlement/GetAllGraphByValue": { "post": { "tags": [ "EmployeeVacationEntitlement" ], "summary": "EmployeeVacationEntitlement: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeVacationEntitlement-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeVacationEntitlement_GetAllGraphByValue_22A1A53D10DE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmployeeVacationEntitlement" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmployeeVacationEntitlement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmployeeVacationEntitlement" } } } } } } }, "/api/EmployeeVacationEntitlement/GetByValue": { "post": { "tags": [ "EmployeeVacationEntitlement" ], "summary": "EmployeeVacationEntitlement: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeVacationEntitlement-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeVacationEntitlement_GetByValue_0FE6DC394C04", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeVacationEntitlement" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeVacationEntitlement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeVacationEntitlement" } } } } } } }, "/api/EmployeeVacationEntitlement/GetLookup": { "post": { "tags": [ "EmployeeVacationEntitlement" ], "summary": "EmployeeVacationEntitlement: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeVacationEntitlement-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeVacationEntitlement_GetLookup_66DD79F70AC6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/EmployeeVacationEntitlement/GetLookupByValue": { "post": { "tags": [ "EmployeeVacationEntitlement" ], "summary": "EmployeeVacationEntitlement: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeVacationEntitlement-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeVacationEntitlement_GetLookupByValue_58F9C572E073", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/EmployeeVacationEntitlement/Page": { "get": { "tags": [ "EmployeeVacationEntitlement" ], "summary": "EmployeeVacationEntitlement: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeVacationEntitlement-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeVacationEntitlement_GetPage_83B013A2D839", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmployeeVacationEntitlement/PageAsc": { "get": { "tags": [ "EmployeeVacationEntitlement" ], "summary": "EmployeeVacationEntitlement: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeVacationEntitlement-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeVacationEntitlement_GetPageAsc_CF2A56067344", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmployeeVacationEntitlement/SearchByValue": { "post": { "tags": [ "EmployeeVacationEntitlement" ], "summary": "EmployeeVacationEntitlement: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeVacationEntitlement-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeVacationEntitlement_SearchByValue_C2D5461237B7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmployeeVacationEntitlement" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmployeeVacationEntitlement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmployeeVacationEntitlement" } } } } } } }, "/api/EmployeeVacationEntitlement/TryGetByValue": { "post": { "tags": [ "EmployeeVacationEntitlement" ], "summary": "EmployeeVacationEntitlement: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeVacationEntitlement-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeVacationEntitlement_TryGetByValue_4FA825BF677E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeVacationEntitlement" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeVacationEntitlement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeVacationEntitlement" } } } } } } }, "/api/EmployeeVacationEntitlement/UpsertGraph": { "put": { "tags": [ "EmployeeVacationEntitlement" ], "summary": "EmployeeVacationEntitlement: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeVacationEntitlement-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeVacationEntitlement_UpsertGraph_330D77F55946", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeVacationEntitlement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeVacationEntitlement" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeVacationEntitlement" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeVacationEntitlement" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeVacationEntitlement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeVacationEntitlement" } } } } } } }, "/api/EmployeeVacationEntitlement/UpsertGraphWithExtraFields": { "put": { "tags": [ "EmployeeVacationEntitlement" ], "summary": "EmployeeVacationEntitlement: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeVacationEntitlement-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeVacationEntitlement_UpsertGraphWithExtraFields_5C61DBF5CC3B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmployeeVacationEntitlement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmployeeVacationEntitlement" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmployeeVacationEntitlement" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmployeeVacationEntitlement" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmployeeVacationEntitlement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmployeeVacationEntitlement" } } } } } } }, "/api/EmployeeVacationRequest": { "get": { "tags": [ "EmployeeVacationRequest" ], "summary": "EmployeeVacationRequest: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeVacationRequest-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeVacationRequest_GetAll_74ED7155B589", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmployeeVacationRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmployeeVacationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmployeeVacationRequest" } } } } } }, "post": { "tags": [ "EmployeeVacationRequest" ], "summary": "EmployeeVacationRequest: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeVacationRequest-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeVacationRequest_Post_D93393802AA8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeVacationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeVacationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeVacationRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeVacationRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeVacationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeVacationRequest" } } } } } }, "put": { "tags": [ "EmployeeVacationRequest" ], "summary": "EmployeeVacationRequest: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeVacationRequest-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeVacationRequest_Put_F1B3530A0727", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeVacationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeVacationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeVacationRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeVacationRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeVacationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeVacationRequest" } } } } } } }, "/api/EmployeeVacationRequest/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "EmployeeVacationRequest" ], "summary": "EmployeeVacationRequest: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeVacationRequest-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeVacationRequest_GetPageByValue_9D3F13FEC1DF", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmployeeVacationRequest/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "EmployeeVacationRequest" ], "summary": "EmployeeVacationRequest: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeVacationRequest-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeVacationRequest_GetPageByValue2_B58228CA083E", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmployeeVacationRequest/DeleteByFilter": { "post": { "tags": [ "EmployeeVacationRequest" ], "summary": "EmployeeVacationRequest: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeVacationRequest-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeVacationRequest_DeleteByFilter_4A8FDFC57528", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/EmployeeVacationRequest/GetAllByValue": { "post": { "tags": [ "EmployeeVacationRequest" ], "summary": "EmployeeVacationRequest: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeVacationRequest-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeVacationRequest_GetAllByValue_81CD559865A6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmployeeVacationRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmployeeVacationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmployeeVacationRequest" } } } } } } }, "/api/EmployeeVacationRequest/GetAllGraphByValue": { "post": { "tags": [ "EmployeeVacationRequest" ], "summary": "EmployeeVacationRequest: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeVacationRequest-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeVacationRequest_GetAllGraphByValue_5710F2B89529", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmployeeVacationRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmployeeVacationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmployeeVacationRequest" } } } } } } }, "/api/EmployeeVacationRequest/GetByValue": { "post": { "tags": [ "EmployeeVacationRequest" ], "summary": "EmployeeVacationRequest: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeVacationRequest-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeVacationRequest_GetByValue_CF42FCFC6B5A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeVacationRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeVacationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeVacationRequest" } } } } } } }, "/api/EmployeeVacationRequest/GetLookup": { "post": { "tags": [ "EmployeeVacationRequest" ], "summary": "EmployeeVacationRequest: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeVacationRequest-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeVacationRequest_GetLookup_E1EBE2A8DCC2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/EmployeeVacationRequest/GetLookupByValue": { "post": { "tags": [ "EmployeeVacationRequest" ], "summary": "EmployeeVacationRequest: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeVacationRequest-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeVacationRequest_GetLookupByValue_166C78022706", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/EmployeeVacationRequest/Page": { "get": { "tags": [ "EmployeeVacationRequest" ], "summary": "EmployeeVacationRequest: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeVacationRequest-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeVacationRequest_GetPage_3B0C3B01B495", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmployeeVacationRequest/PageAsc": { "get": { "tags": [ "EmployeeVacationRequest" ], "summary": "EmployeeVacationRequest: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeVacationRequest-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeVacationRequest_GetPageAsc_13CE773F8359", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmployeeVacationRequest/SearchByValue": { "post": { "tags": [ "EmployeeVacationRequest" ], "summary": "EmployeeVacationRequest: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeVacationRequest-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeVacationRequest_SearchByValue_340C87CBA7B5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmployeeVacationRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmployeeVacationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmployeeVacationRequest" } } } } } } }, "/api/EmployeeVacationRequest/TryGetByValue": { "post": { "tags": [ "EmployeeVacationRequest" ], "summary": "EmployeeVacationRequest: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeVacationRequest-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeVacationRequest_TryGetByValue_DBA6D858425E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeVacationRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeVacationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeVacationRequest" } } } } } } }, "/api/EmployeeVacationRequest/UpsertGraph": { "put": { "tags": [ "EmployeeVacationRequest" ], "summary": "EmployeeVacationRequest: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeVacationRequest-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeVacationRequest_UpsertGraph_9318CAAE19BD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeVacationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeVacationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeVacationRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeVacationRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeVacationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeVacationRequest" } } } } } } }, "/api/EmployeeVacationRequest/UpsertGraphWithExtraFields": { "put": { "tags": [ "EmployeeVacationRequest" ], "summary": "EmployeeVacationRequest: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeVacationRequest-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeVacationRequest_UpsertGraphWithExtraFields_F9EBCAF3EFBE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmployeeVacationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmployeeVacationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmployeeVacationRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmployeeVacationRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmployeeVacationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmployeeVacationRequest" } } } } } } }, "/api/EmployeeVacationRequestApproval": { "get": { "tags": [ "EmployeeVacationRequestApproval" ], "summary": "EmployeeVacationRequestApproval: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeVacationRequestApproval-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeVacationRequestApproval_GetAll_CDA46F2F7ED7", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmployeeVacationRequestApproval" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmployeeVacationRequestApproval" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmployeeVacationRequestApproval" } } } } } }, "post": { "tags": [ "EmployeeVacationRequestApproval" ], "summary": "EmployeeVacationRequestApproval: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeVacationRequestApproval-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeVacationRequestApproval_Post_3010166CAB28", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeVacationRequestApproval" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeVacationRequestApproval" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeVacationRequestApproval" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeVacationRequestApproval" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeVacationRequestApproval" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeVacationRequestApproval" } } } } } }, "put": { "tags": [ "EmployeeVacationRequestApproval" ], "summary": "EmployeeVacationRequestApproval: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeVacationRequestApproval-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeVacationRequestApproval_Put_67002C49607A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeVacationRequestApproval" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeVacationRequestApproval" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeVacationRequestApproval" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeVacationRequestApproval" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeVacationRequestApproval" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeVacationRequestApproval" } } } } } } }, "/api/EmployeeVacationRequestApproval/{employeeVacationRequestId}/PageFromViewByEmployeeVacationRequestId": { "get": { "tags": [ "EmployeeVacationRequestApproval" ], "summary": "EmployeeVacationRequestApproval: GetPageFromViewByEmployeeVacationRequestId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeVacationRequestApproval-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeVacationRequestApproval_GetPageFromViewByEmployeeVacationRequestId_7981FD798297", "parameters": [ { "name": "employeeVacationRequestId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmployeeVacationRequestApproval/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "EmployeeVacationRequestApproval" ], "summary": "EmployeeVacationRequestApproval: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeVacationRequestApproval-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeVacationRequestApproval_GetPageByValue_5EC91AF91BB6", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmployeeVacationRequestApproval/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "EmployeeVacationRequestApproval" ], "summary": "EmployeeVacationRequestApproval: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeVacationRequestApproval-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeVacationRequestApproval_GetPageByValue2_30532DE2D4C8", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmployeeVacationRequestApproval/DeleteByFilter": { "post": { "tags": [ "EmployeeVacationRequestApproval" ], "summary": "EmployeeVacationRequestApproval: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeVacationRequestApproval-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeVacationRequestApproval_DeleteByFilter_603C8DE9D3D7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/EmployeeVacationRequestApproval/GetAllByValue": { "post": { "tags": [ "EmployeeVacationRequestApproval" ], "summary": "EmployeeVacationRequestApproval: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeVacationRequestApproval-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeVacationRequestApproval_GetAllByValue_74B629423A13", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmployeeVacationRequestApproval" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmployeeVacationRequestApproval" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmployeeVacationRequestApproval" } } } } } } }, "/api/EmployeeVacationRequestApproval/GetAllGraphByValue": { "post": { "tags": [ "EmployeeVacationRequestApproval" ], "summary": "EmployeeVacationRequestApproval: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeVacationRequestApproval-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeVacationRequestApproval_GetAllGraphByValue_954AE2AD4501", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmployeeVacationRequestApproval" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmployeeVacationRequestApproval" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmployeeVacationRequestApproval" } } } } } } }, "/api/EmployeeVacationRequestApproval/GetByValue": { "post": { "tags": [ "EmployeeVacationRequestApproval" ], "summary": "EmployeeVacationRequestApproval: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeVacationRequestApproval-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeVacationRequestApproval_GetByValue_8A47BF614560", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeVacationRequestApproval" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeVacationRequestApproval" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeVacationRequestApproval" } } } } } } }, "/api/EmployeeVacationRequestApproval/GetLookup": { "post": { "tags": [ "EmployeeVacationRequestApproval" ], "summary": "EmployeeVacationRequestApproval: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeVacationRequestApproval-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeVacationRequestApproval_GetLookup_2B5DC4B6A414", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/EmployeeVacationRequestApproval/GetLookupByValue": { "post": { "tags": [ "EmployeeVacationRequestApproval" ], "summary": "EmployeeVacationRequestApproval: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeVacationRequestApproval-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeVacationRequestApproval_GetLookupByValue_D580EBB63A26", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/EmployeeVacationRequestApproval/Page": { "get": { "tags": [ "EmployeeVacationRequestApproval" ], "summary": "EmployeeVacationRequestApproval: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeVacationRequestApproval-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeVacationRequestApproval_GetPage_B14766641E29", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmployeeVacationRequestApproval/PageAsc": { "get": { "tags": [ "EmployeeVacationRequestApproval" ], "summary": "EmployeeVacationRequestApproval: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeVacationRequestApproval-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeVacationRequestApproval_GetPageAsc_64B12BD6FCFF", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmployeeVacationRequestApproval/SearchByValue": { "post": { "tags": [ "EmployeeVacationRequestApproval" ], "summary": "EmployeeVacationRequestApproval: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeVacationRequestApproval-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeVacationRequestApproval_SearchByValue_2704F3375796", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmployeeVacationRequestApproval" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmployeeVacationRequestApproval" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmployeeVacationRequestApproval" } } } } } } }, "/api/EmployeeVacationRequestApproval/TryGetByValue": { "post": { "tags": [ "EmployeeVacationRequestApproval" ], "summary": "EmployeeVacationRequestApproval: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeVacationRequestApproval-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeVacationRequestApproval_TryGetByValue_754C406A34ED", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeVacationRequestApproval" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeVacationRequestApproval" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeVacationRequestApproval" } } } } } } }, "/api/EmployeeVacationRequestApproval/UpsertGraph": { "put": { "tags": [ "EmployeeVacationRequestApproval" ], "summary": "EmployeeVacationRequestApproval: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeVacationRequestApproval-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeVacationRequestApproval_UpsertGraph_FE4A1A9737E4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeVacationRequestApproval" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeVacationRequestApproval" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeVacationRequestApproval" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeVacationRequestApproval" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeVacationRequestApproval" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeVacationRequestApproval" } } } } } } }, "/api/EmployeeVacationRequestApproval/UpsertGraphWithExtraFields": { "put": { "tags": [ "EmployeeVacationRequestApproval" ], "summary": "EmployeeVacationRequestApproval: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeVacationRequestApproval-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeVacationRequestApproval_UpsertGraphWithExtraFields_35ED82FD849D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmployeeVacationRequestApproval" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmployeeVacationRequestApproval" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmployeeVacationRequestApproval" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmployeeVacationRequestApproval" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmployeeVacationRequestApproval" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmployeeVacationRequestApproval" } } } } } } }, "/api/EmployeeVacationType": { "get": { "tags": [ "EmployeeVacationType" ], "summary": "EmployeeVacationType: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeVacationType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeVacationType_GetAll_9CB5B947299E", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmployeeVacationType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmployeeVacationType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmployeeVacationType" } } } } } }, "post": { "tags": [ "EmployeeVacationType" ], "summary": "EmployeeVacationType: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeVacationType-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeVacationType_Post_80A0D97C1332", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeVacationType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeVacationType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeVacationType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeVacationType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeVacationType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeVacationType" } } } } } }, "put": { "tags": [ "EmployeeVacationType" ], "summary": "EmployeeVacationType: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeVacationType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeVacationType_Put_9F3EBC6EACD9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeVacationType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeVacationType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeVacationType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeVacationType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeVacationType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeVacationType" } } } } } } }, "/api/EmployeeVacationType/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "EmployeeVacationType" ], "summary": "EmployeeVacationType: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeVacationType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeVacationType_GetPageByValue_E79A66BE56E6", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmployeeVacationType/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "EmployeeVacationType" ], "summary": "EmployeeVacationType: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeVacationType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeVacationType_GetPageByValue2_707ED0EBDA28", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmployeeVacationType/DeleteByFilter": { "post": { "tags": [ "EmployeeVacationType" ], "summary": "EmployeeVacationType: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeVacationType-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeVacationType_DeleteByFilter_2B2494076208", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/EmployeeVacationType/GetAllByValue": { "post": { "tags": [ "EmployeeVacationType" ], "summary": "EmployeeVacationType: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeVacationType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeVacationType_GetAllByValue_477242927EB6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmployeeVacationType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmployeeVacationType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmployeeVacationType" } } } } } } }, "/api/EmployeeVacationType/GetAllGraphByValue": { "post": { "tags": [ "EmployeeVacationType" ], "summary": "EmployeeVacationType: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeVacationType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeVacationType_GetAllGraphByValue_B8A51707DB4A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmployeeVacationType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmployeeVacationType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmployeeVacationType" } } } } } } }, "/api/EmployeeVacationType/GetByValue": { "post": { "tags": [ "EmployeeVacationType" ], "summary": "EmployeeVacationType: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeVacationType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeVacationType_GetByValue_2FFCCEAB9785", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeVacationType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeVacationType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeVacationType" } } } } } } }, "/api/EmployeeVacationType/GetLookup": { "post": { "tags": [ "EmployeeVacationType" ], "summary": "EmployeeVacationType: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeVacationType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeVacationType_GetLookup_7D148B85D29E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/EmployeeVacationType/GetLookupByValue": { "post": { "tags": [ "EmployeeVacationType" ], "summary": "EmployeeVacationType: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeVacationType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeVacationType_GetLookupByValue_10C4188C7BF1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/EmployeeVacationType/Page": { "get": { "tags": [ "EmployeeVacationType" ], "summary": "EmployeeVacationType: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeVacationType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeVacationType_GetPage_F86F8F7CB98E", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmployeeVacationType/PageAsc": { "get": { "tags": [ "EmployeeVacationType" ], "summary": "EmployeeVacationType: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeVacationType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeVacationType_GetPageAsc_70DDE75EACC6", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmployeeVacationType/SearchByValue": { "post": { "tags": [ "EmployeeVacationType" ], "summary": "EmployeeVacationType: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeVacationType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeVacationType_SearchByValue_649AC35DDBB3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmployeeVacationType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmployeeVacationType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmployeeVacationType" } } } } } } }, "/api/EmployeeVacationType/TryGetByValue": { "post": { "tags": [ "EmployeeVacationType" ], "summary": "EmployeeVacationType: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeVacationType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeVacationType_TryGetByValue_40C12466268D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeVacationType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeVacationType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeVacationType" } } } } } } }, "/api/EmployeeVacationType/UpsertGraph": { "put": { "tags": [ "EmployeeVacationType" ], "summary": "EmployeeVacationType: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeVacationType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeVacationType_UpsertGraph_B91C0DC33DD9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeVacationType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeVacationType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeVacationType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeVacationType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeVacationType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeVacationType" } } } } } } }, "/api/EmployeeVacationType/UpsertGraphWithExtraFields": { "put": { "tags": [ "EmployeeVacationType" ], "summary": "EmployeeVacationType: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeVacationType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeVacationType_UpsertGraphWithExtraFields_A00E9896F0BF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmployeeVacationType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmployeeVacationType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmployeeVacationType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmployeeVacationType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmployeeVacationType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmployeeVacationType" } } } } } } }, "/api/EmployeeVacationYear": { "get": { "tags": [ "EmployeeVacationYear" ], "summary": "EmployeeVacationYear: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeVacationYear-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeVacationYear_GetAll_BEEA86D5DF0D", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmployeeVacationYear" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmployeeVacationYear" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmployeeVacationYear" } } } } } }, "post": { "tags": [ "EmployeeVacationYear" ], "summary": "EmployeeVacationYear: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeVacationYear-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeVacationYear_Post_0B6EC7999BD9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeVacationYear" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeVacationYear" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeVacationYear" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeVacationYear" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeVacationYear" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeVacationYear" } } } } } }, "put": { "tags": [ "EmployeeVacationYear" ], "summary": "EmployeeVacationYear: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeVacationYear-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeVacationYear_Put_CA723F7E90F0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeVacationYear" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeVacationYear" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeVacationYear" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeVacationYear" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeVacationYear" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeVacationYear" } } } } } } }, "/api/EmployeeVacationYear/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "EmployeeVacationYear" ], "summary": "EmployeeVacationYear: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeVacationYear-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeVacationYear_GetPageByValue_9D01138EF115", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmployeeVacationYear/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "EmployeeVacationYear" ], "summary": "EmployeeVacationYear: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeVacationYear-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeVacationYear_GetPageByValue2_7EFF7D220217", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmployeeVacationYear/DeleteByFilter": { "post": { "tags": [ "EmployeeVacationYear" ], "summary": "EmployeeVacationYear: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeVacationYear-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeVacationYear_DeleteByFilter_6629DB849D98", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/EmployeeVacationYear/GetAllByValue": { "post": { "tags": [ "EmployeeVacationYear" ], "summary": "EmployeeVacationYear: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeVacationYear-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeVacationYear_GetAllByValue_EDE5A61926FB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmployeeVacationYear" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmployeeVacationYear" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmployeeVacationYear" } } } } } } }, "/api/EmployeeVacationYear/GetAllGraphByValue": { "post": { "tags": [ "EmployeeVacationYear" ], "summary": "EmployeeVacationYear: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeVacationYear-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeVacationYear_GetAllGraphByValue_079564DF4BA5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmployeeVacationYear" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmployeeVacationYear" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmployeeVacationYear" } } } } } } }, "/api/EmployeeVacationYear/GetByValue": { "post": { "tags": [ "EmployeeVacationYear" ], "summary": "EmployeeVacationYear: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeVacationYear-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeVacationYear_GetByValue_9C8C67005682", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeVacationYear" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeVacationYear" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeVacationYear" } } } } } } }, "/api/EmployeeVacationYear/GetLookup": { "post": { "tags": [ "EmployeeVacationYear" ], "summary": "EmployeeVacationYear: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeVacationYear-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeVacationYear_GetLookup_C00AA08712F9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/EmployeeVacationYear/GetLookupByValue": { "post": { "tags": [ "EmployeeVacationYear" ], "summary": "EmployeeVacationYear: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeVacationYear-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeVacationYear_GetLookupByValue_4B841B4B4A8E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/EmployeeVacationYear/Page": { "get": { "tags": [ "EmployeeVacationYear" ], "summary": "EmployeeVacationYear: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeVacationYear-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeVacationYear_GetPage_AF8CC24704CC", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmployeeVacationYear/PageAsc": { "get": { "tags": [ "EmployeeVacationYear" ], "summary": "EmployeeVacationYear: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeVacationYear-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeVacationYear_GetPageAsc_54EF4DBDE7AB", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/EmployeeVacationYear/SearchByValue": { "post": { "tags": [ "EmployeeVacationYear" ], "summary": "EmployeeVacationYear: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeVacationYear-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeVacationYear_SearchByValue_356B597B05AD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmployeeVacationYear" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmployeeVacationYear" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmployeeVacationYear" } } } } } } }, "/api/EmployeeVacationYear/TryGetByValue": { "post": { "tags": [ "EmployeeVacationYear" ], "summary": "EmployeeVacationYear: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeVacationYear-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeVacationYear_TryGetByValue_CFC20E09A7BC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeVacationYear" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeVacationYear" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeVacationYear" } } } } } } }, "/api/EmployeeVacationYear/UpsertGraph": { "put": { "tags": [ "EmployeeVacationYear" ], "summary": "EmployeeVacationYear: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeVacationYear-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeVacationYear_UpsertGraph_589CECE8CC79", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeVacationYear" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeVacationYear" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeVacationYear" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeVacationYear" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeVacationYear" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeVacationYear" } } } } } } }, "/api/EmployeeVacationYear/UpsertGraphWithExtraFields": { "put": { "tags": [ "EmployeeVacationYear" ], "summary": "EmployeeVacationYear: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: EmployeeVacationYear-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "EmployeeVacationYear_UpsertGraphWithExtraFields_AE3B5FB1058B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmployeeVacationYear" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmployeeVacationYear" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmployeeVacationYear" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmployeeVacationYear" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmployeeVacationYear" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmployeeVacationYear" } } } } } } }, "/api/ExternalAspNetRole": { "get": { "tags": [ "ExternalAspNetRole" ], "summary": "ExternalAspNetRole: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetRole-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetRole_GetAll_908F98EBE110", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAspNetRole" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAspNetRole" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAspNetRole" } } } } } }, "post": { "tags": [ "ExternalAspNetRole" ], "summary": "ExternalAspNetRole: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetRole-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetRole_Post_939A6AAC3878", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetRole" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetRole" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetRole" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetRole" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetRole" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetRole" } } } } } }, "put": { "tags": [ "ExternalAspNetRole" ], "summary": "ExternalAspNetRole: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetRole-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetRole_Put_365E64304AE7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetRole" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetRole" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetRole" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetRole" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetRole" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetRole" } } } } } } }, "/api/ExternalAspNetRole/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "ExternalAspNetRole" ], "summary": "ExternalAspNetRole: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetRole-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetRole_GetPageByValue_2DBEECD3F501", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ExternalAspNetRole/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "ExternalAspNetRole" ], "summary": "ExternalAspNetRole: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetRole-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetRole_GetPageByValue2_58218D2E83D7", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ExternalAspNetRole/DeleteByFilter": { "post": { "tags": [ "ExternalAspNetRole" ], "summary": "ExternalAspNetRole: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetRole-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetRole_DeleteByFilter_E7C3B6BBFCF5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/ExternalAspNetRole/GetAllByValue": { "post": { "tags": [ "ExternalAspNetRole" ], "summary": "ExternalAspNetRole: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetRole-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetRole_GetAllByValue_40EB6AB988D9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAspNetRole" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAspNetRole" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAspNetRole" } } } } } } }, "/api/ExternalAspNetRole/GetAllGraphByValue": { "post": { "tags": [ "ExternalAspNetRole" ], "summary": "ExternalAspNetRole: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetRole-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetRole_GetAllGraphByValue_2099EF908BDB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAspNetRole" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAspNetRole" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAspNetRole" } } } } } } }, "/api/ExternalAspNetRole/GetByValue": { "post": { "tags": [ "ExternalAspNetRole" ], "summary": "ExternalAspNetRole: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetRole-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetRole_GetByValue_C8DDAF3117FA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetRole" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetRole" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetRole" } } } } } } }, "/api/ExternalAspNetRole/GetLookup": { "post": { "tags": [ "ExternalAspNetRole" ], "summary": "ExternalAspNetRole: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetRole-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetRole_GetLookup_D71E77A9EF77", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ExternalAspNetRole/GetLookupByValue": { "post": { "tags": [ "ExternalAspNetRole" ], "summary": "ExternalAspNetRole: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetRole-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetRole_GetLookupByValue_BFBC8A4215FF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ExternalAspNetRole/Page": { "get": { "tags": [ "ExternalAspNetRole" ], "summary": "ExternalAspNetRole: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetRole-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetRole_GetPage_F53D6FD0DD3F", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ExternalAspNetRole/PageAsc": { "get": { "tags": [ "ExternalAspNetRole" ], "summary": "ExternalAspNetRole: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetRole-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetRole_GetPageAsc_57EB838472A8", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ExternalAspNetRole/SearchByValue": { "post": { "tags": [ "ExternalAspNetRole" ], "summary": "ExternalAspNetRole: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetRole-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetRole_SearchByValue_CAFBC28E32F7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ExternalAspNetRole" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ExternalAspNetRole" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ExternalAspNetRole" } } } } } } }, "/api/ExternalAspNetRole/TryGetByValue": { "post": { "tags": [ "ExternalAspNetRole" ], "summary": "ExternalAspNetRole: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetRole-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetRole_TryGetByValue_B2B4F0660223", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetRole" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetRole" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetRole" } } } } } } }, "/api/ExternalAspNetRole/UpsertGraph": { "put": { "tags": [ "ExternalAspNetRole" ], "summary": "ExternalAspNetRole: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetRole-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetRole_UpsertGraph_60F44D962447", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetRole" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetRole" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetRole" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetRole" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetRole" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetRole" } } } } } } }, "/api/ExternalAspNetRole/UpsertGraphWithExtraFields": { "put": { "tags": [ "ExternalAspNetRole" ], "summary": "ExternalAspNetRole: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetRole-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetRole_UpsertGraphWithExtraFields_3172E33C5252", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAspNetRole" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAspNetRole" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAspNetRole" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAspNetRole" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAspNetRole" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAspNetRole" } } } } } } }, "/api/ExternalAspNetRoleClaim": { "get": { "tags": [ "ExternalAspNetRoleClaim" ], "summary": "ExternalAspNetRoleClaim: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetRoleClaim-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetRoleClaim_GetAll_32DE67C4BCF2", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAspNetRoleClaim" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAspNetRoleClaim" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAspNetRoleClaim" } } } } } }, "post": { "tags": [ "ExternalAspNetRoleClaim" ], "summary": "ExternalAspNetRoleClaim: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetRoleClaim-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetRoleClaim_Post_430BA8544145", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetRoleClaim" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetRoleClaim" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetRoleClaim" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetRoleClaim" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetRoleClaim" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetRoleClaim" } } } } } }, "put": { "tags": [ "ExternalAspNetRoleClaim" ], "summary": "ExternalAspNetRoleClaim: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetRoleClaim-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetRoleClaim_Put_23D91C4ABA78", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetRoleClaim" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetRoleClaim" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetRoleClaim" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetRoleClaim" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetRoleClaim" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetRoleClaim" } } } } } } }, "/api/ExternalAspNetRoleClaim/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "ExternalAspNetRoleClaim" ], "summary": "ExternalAspNetRoleClaim: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetRoleClaim-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetRoleClaim_GetPageByValue_CF6719AAE51B", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ExternalAspNetRoleClaim/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "ExternalAspNetRoleClaim" ], "summary": "ExternalAspNetRoleClaim: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetRoleClaim-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetRoleClaim_GetPageByValue2_F44F3358F281", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ExternalAspNetRoleClaim/DeleteByFilter": { "post": { "tags": [ "ExternalAspNetRoleClaim" ], "summary": "ExternalAspNetRoleClaim: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetRoleClaim-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetRoleClaim_DeleteByFilter_83CC0A65890A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/ExternalAspNetRoleClaim/GetAllByValue": { "post": { "tags": [ "ExternalAspNetRoleClaim" ], "summary": "ExternalAspNetRoleClaim: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetRoleClaim-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetRoleClaim_GetAllByValue_FD88DFDC991B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAspNetRoleClaim" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAspNetRoleClaim" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAspNetRoleClaim" } } } } } } }, "/api/ExternalAspNetRoleClaim/GetAllGraphByValue": { "post": { "tags": [ "ExternalAspNetRoleClaim" ], "summary": "ExternalAspNetRoleClaim: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetRoleClaim-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetRoleClaim_GetAllGraphByValue_181E0C1FB217", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAspNetRoleClaim" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAspNetRoleClaim" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAspNetRoleClaim" } } } } } } }, "/api/ExternalAspNetRoleClaim/GetByValue": { "post": { "tags": [ "ExternalAspNetRoleClaim" ], "summary": "ExternalAspNetRoleClaim: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetRoleClaim-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetRoleClaim_GetByValue_B2FE96723807", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetRoleClaim" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetRoleClaim" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetRoleClaim" } } } } } } }, "/api/ExternalAspNetRoleClaim/GetLookup": { "post": { "tags": [ "ExternalAspNetRoleClaim" ], "summary": "ExternalAspNetRoleClaim: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetRoleClaim-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetRoleClaim_GetLookup_97A20EAAF43F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ExternalAspNetRoleClaim/GetLookupByValue": { "post": { "tags": [ "ExternalAspNetRoleClaim" ], "summary": "ExternalAspNetRoleClaim: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetRoleClaim-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetRoleClaim_GetLookupByValue_1F1120DDDDC4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ExternalAspNetRoleClaim/Page": { "get": { "tags": [ "ExternalAspNetRoleClaim" ], "summary": "ExternalAspNetRoleClaim: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetRoleClaim-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetRoleClaim_GetPage_2A894A987BB5", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ExternalAspNetRoleClaim/PageAsc": { "get": { "tags": [ "ExternalAspNetRoleClaim" ], "summary": "ExternalAspNetRoleClaim: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetRoleClaim-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetRoleClaim_GetPageAsc_9D3ED9C409FF", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ExternalAspNetRoleClaim/SearchByValue": { "post": { "tags": [ "ExternalAspNetRoleClaim" ], "summary": "ExternalAspNetRoleClaim: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetRoleClaim-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetRoleClaim_SearchByValue_F8BA4EE78440", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ExternalAspNetRoleClaim" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ExternalAspNetRoleClaim" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ExternalAspNetRoleClaim" } } } } } } }, "/api/ExternalAspNetRoleClaim/TryGetByValue": { "post": { "tags": [ "ExternalAspNetRoleClaim" ], "summary": "ExternalAspNetRoleClaim: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetRoleClaim-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetRoleClaim_TryGetByValue_2DF9E09E4049", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetRoleClaim" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetRoleClaim" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetRoleClaim" } } } } } } }, "/api/ExternalAspNetRoleClaim/UpsertGraph": { "put": { "tags": [ "ExternalAspNetRoleClaim" ], "summary": "ExternalAspNetRoleClaim: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetRoleClaim-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetRoleClaim_UpsertGraph_B79957BF31F1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetRoleClaim" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetRoleClaim" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetRoleClaim" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetRoleClaim" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetRoleClaim" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetRoleClaim" } } } } } } }, "/api/ExternalAspNetRoleClaim/UpsertGraphWithExtraFields": { "put": { "tags": [ "ExternalAspNetRoleClaim" ], "summary": "ExternalAspNetRoleClaim: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetRoleClaim-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetRoleClaim_UpsertGraphWithExtraFields_6881059C8C51", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAspNetRoleClaim" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAspNetRoleClaim" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAspNetRoleClaim" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAspNetRoleClaim" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAspNetRoleClaim" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAspNetRoleClaim" } } } } } } }, "/api/ExternalAspNetUser": { "get": { "tags": [ "ExternalAspNetUser" ], "summary": "ExternalAspNetUser: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetUser-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetUser_GetAll_6B7FFE94A8C0", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAspNetUser" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAspNetUser" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAspNetUser" } } } } } }, "post": { "tags": [ "ExternalAspNetUser" ], "summary": "ExternalAspNetUser: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetUser-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetUser_Post_FAA83773C742", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetUser" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetUser" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetUser" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetUser" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetUser" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetUser" } } } } } }, "put": { "tags": [ "ExternalAspNetUser" ], "summary": "ExternalAspNetUser: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetUser-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetUser_Put_5293CA9A728B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetUser" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetUser" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetUser" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetUser" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetUser" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetUser" } } } } } } }, "/api/ExternalAspNetUser/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "ExternalAspNetUser" ], "summary": "ExternalAspNetUser: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetUser-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetUser_GetPageByValue_A896F916E1AB", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ExternalAspNetUser/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "ExternalAspNetUser" ], "summary": "ExternalAspNetUser: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetUser-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetUser_GetPageByValue2_3FC0FCBB09D1", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ExternalAspNetUser/DeleteByFilter": { "post": { "tags": [ "ExternalAspNetUser" ], "summary": "ExternalAspNetUser: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetUser-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetUser_DeleteByFilter_3C72FACCE8E1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/ExternalAspNetUser/GetAllByValue": { "post": { "tags": [ "ExternalAspNetUser" ], "summary": "ExternalAspNetUser: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetUser-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetUser_GetAllByValue_F4276B94B635", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAspNetUser" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAspNetUser" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAspNetUser" } } } } } } }, "/api/ExternalAspNetUser/GetAllGraphByValue": { "post": { "tags": [ "ExternalAspNetUser" ], "summary": "ExternalAspNetUser: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetUser-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetUser_GetAllGraphByValue_419A31C2CC84", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAspNetUser" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAspNetUser" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAspNetUser" } } } } } } }, "/api/ExternalAspNetUser/GetByValue": { "post": { "tags": [ "ExternalAspNetUser" ], "summary": "ExternalAspNetUser: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetUser-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetUser_GetByValue_BCD3AFF51650", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetUser" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetUser" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetUser" } } } } } } }, "/api/ExternalAspNetUser/GetLookup": { "post": { "tags": [ "ExternalAspNetUser" ], "summary": "ExternalAspNetUser: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetUser-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetUser_GetLookup_E29F9F28CC85", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ExternalAspNetUser/GetLookupByValue": { "post": { "tags": [ "ExternalAspNetUser" ], "summary": "ExternalAspNetUser: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetUser-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetUser_GetLookupByValue_D1CE0072F2C8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ExternalAspNetUser/Page": { "get": { "tags": [ "ExternalAspNetUser" ], "summary": "ExternalAspNetUser: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetUser-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetUser_GetPage_58FFE2BCBA23", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ExternalAspNetUser/PageAsc": { "get": { "tags": [ "ExternalAspNetUser" ], "summary": "ExternalAspNetUser: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetUser-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetUser_GetPageAsc_34A385A50989", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ExternalAspNetUser/SearchByValue": { "post": { "tags": [ "ExternalAspNetUser" ], "summary": "ExternalAspNetUser: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetUser-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetUser_SearchByValue_C33F96BACA08", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ExternalAspNetUser" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ExternalAspNetUser" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ExternalAspNetUser" } } } } } } }, "/api/ExternalAspNetUser/TryGetByValue": { "post": { "tags": [ "ExternalAspNetUser" ], "summary": "ExternalAspNetUser: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetUser-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetUser_TryGetByValue_FB510D1AD584", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetUser" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetUser" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetUser" } } } } } } }, "/api/ExternalAspNetUser/UpsertGraph": { "put": { "tags": [ "ExternalAspNetUser" ], "summary": "ExternalAspNetUser: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetUser-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetUser_UpsertGraph_633B43A409FE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetUser" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetUser" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetUser" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetUser" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetUser" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetUser" } } } } } } }, "/api/ExternalAspNetUser/UpsertGraphWithExtraFields": { "put": { "tags": [ "ExternalAspNetUser" ], "summary": "ExternalAspNetUser: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetUser-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetUser_UpsertGraphWithExtraFields_9078B0DE4497", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAspNetUser" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAspNetUser" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAspNetUser" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAspNetUser" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAspNetUser" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAspNetUser" } } } } } } }, "/api/ExternalAspNetUserClaim": { "get": { "tags": [ "ExternalAspNetUserClaim" ], "summary": "ExternalAspNetUserClaim: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetUserClaim-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetUserClaim_GetAll_3115DF48BFCC", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAspNetUserClaim" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAspNetUserClaim" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAspNetUserClaim" } } } } } }, "post": { "tags": [ "ExternalAspNetUserClaim" ], "summary": "ExternalAspNetUserClaim: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetUserClaim-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetUserClaim_Post_29E7D218B6A4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetUserClaim" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetUserClaim" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetUserClaim" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetUserClaim" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetUserClaim" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetUserClaim" } } } } } }, "put": { "tags": [ "ExternalAspNetUserClaim" ], "summary": "ExternalAspNetUserClaim: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetUserClaim-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetUserClaim_Put_00B7D8B36A5E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetUserClaim" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetUserClaim" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetUserClaim" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetUserClaim" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetUserClaim" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetUserClaim" } } } } } } }, "/api/ExternalAspNetUserClaim/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "ExternalAspNetUserClaim" ], "summary": "ExternalAspNetUserClaim: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetUserClaim-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetUserClaim_GetPageByValue_D36430B2B727", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ExternalAspNetUserClaim/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "ExternalAspNetUserClaim" ], "summary": "ExternalAspNetUserClaim: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetUserClaim-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetUserClaim_GetPageByValue2_D0938EFFB39E", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ExternalAspNetUserClaim/DeleteByFilter": { "post": { "tags": [ "ExternalAspNetUserClaim" ], "summary": "ExternalAspNetUserClaim: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetUserClaim-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetUserClaim_DeleteByFilter_914AB98367AA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/ExternalAspNetUserClaim/GetAllByValue": { "post": { "tags": [ "ExternalAspNetUserClaim" ], "summary": "ExternalAspNetUserClaim: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetUserClaim-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetUserClaim_GetAllByValue_027F629A3E28", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAspNetUserClaim" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAspNetUserClaim" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAspNetUserClaim" } } } } } } }, "/api/ExternalAspNetUserClaim/GetAllGraphByValue": { "post": { "tags": [ "ExternalAspNetUserClaim" ], "summary": "ExternalAspNetUserClaim: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetUserClaim-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetUserClaim_GetAllGraphByValue_EDA8CD4B4DB6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAspNetUserClaim" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAspNetUserClaim" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAspNetUserClaim" } } } } } } }, "/api/ExternalAspNetUserClaim/GetByValue": { "post": { "tags": [ "ExternalAspNetUserClaim" ], "summary": "ExternalAspNetUserClaim: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetUserClaim-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetUserClaim_GetByValue_26DA8E686624", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetUserClaim" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetUserClaim" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetUserClaim" } } } } } } }, "/api/ExternalAspNetUserClaim/GetLookup": { "post": { "tags": [ "ExternalAspNetUserClaim" ], "summary": "ExternalAspNetUserClaim: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetUserClaim-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetUserClaim_GetLookup_61341F3D590F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ExternalAspNetUserClaim/GetLookupByValue": { "post": { "tags": [ "ExternalAspNetUserClaim" ], "summary": "ExternalAspNetUserClaim: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetUserClaim-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetUserClaim_GetLookupByValue_02EFA7BD035C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ExternalAspNetUserClaim/Page": { "get": { "tags": [ "ExternalAspNetUserClaim" ], "summary": "ExternalAspNetUserClaim: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetUserClaim-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetUserClaim_GetPage_52ACC6E231AC", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ExternalAspNetUserClaim/PageAsc": { "get": { "tags": [ "ExternalAspNetUserClaim" ], "summary": "ExternalAspNetUserClaim: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetUserClaim-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetUserClaim_GetPageAsc_9D28DBA2AB0E", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ExternalAspNetUserClaim/SearchByValue": { "post": { "tags": [ "ExternalAspNetUserClaim" ], "summary": "ExternalAspNetUserClaim: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetUserClaim-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetUserClaim_SearchByValue_B68EDB9FD3B1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ExternalAspNetUserClaim" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ExternalAspNetUserClaim" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ExternalAspNetUserClaim" } } } } } } }, "/api/ExternalAspNetUserClaim/TryGetByValue": { "post": { "tags": [ "ExternalAspNetUserClaim" ], "summary": "ExternalAspNetUserClaim: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetUserClaim-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetUserClaim_TryGetByValue_BB433C783B72", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetUserClaim" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetUserClaim" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetUserClaim" } } } } } } }, "/api/ExternalAspNetUserClaim/UpsertGraph": { "put": { "tags": [ "ExternalAspNetUserClaim" ], "summary": "ExternalAspNetUserClaim: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetUserClaim-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetUserClaim_UpsertGraph_50DF20BB9A88", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetUserClaim" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetUserClaim" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetUserClaim" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetUserClaim" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetUserClaim" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetUserClaim" } } } } } } }, "/api/ExternalAspNetUserClaim/UpsertGraphWithExtraFields": { "put": { "tags": [ "ExternalAspNetUserClaim" ], "summary": "ExternalAspNetUserClaim: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetUserClaim-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetUserClaim_UpsertGraphWithExtraFields_94FBBF4642D1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAspNetUserClaim" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAspNetUserClaim" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAspNetUserClaim" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAspNetUserClaim" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAspNetUserClaim" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAspNetUserClaim" } } } } } } }, "/api/ExternalAspNetUserLogin": { "get": { "tags": [ "ExternalAspNetUserLogin" ], "summary": "ExternalAspNetUserLogin: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetUserLogin-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetUserLogin_GetAll_3316D03D5CB7", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAspNetUserLogin" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAspNetUserLogin" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAspNetUserLogin" } } } } } }, "post": { "tags": [ "ExternalAspNetUserLogin" ], "summary": "ExternalAspNetUserLogin: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetUserLogin-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetUserLogin_Post_9C9330344059", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetUserLogin" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetUserLogin" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetUserLogin" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetUserLogin" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetUserLogin" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetUserLogin" } } } } } }, "put": { "tags": [ "ExternalAspNetUserLogin" ], "summary": "ExternalAspNetUserLogin: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetUserLogin-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetUserLogin_Put_8286BAF37147", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetUserLogin" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetUserLogin" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetUserLogin" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetUserLogin" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetUserLogin" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetUserLogin" } } } } } } }, "/api/ExternalAspNetUserLogin/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "ExternalAspNetUserLogin" ], "summary": "ExternalAspNetUserLogin: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetUserLogin-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetUserLogin_GetPageByValue_69EE75FAAE69", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ExternalAspNetUserLogin/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "ExternalAspNetUserLogin" ], "summary": "ExternalAspNetUserLogin: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetUserLogin-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetUserLogin_GetPageByValue2_3D32846AAF74", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ExternalAspNetUserLogin/DeleteByFilter": { "post": { "tags": [ "ExternalAspNetUserLogin" ], "summary": "ExternalAspNetUserLogin: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetUserLogin-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetUserLogin_DeleteByFilter_3C0F46E6F28A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/ExternalAspNetUserLogin/GetAllByValue": { "post": { "tags": [ "ExternalAspNetUserLogin" ], "summary": "ExternalAspNetUserLogin: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetUserLogin-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetUserLogin_GetAllByValue_5EBBCCBAD5EF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAspNetUserLogin" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAspNetUserLogin" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAspNetUserLogin" } } } } } } }, "/api/ExternalAspNetUserLogin/GetAllGraphByValue": { "post": { "tags": [ "ExternalAspNetUserLogin" ], "summary": "ExternalAspNetUserLogin: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetUserLogin-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetUserLogin_GetAllGraphByValue_01FB89ED259C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAspNetUserLogin" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAspNetUserLogin" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAspNetUserLogin" } } } } } } }, "/api/ExternalAspNetUserLogin/GetByValue": { "post": { "tags": [ "ExternalAspNetUserLogin" ], "summary": "ExternalAspNetUserLogin: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetUserLogin-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetUserLogin_GetByValue_F27BF45B8CCD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetUserLogin" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetUserLogin" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetUserLogin" } } } } } } }, "/api/ExternalAspNetUserLogin/GetLookup": { "post": { "tags": [ "ExternalAspNetUserLogin" ], "summary": "ExternalAspNetUserLogin: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetUserLogin-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetUserLogin_GetLookup_B9DE710B9CD6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ExternalAspNetUserLogin/GetLookupByValue": { "post": { "tags": [ "ExternalAspNetUserLogin" ], "summary": "ExternalAspNetUserLogin: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetUserLogin-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetUserLogin_GetLookupByValue_BC22E89FF73F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ExternalAspNetUserLogin/Page": { "get": { "tags": [ "ExternalAspNetUserLogin" ], "summary": "ExternalAspNetUserLogin: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetUserLogin-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetUserLogin_GetPage_B14A36C0E9D8", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ExternalAspNetUserLogin/PageAsc": { "get": { "tags": [ "ExternalAspNetUserLogin" ], "summary": "ExternalAspNetUserLogin: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetUserLogin-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetUserLogin_GetPageAsc_902996624715", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ExternalAspNetUserLogin/SearchByValue": { "post": { "tags": [ "ExternalAspNetUserLogin" ], "summary": "ExternalAspNetUserLogin: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetUserLogin-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetUserLogin_SearchByValue_E78B3CA266A8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ExternalAspNetUserLogin" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ExternalAspNetUserLogin" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ExternalAspNetUserLogin" } } } } } } }, "/api/ExternalAspNetUserLogin/TryGetByValue": { "post": { "tags": [ "ExternalAspNetUserLogin" ], "summary": "ExternalAspNetUserLogin: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetUserLogin-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetUserLogin_TryGetByValue_3C6D79A5B8D3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetUserLogin" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetUserLogin" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetUserLogin" } } } } } } }, "/api/ExternalAspNetUserLogin/UpsertGraph": { "put": { "tags": [ "ExternalAspNetUserLogin" ], "summary": "ExternalAspNetUserLogin: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetUserLogin-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetUserLogin_UpsertGraph_979D400D5F5D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetUserLogin" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetUserLogin" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetUserLogin" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetUserLogin" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetUserLogin" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetUserLogin" } } } } } } }, "/api/ExternalAspNetUserLogin/UpsertGraphWithExtraFields": { "put": { "tags": [ "ExternalAspNetUserLogin" ], "summary": "ExternalAspNetUserLogin: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetUserLogin-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetUserLogin_UpsertGraphWithExtraFields_01DFF0ED49D8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAspNetUserLogin" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAspNetUserLogin" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAspNetUserLogin" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAspNetUserLogin" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAspNetUserLogin" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAspNetUserLogin" } } } } } } }, "/api/ExternalAspNetUserToken": { "get": { "tags": [ "ExternalAspNetUserToken" ], "summary": "ExternalAspNetUserToken: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetUserToken-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetUserToken_GetAll_74D551DAFE7B", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAspNetUserToken" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAspNetUserToken" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAspNetUserToken" } } } } } }, "post": { "tags": [ "ExternalAspNetUserToken" ], "summary": "ExternalAspNetUserToken: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetUserToken-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetUserToken_Post_2E35C9F62B4F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetUserToken" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetUserToken" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetUserToken" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetUserToken" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetUserToken" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetUserToken" } } } } } }, "put": { "tags": [ "ExternalAspNetUserToken" ], "summary": "ExternalAspNetUserToken: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetUserToken-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetUserToken_Put_64CB0194B3E5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetUserToken" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetUserToken" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetUserToken" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetUserToken" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetUserToken" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetUserToken" } } } } } } }, "/api/ExternalAspNetUserToken/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "ExternalAspNetUserToken" ], "summary": "ExternalAspNetUserToken: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetUserToken-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetUserToken_GetPageByValue_37C6CD984A3D", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ExternalAspNetUserToken/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "ExternalAspNetUserToken" ], "summary": "ExternalAspNetUserToken: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetUserToken-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetUserToken_GetPageByValue2_62CCA8B3CB9B", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ExternalAspNetUserToken/DeleteByFilter": { "post": { "tags": [ "ExternalAspNetUserToken" ], "summary": "ExternalAspNetUserToken: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetUserToken-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetUserToken_DeleteByFilter_1D7123BB6106", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/ExternalAspNetUserToken/GetAllByValue": { "post": { "tags": [ "ExternalAspNetUserToken" ], "summary": "ExternalAspNetUserToken: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetUserToken-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetUserToken_GetAllByValue_CCF3B169C19E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAspNetUserToken" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAspNetUserToken" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAspNetUserToken" } } } } } } }, "/api/ExternalAspNetUserToken/GetAllGraphByValue": { "post": { "tags": [ "ExternalAspNetUserToken" ], "summary": "ExternalAspNetUserToken: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetUserToken-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetUserToken_GetAllGraphByValue_06E6B5530198", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAspNetUserToken" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAspNetUserToken" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAspNetUserToken" } } } } } } }, "/api/ExternalAspNetUserToken/GetByValue": { "post": { "tags": [ "ExternalAspNetUserToken" ], "summary": "ExternalAspNetUserToken: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetUserToken-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetUserToken_GetByValue_37A2C93FA664", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetUserToken" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetUserToken" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetUserToken" } } } } } } }, "/api/ExternalAspNetUserToken/GetLookup": { "post": { "tags": [ "ExternalAspNetUserToken" ], "summary": "ExternalAspNetUserToken: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetUserToken-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetUserToken_GetLookup_7DFD2A5191EC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ExternalAspNetUserToken/GetLookupByValue": { "post": { "tags": [ "ExternalAspNetUserToken" ], "summary": "ExternalAspNetUserToken: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetUserToken-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetUserToken_GetLookupByValue_8DB1FE233B8B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ExternalAspNetUserToken/Page": { "get": { "tags": [ "ExternalAspNetUserToken" ], "summary": "ExternalAspNetUserToken: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetUserToken-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetUserToken_GetPage_6B62AB4C7FFE", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ExternalAspNetUserToken/PageAsc": { "get": { "tags": [ "ExternalAspNetUserToken" ], "summary": "ExternalAspNetUserToken: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetUserToken-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetUserToken_GetPageAsc_99C093337E54", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ExternalAspNetUserToken/SearchByValue": { "post": { "tags": [ "ExternalAspNetUserToken" ], "summary": "ExternalAspNetUserToken: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetUserToken-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetUserToken_SearchByValue_B5FD06E8A91C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ExternalAspNetUserToken" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ExternalAspNetUserToken" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ExternalAspNetUserToken" } } } } } } }, "/api/ExternalAspNetUserToken/TryGetByValue": { "post": { "tags": [ "ExternalAspNetUserToken" ], "summary": "ExternalAspNetUserToken: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetUserToken-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetUserToken_TryGetByValue_8578B06326CE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetUserToken" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetUserToken" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetUserToken" } } } } } } }, "/api/ExternalAspNetUserToken/UpsertGraph": { "put": { "tags": [ "ExternalAspNetUserToken" ], "summary": "ExternalAspNetUserToken: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetUserToken-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetUserToken_UpsertGraph_F99F4FEB383D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetUserToken" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetUserToken" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetUserToken" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetUserToken" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetUserToken" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetUserToken" } } } } } } }, "/api/ExternalAspNetUserToken/UpsertGraphWithExtraFields": { "put": { "tags": [ "ExternalAspNetUserToken" ], "summary": "ExternalAspNetUserToken: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAspNetUserToken-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAspNetUserToken_UpsertGraphWithExtraFields_FDB2F8C94AB3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAspNetUserToken" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAspNetUserToken" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAspNetUserToken" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAspNetUserToken" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAspNetUserToken" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAspNetUserToken" } } } } } } }, "/api/ExternalAuthorizationPage": { "get": { "tags": [ "ExternalAuthorizationPage" ], "summary": "ExternalAuthorizationPage: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAuthorizationPage-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAuthorizationPage_GetAll_1012639810E6", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAuthorizationPage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAuthorizationPage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAuthorizationPage" } } } } } }, "post": { "tags": [ "ExternalAuthorizationPage" ], "summary": "ExternalAuthorizationPage: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAuthorizationPage-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAuthorizationPage_Post_66E8D3B4FE1A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAuthorizationPage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAuthorizationPage" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAuthorizationPage" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAuthorizationPage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAuthorizationPage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAuthorizationPage" } } } } } }, "put": { "tags": [ "ExternalAuthorizationPage" ], "summary": "ExternalAuthorizationPage: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAuthorizationPage-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAuthorizationPage_Put_099284FE35CC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAuthorizationPage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAuthorizationPage" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAuthorizationPage" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAuthorizationPage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAuthorizationPage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAuthorizationPage" } } } } } } }, "/api/ExternalAuthorizationPage/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "ExternalAuthorizationPage" ], "summary": "ExternalAuthorizationPage: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAuthorizationPage-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAuthorizationPage_GetPageByValue_8D799DBB2634", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ExternalAuthorizationPage/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "ExternalAuthorizationPage" ], "summary": "ExternalAuthorizationPage: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAuthorizationPage-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAuthorizationPage_GetPageByValue2_AE5AE19DC1E1", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ExternalAuthorizationPage/DeleteByFilter": { "post": { "tags": [ "ExternalAuthorizationPage" ], "summary": "ExternalAuthorizationPage: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAuthorizationPage-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAuthorizationPage_DeleteByFilter_6017F14B8ACC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/ExternalAuthorizationPage/GetAllByValue": { "post": { "tags": [ "ExternalAuthorizationPage" ], "summary": "ExternalAuthorizationPage: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAuthorizationPage-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAuthorizationPage_GetAllByValue_FC8C8B879A0D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAuthorizationPage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAuthorizationPage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAuthorizationPage" } } } } } } }, "/api/ExternalAuthorizationPage/GetAllGraphByValue": { "post": { "tags": [ "ExternalAuthorizationPage" ], "summary": "ExternalAuthorizationPage: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAuthorizationPage-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAuthorizationPage_GetAllGraphByValue_A089143B273B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAuthorizationPage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAuthorizationPage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAuthorizationPage" } } } } } } }, "/api/ExternalAuthorizationPage/GetByValue": { "post": { "tags": [ "ExternalAuthorizationPage" ], "summary": "ExternalAuthorizationPage: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAuthorizationPage-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAuthorizationPage_GetByValue_E035FD1DE63E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAuthorizationPage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAuthorizationPage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAuthorizationPage" } } } } } } }, "/api/ExternalAuthorizationPage/GetLookup": { "post": { "tags": [ "ExternalAuthorizationPage" ], "summary": "ExternalAuthorizationPage: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAuthorizationPage-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAuthorizationPage_GetLookup_8B47EEE6CBF7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ExternalAuthorizationPage/GetLookupByValue": { "post": { "tags": [ "ExternalAuthorizationPage" ], "summary": "ExternalAuthorizationPage: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAuthorizationPage-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAuthorizationPage_GetLookupByValue_B2411445B1A0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ExternalAuthorizationPage/Page": { "get": { "tags": [ "ExternalAuthorizationPage" ], "summary": "ExternalAuthorizationPage: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAuthorizationPage-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAuthorizationPage_GetPage_5395D30144F9", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ExternalAuthorizationPage/PageAsc": { "get": { "tags": [ "ExternalAuthorizationPage" ], "summary": "ExternalAuthorizationPage: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAuthorizationPage-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAuthorizationPage_GetPageAsc_D06F2A994FAF", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ExternalAuthorizationPage/SearchByValue": { "post": { "tags": [ "ExternalAuthorizationPage" ], "summary": "ExternalAuthorizationPage: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAuthorizationPage-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAuthorizationPage_SearchByValue_6F9F51ECD90E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ExternalAuthorizationPage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ExternalAuthorizationPage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ExternalAuthorizationPage" } } } } } } }, "/api/ExternalAuthorizationPage/TryGetByValue": { "post": { "tags": [ "ExternalAuthorizationPage" ], "summary": "ExternalAuthorizationPage: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAuthorizationPage-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAuthorizationPage_TryGetByValue_9E65F16DC00E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAuthorizationPage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAuthorizationPage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAuthorizationPage" } } } } } } }, "/api/ExternalAuthorizationPage/UpsertGraph": { "put": { "tags": [ "ExternalAuthorizationPage" ], "summary": "ExternalAuthorizationPage: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAuthorizationPage-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAuthorizationPage_UpsertGraph_3091E609DFE1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAuthorizationPage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAuthorizationPage" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAuthorizationPage" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAuthorizationPage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAuthorizationPage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAuthorizationPage" } } } } } } }, "/api/ExternalAuthorizationPage/UpsertGraphWithExtraFields": { "put": { "tags": [ "ExternalAuthorizationPage" ], "summary": "ExternalAuthorizationPage: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAuthorizationPage-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAuthorizationPage_UpsertGraphWithExtraFields_D783AD863F6B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAuthorizationPage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAuthorizationPage" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAuthorizationPage" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAuthorizationPage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAuthorizationPage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAuthorizationPage" } } } } } } }, "/api/ExternalAuthorizationRolePagePermission": { "get": { "tags": [ "ExternalAuthorizationRolePagePermission" ], "summary": "ExternalAuthorizationRolePagePermission: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAuthorizationRolePagePermission-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAuthorizationRolePagePermission_GetAll_86FE0CB3F768", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAuthorizationRolePagePermission" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAuthorizationRolePagePermission" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAuthorizationRolePagePermission" } } } } } }, "post": { "tags": [ "ExternalAuthorizationRolePagePermission" ], "summary": "ExternalAuthorizationRolePagePermission: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAuthorizationRolePagePermission-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAuthorizationRolePagePermission_Post_8E715B8E08C2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAuthorizationRolePagePermission" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAuthorizationRolePagePermission" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAuthorizationRolePagePermission" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAuthorizationRolePagePermission" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAuthorizationRolePagePermission" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAuthorizationRolePagePermission" } } } } } }, "put": { "tags": [ "ExternalAuthorizationRolePagePermission" ], "summary": "ExternalAuthorizationRolePagePermission: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAuthorizationRolePagePermission-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAuthorizationRolePagePermission_Put_69C39EE41A3E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAuthorizationRolePagePermission" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAuthorizationRolePagePermission" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAuthorizationRolePagePermission" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAuthorizationRolePagePermission" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAuthorizationRolePagePermission" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAuthorizationRolePagePermission" } } } } } } }, "/api/ExternalAuthorizationRolePagePermission/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "ExternalAuthorizationRolePagePermission" ], "summary": "ExternalAuthorizationRolePagePermission: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAuthorizationRolePagePermission-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAuthorizationRolePagePermission_GetPageByValue_76A2CB5D0991", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ExternalAuthorizationRolePagePermission/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "ExternalAuthorizationRolePagePermission" ], "summary": "ExternalAuthorizationRolePagePermission: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAuthorizationRolePagePermission-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAuthorizationRolePagePermission_GetPageByValue2_551297DD248E", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ExternalAuthorizationRolePagePermission/DeleteByFilter": { "post": { "tags": [ "ExternalAuthorizationRolePagePermission" ], "summary": "ExternalAuthorizationRolePagePermission: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAuthorizationRolePagePermission-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAuthorizationRolePagePermission_DeleteByFilter_F7473691E793", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/ExternalAuthorizationRolePagePermission/GetAllByValue": { "post": { "tags": [ "ExternalAuthorizationRolePagePermission" ], "summary": "ExternalAuthorizationRolePagePermission: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAuthorizationRolePagePermission-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAuthorizationRolePagePermission_GetAllByValue_B26927DFC705", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAuthorizationRolePagePermission" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAuthorizationRolePagePermission" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAuthorizationRolePagePermission" } } } } } } }, "/api/ExternalAuthorizationRolePagePermission/GetAllGraphByValue": { "post": { "tags": [ "ExternalAuthorizationRolePagePermission" ], "summary": "ExternalAuthorizationRolePagePermission: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAuthorizationRolePagePermission-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAuthorizationRolePagePermission_GetAllGraphByValue_115F6CB77D68", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAuthorizationRolePagePermission" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAuthorizationRolePagePermission" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAuthorizationRolePagePermission" } } } } } } }, "/api/ExternalAuthorizationRolePagePermission/GetByValue": { "post": { "tags": [ "ExternalAuthorizationRolePagePermission" ], "summary": "ExternalAuthorizationRolePagePermission: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAuthorizationRolePagePermission-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAuthorizationRolePagePermission_GetByValue_37198C80FC1B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAuthorizationRolePagePermission" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAuthorizationRolePagePermission" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAuthorizationRolePagePermission" } } } } } } }, "/api/ExternalAuthorizationRolePagePermission/GetLookup": { "post": { "tags": [ "ExternalAuthorizationRolePagePermission" ], "summary": "ExternalAuthorizationRolePagePermission: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAuthorizationRolePagePermission-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAuthorizationRolePagePermission_GetLookup_06FB576E0A48", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ExternalAuthorizationRolePagePermission/GetLookupByValue": { "post": { "tags": [ "ExternalAuthorizationRolePagePermission" ], "summary": "ExternalAuthorizationRolePagePermission: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAuthorizationRolePagePermission-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAuthorizationRolePagePermission_GetLookupByValue_79DE36D7665B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ExternalAuthorizationRolePagePermission/Page": { "get": { "tags": [ "ExternalAuthorizationRolePagePermission" ], "summary": "ExternalAuthorizationRolePagePermission: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAuthorizationRolePagePermission-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAuthorizationRolePagePermission_GetPage_DFAC4FDA8F4D", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ExternalAuthorizationRolePagePermission/PageAsc": { "get": { "tags": [ "ExternalAuthorizationRolePagePermission" ], "summary": "ExternalAuthorizationRolePagePermission: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAuthorizationRolePagePermission-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAuthorizationRolePagePermission_GetPageAsc_2663EA6A4BCC", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ExternalAuthorizationRolePagePermission/SearchByValue": { "post": { "tags": [ "ExternalAuthorizationRolePagePermission" ], "summary": "ExternalAuthorizationRolePagePermission: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAuthorizationRolePagePermission-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAuthorizationRolePagePermission_SearchByValue_7178E3C0C77C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ExternalAuthorizationRolePagePermission" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ExternalAuthorizationRolePagePermission" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ExternalAuthorizationRolePagePermission" } } } } } } }, "/api/ExternalAuthorizationRolePagePermission/TryGetByValue": { "post": { "tags": [ "ExternalAuthorizationRolePagePermission" ], "summary": "ExternalAuthorizationRolePagePermission: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAuthorizationRolePagePermission-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAuthorizationRolePagePermission_TryGetByValue_F1DF821B0403", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAuthorizationRolePagePermission" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAuthorizationRolePagePermission" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAuthorizationRolePagePermission" } } } } } } }, "/api/ExternalAuthorizationRolePagePermission/UpsertGraph": { "put": { "tags": [ "ExternalAuthorizationRolePagePermission" ], "summary": "ExternalAuthorizationRolePagePermission: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAuthorizationRolePagePermission-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAuthorizationRolePagePermission_UpsertGraph_5867A1F521ED", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAuthorizationRolePagePermission" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAuthorizationRolePagePermission" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAuthorizationRolePagePermission" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAuthorizationRolePagePermission" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAuthorizationRolePagePermission" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAuthorizationRolePagePermission" } } } } } } }, "/api/ExternalAuthorizationRolePagePermission/UpsertGraphWithExtraFields": { "put": { "tags": [ "ExternalAuthorizationRolePagePermission" ], "summary": "ExternalAuthorizationRolePagePermission: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAuthorizationRolePagePermission-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAuthorizationRolePagePermission_UpsertGraphWithExtraFields_589D2C20B446", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAuthorizationRolePagePermission" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAuthorizationRolePagePermission" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAuthorizationRolePagePermission" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAuthorizationRolePagePermission" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAuthorizationRolePagePermission" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAuthorizationRolePagePermission" } } } } } } }, "/api/ExternalAuthorizationRoleWebApiPermission": { "get": { "tags": [ "ExternalAuthorizationRoleWebApiPermission" ], "summary": "ExternalAuthorizationRoleWebApiPermission: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAuthorizationRoleWebApiPermission-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAuthorizationRoleWebApiPermission_GetAll_9A96BB6E07B3", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAuthorizationRoleWebApiPermission" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAuthorizationRoleWebApiPermission" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAuthorizationRoleWebApiPermission" } } } } } }, "post": { "tags": [ "ExternalAuthorizationRoleWebApiPermission" ], "summary": "ExternalAuthorizationRoleWebApiPermission: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAuthorizationRoleWebApiPermission-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAuthorizationRoleWebApiPermission_Post_57C2AC927315", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAuthorizationRoleWebApiPermission" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAuthorizationRoleWebApiPermission" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAuthorizationRoleWebApiPermission" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAuthorizationRoleWebApiPermission" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAuthorizationRoleWebApiPermission" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAuthorizationRoleWebApiPermission" } } } } } }, "put": { "tags": [ "ExternalAuthorizationRoleWebApiPermission" ], "summary": "ExternalAuthorizationRoleWebApiPermission: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAuthorizationRoleWebApiPermission-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAuthorizationRoleWebApiPermission_Put_A366C835D648", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAuthorizationRoleWebApiPermission" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAuthorizationRoleWebApiPermission" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAuthorizationRoleWebApiPermission" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAuthorizationRoleWebApiPermission" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAuthorizationRoleWebApiPermission" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAuthorizationRoleWebApiPermission" } } } } } } }, "/api/ExternalAuthorizationRoleWebApiPermission/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "ExternalAuthorizationRoleWebApiPermission" ], "summary": "ExternalAuthorizationRoleWebApiPermission: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAuthorizationRoleWebApiPermission-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAuthorizationRoleWebApiPermission_GetPageByValue_EBBF3AAD7D8E", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ExternalAuthorizationRoleWebApiPermission/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "ExternalAuthorizationRoleWebApiPermission" ], "summary": "ExternalAuthorizationRoleWebApiPermission: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAuthorizationRoleWebApiPermission-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAuthorizationRoleWebApiPermission_GetPageByValue2_EFDB7523F488", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ExternalAuthorizationRoleWebApiPermission/DeleteByFilter": { "post": { "tags": [ "ExternalAuthorizationRoleWebApiPermission" ], "summary": "ExternalAuthorizationRoleWebApiPermission: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAuthorizationRoleWebApiPermission-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAuthorizationRoleWebApiPermission_DeleteByFilter_6989EC8030F9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/ExternalAuthorizationRoleWebApiPermission/GetAllByValue": { "post": { "tags": [ "ExternalAuthorizationRoleWebApiPermission" ], "summary": "ExternalAuthorizationRoleWebApiPermission: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAuthorizationRoleWebApiPermission-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAuthorizationRoleWebApiPermission_GetAllByValue_49F2A10E9DB4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAuthorizationRoleWebApiPermission" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAuthorizationRoleWebApiPermission" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAuthorizationRoleWebApiPermission" } } } } } } }, "/api/ExternalAuthorizationRoleWebApiPermission/GetAllGraphByValue": { "post": { "tags": [ "ExternalAuthorizationRoleWebApiPermission" ], "summary": "ExternalAuthorizationRoleWebApiPermission: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAuthorizationRoleWebApiPermission-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAuthorizationRoleWebApiPermission_GetAllGraphByValue_F4C1F479ED45", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAuthorizationRoleWebApiPermission" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAuthorizationRoleWebApiPermission" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAuthorizationRoleWebApiPermission" } } } } } } }, "/api/ExternalAuthorizationRoleWebApiPermission/GetByValue": { "post": { "tags": [ "ExternalAuthorizationRoleWebApiPermission" ], "summary": "ExternalAuthorizationRoleWebApiPermission: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAuthorizationRoleWebApiPermission-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAuthorizationRoleWebApiPermission_GetByValue_53B73B640DB0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAuthorizationRoleWebApiPermission" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAuthorizationRoleWebApiPermission" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAuthorizationRoleWebApiPermission" } } } } } } }, "/api/ExternalAuthorizationRoleWebApiPermission/GetLookup": { "post": { "tags": [ "ExternalAuthorizationRoleWebApiPermission" ], "summary": "ExternalAuthorizationRoleWebApiPermission: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAuthorizationRoleWebApiPermission-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAuthorizationRoleWebApiPermission_GetLookup_F717D241C2BC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ExternalAuthorizationRoleWebApiPermission/GetLookupByValue": { "post": { "tags": [ "ExternalAuthorizationRoleWebApiPermission" ], "summary": "ExternalAuthorizationRoleWebApiPermission: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAuthorizationRoleWebApiPermission-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAuthorizationRoleWebApiPermission_GetLookupByValue_B70C16EE0CD4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ExternalAuthorizationRoleWebApiPermission/Page": { "get": { "tags": [ "ExternalAuthorizationRoleWebApiPermission" ], "summary": "ExternalAuthorizationRoleWebApiPermission: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAuthorizationRoleWebApiPermission-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAuthorizationRoleWebApiPermission_GetPage_E923C8CB19B3", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ExternalAuthorizationRoleWebApiPermission/PageAsc": { "get": { "tags": [ "ExternalAuthorizationRoleWebApiPermission" ], "summary": "ExternalAuthorizationRoleWebApiPermission: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAuthorizationRoleWebApiPermission-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAuthorizationRoleWebApiPermission_GetPageAsc_D3C3FDA7AA27", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ExternalAuthorizationRoleWebApiPermission/SearchByValue": { "post": { "tags": [ "ExternalAuthorizationRoleWebApiPermission" ], "summary": "ExternalAuthorizationRoleWebApiPermission: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAuthorizationRoleWebApiPermission-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAuthorizationRoleWebApiPermission_SearchByValue_B04BBBF441F4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ExternalAuthorizationRoleWebApiPermission" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ExternalAuthorizationRoleWebApiPermission" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ExternalAuthorizationRoleWebApiPermission" } } } } } } }, "/api/ExternalAuthorizationRoleWebApiPermission/TryGetByValue": { "post": { "tags": [ "ExternalAuthorizationRoleWebApiPermission" ], "summary": "ExternalAuthorizationRoleWebApiPermission: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAuthorizationRoleWebApiPermission-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAuthorizationRoleWebApiPermission_TryGetByValue_F8C41DDCA417", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAuthorizationRoleWebApiPermission" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAuthorizationRoleWebApiPermission" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAuthorizationRoleWebApiPermission" } } } } } } }, "/api/ExternalAuthorizationRoleWebApiPermission/UpsertGraph": { "put": { "tags": [ "ExternalAuthorizationRoleWebApiPermission" ], "summary": "ExternalAuthorizationRoleWebApiPermission: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAuthorizationRoleWebApiPermission-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAuthorizationRoleWebApiPermission_UpsertGraph_74BB19EF947B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAuthorizationRoleWebApiPermission" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAuthorizationRoleWebApiPermission" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAuthorizationRoleWebApiPermission" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAuthorizationRoleWebApiPermission" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAuthorizationRoleWebApiPermission" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAuthorizationRoleWebApiPermission" } } } } } } }, "/api/ExternalAuthorizationRoleWebApiPermission/UpsertGraphWithExtraFields": { "put": { "tags": [ "ExternalAuthorizationRoleWebApiPermission" ], "summary": "ExternalAuthorizationRoleWebApiPermission: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAuthorizationRoleWebApiPermission-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAuthorizationRoleWebApiPermission_UpsertGraphWithExtraFields_EB11D5CF2E66", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAuthorizationRoleWebApiPermission" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAuthorizationRoleWebApiPermission" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAuthorizationRoleWebApiPermission" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAuthorizationRoleWebApiPermission" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAuthorizationRoleWebApiPermission" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAuthorizationRoleWebApiPermission" } } } } } } }, "/api/ExternalAuthorizationWebApi": { "get": { "tags": [ "ExternalAuthorizationWebApi" ], "summary": "ExternalAuthorizationWebApi: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAuthorizationWebApi-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAuthorizationWebApi_GetAll_920F436ACB95", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAuthorizationWebApi" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAuthorizationWebApi" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAuthorizationWebApi" } } } } } }, "post": { "tags": [ "ExternalAuthorizationWebApi" ], "summary": "ExternalAuthorizationWebApi: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAuthorizationWebApi-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAuthorizationWebApi_Post_7515367D6890", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAuthorizationWebApi" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAuthorizationWebApi" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAuthorizationWebApi" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAuthorizationWebApi" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAuthorizationWebApi" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAuthorizationWebApi" } } } } } }, "put": { "tags": [ "ExternalAuthorizationWebApi" ], "summary": "ExternalAuthorizationWebApi: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAuthorizationWebApi-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAuthorizationWebApi_Put_9DDEF373E6B0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAuthorizationWebApi" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAuthorizationWebApi" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAuthorizationWebApi" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAuthorizationWebApi" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAuthorizationWebApi" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAuthorizationWebApi" } } } } } } }, "/api/ExternalAuthorizationWebApi/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "ExternalAuthorizationWebApi" ], "summary": "ExternalAuthorizationWebApi: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAuthorizationWebApi-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAuthorizationWebApi_GetPageByValue_1E121DB12BA5", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ExternalAuthorizationWebApi/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "ExternalAuthorizationWebApi" ], "summary": "ExternalAuthorizationWebApi: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAuthorizationWebApi-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAuthorizationWebApi_GetPageByValue2_BED728283FAA", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ExternalAuthorizationWebApi/DeleteByFilter": { "post": { "tags": [ "ExternalAuthorizationWebApi" ], "summary": "ExternalAuthorizationWebApi: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAuthorizationWebApi-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAuthorizationWebApi_DeleteByFilter_F78038C953AB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/ExternalAuthorizationWebApi/GetAllByValue": { "post": { "tags": [ "ExternalAuthorizationWebApi" ], "summary": "ExternalAuthorizationWebApi: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAuthorizationWebApi-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAuthorizationWebApi_GetAllByValue_ED18D264E7B5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAuthorizationWebApi" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAuthorizationWebApi" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAuthorizationWebApi" } } } } } } }, "/api/ExternalAuthorizationWebApi/GetAllGraphByValue": { "post": { "tags": [ "ExternalAuthorizationWebApi" ], "summary": "ExternalAuthorizationWebApi: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAuthorizationWebApi-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAuthorizationWebApi_GetAllGraphByValue_C08201DCC8EC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAuthorizationWebApi" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAuthorizationWebApi" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAuthorizationWebApi" } } } } } } }, "/api/ExternalAuthorizationWebApi/GetByValue": { "post": { "tags": [ "ExternalAuthorizationWebApi" ], "summary": "ExternalAuthorizationWebApi: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAuthorizationWebApi-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAuthorizationWebApi_GetByValue_5826FE7047EB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAuthorizationWebApi" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAuthorizationWebApi" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAuthorizationWebApi" } } } } } } }, "/api/ExternalAuthorizationWebApi/GetLookup": { "post": { "tags": [ "ExternalAuthorizationWebApi" ], "summary": "ExternalAuthorizationWebApi: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAuthorizationWebApi-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAuthorizationWebApi_GetLookup_41A11C58FFE3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ExternalAuthorizationWebApi/GetLookupByValue": { "post": { "tags": [ "ExternalAuthorizationWebApi" ], "summary": "ExternalAuthorizationWebApi: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAuthorizationWebApi-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAuthorizationWebApi_GetLookupByValue_96CBBCA2F665", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ExternalAuthorizationWebApi/Page": { "get": { "tags": [ "ExternalAuthorizationWebApi" ], "summary": "ExternalAuthorizationWebApi: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAuthorizationWebApi-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAuthorizationWebApi_GetPage_3FC1ED78C55E", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ExternalAuthorizationWebApi/PageAsc": { "get": { "tags": [ "ExternalAuthorizationWebApi" ], "summary": "ExternalAuthorizationWebApi: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAuthorizationWebApi-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAuthorizationWebApi_GetPageAsc_0E5870B0EC04", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ExternalAuthorizationWebApi/SearchByValue": { "post": { "tags": [ "ExternalAuthorizationWebApi" ], "summary": "ExternalAuthorizationWebApi: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAuthorizationWebApi-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAuthorizationWebApi_SearchByValue_BA11995D9D6A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ExternalAuthorizationWebApi" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ExternalAuthorizationWebApi" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ExternalAuthorizationWebApi" } } } } } } }, "/api/ExternalAuthorizationWebApi/TryGetByValue": { "post": { "tags": [ "ExternalAuthorizationWebApi" ], "summary": "ExternalAuthorizationWebApi: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAuthorizationWebApi-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAuthorizationWebApi_TryGetByValue_88A947F9BB83", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAuthorizationWebApi" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAuthorizationWebApi" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAuthorizationWebApi" } } } } } } }, "/api/ExternalAuthorizationWebApi/UpsertGraph": { "put": { "tags": [ "ExternalAuthorizationWebApi" ], "summary": "ExternalAuthorizationWebApi: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAuthorizationWebApi-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAuthorizationWebApi_UpsertGraph_8F2B2A83CD7C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAuthorizationWebApi" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAuthorizationWebApi" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAuthorizationWebApi" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAuthorizationWebApi" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAuthorizationWebApi" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAuthorizationWebApi" } } } } } } }, "/api/ExternalAuthorizationWebApi/UpsertGraphWithExtraFields": { "put": { "tags": [ "ExternalAuthorizationWebApi" ], "summary": "ExternalAuthorizationWebApi: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExternalAuthorizationWebApi-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExternalAuthorizationWebApi_UpsertGraphWithExtraFields_5F8B1B731E03", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAuthorizationWebApi" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAuthorizationWebApi" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAuthorizationWebApi" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAuthorizationWebApi" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAuthorizationWebApi" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAuthorizationWebApi" } } } } } } }, "/api/ExtraApi": { "get": { "tags": [ "ExtraApi" ], "summary": "ExtraApi: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraApi-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraApi_GetAll_007116A6B839", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExtraApi" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExtraApi" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExtraApi" } } } } } }, "post": { "tags": [ "ExtraApi" ], "summary": "ExtraApi: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraApi-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraApi_Post_5BC473393065", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraApi" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraApi" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraApi" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraApi" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraApi" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraApi" } } } } } }, "put": { "tags": [ "ExtraApi" ], "summary": "ExtraApi: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraApi-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraApi_Put_C958252A1FA3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraApi" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraApi" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraApi" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraApi" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraApi" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraApi" } } } } } } }, "/api/ExtraApi/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "ExtraApi" ], "summary": "ExtraApi: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraApi-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraApi_GetPageByValue_4C7217288609", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ExtraApi/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "ExtraApi" ], "summary": "ExtraApi: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraApi-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraApi_GetPageByValue2_FD6AC1885D67", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ExtraApi/DeleteByFilter": { "post": { "tags": [ "ExtraApi" ], "summary": "ExtraApi: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraApi-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraApi_DeleteByFilter_52052BA52513", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/ExtraApi/GetAllByValue": { "post": { "tags": [ "ExtraApi" ], "summary": "ExtraApi: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraApi-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraApi_GetAllByValue_7E3148D525C2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExtraApi" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExtraApi" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExtraApi" } } } } } } }, "/api/ExtraApi/GetAllGraphByValue": { "post": { "tags": [ "ExtraApi" ], "summary": "ExtraApi: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraApi-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraApi_GetAllGraphByValue_9B169B2C3005", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExtraApi" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExtraApi" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExtraApi" } } } } } } }, "/api/ExtraApi/GetByValue": { "post": { "tags": [ "ExtraApi" ], "summary": "ExtraApi: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraApi-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraApi_GetByValue_7775F23A7C4A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraApi" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraApi" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraApi" } } } } } } }, "/api/ExtraApi/GetLookup": { "post": { "tags": [ "ExtraApi" ], "summary": "ExtraApi: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraApi-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraApi_GetLookup_60D04C2B2C12", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ExtraApi/GetLookupByValue": { "post": { "tags": [ "ExtraApi" ], "summary": "ExtraApi: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraApi-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraApi_GetLookupByValue_FD41E9BE89B4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ExtraApi/Page": { "get": { "tags": [ "ExtraApi" ], "summary": "ExtraApi: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraApi-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraApi_GetPage_30CF8F3024A3", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ExtraApi/PageAsc": { "get": { "tags": [ "ExtraApi" ], "summary": "ExtraApi: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraApi-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraApi_GetPageAsc_F4C6DCE955FB", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ExtraApi/SearchByValue": { "post": { "tags": [ "ExtraApi" ], "summary": "ExtraApi: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraApi-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraApi_SearchByValue_C0718ECAFA40", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ExtraApi" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ExtraApi" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ExtraApi" } } } } } } }, "/api/ExtraApi/TryGetByValue": { "post": { "tags": [ "ExtraApi" ], "summary": "ExtraApi: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraApi-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraApi_TryGetByValue_7DADC6DBC5EE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraApi" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraApi" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraApi" } } } } } } }, "/api/ExtraApi/UpsertGraph": { "put": { "tags": [ "ExtraApi" ], "summary": "ExtraApi: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraApi-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraApi_UpsertGraph_2476DB81B3C3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraApi" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraApi" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraApi" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraApi" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraApi" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraApi" } } } } } } }, "/api/ExtraApi/UpsertGraphWithExtraFields": { "put": { "tags": [ "ExtraApi" ], "summary": "ExtraApi: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraApi-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraApi_UpsertGraphWithExtraFields_C766A7ECD60D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExtraApi" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExtraApi" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExtraApi" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExtraApi" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExtraApi" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExtraApi" } } } } } } }, "/api/ExtraCode": { "get": { "tags": [ "ExtraCode" ], "summary": "ExtraCode: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraCode-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraCode_GetAll_D45C14A9984E", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExtraCode" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExtraCode" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExtraCode" } } } } } }, "post": { "tags": [ "ExtraCode" ], "summary": "ExtraCode: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraCode-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraCode_Post_BE993F27F27E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraCode" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraCode" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraCode" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraCode" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraCode" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraCode" } } } } } }, "put": { "tags": [ "ExtraCode" ], "summary": "ExtraCode: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraCode-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraCode_Put_37932F2383E1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraCode" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraCode" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraCode" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraCode" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraCode" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraCode" } } } } } } }, "/api/ExtraCode/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "ExtraCode" ], "summary": "ExtraCode: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraCode-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraCode_GetPageByValue_E5224D403379", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ExtraCode/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "ExtraCode" ], "summary": "ExtraCode: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraCode-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraCode_GetPageByValue2_7193E4D161AD", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ExtraCode/DeleteByFilter": { "post": { "tags": [ "ExtraCode" ], "summary": "ExtraCode: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraCode-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraCode_DeleteByFilter_EBCD70A6996A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/ExtraCode/GetAllByValue": { "post": { "tags": [ "ExtraCode" ], "summary": "ExtraCode: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraCode-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraCode_GetAllByValue_FA97A6F8EC99", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExtraCode" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExtraCode" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExtraCode" } } } } } } }, "/api/ExtraCode/GetAllGraphByValue": { "post": { "tags": [ "ExtraCode" ], "summary": "ExtraCode: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraCode-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraCode_GetAllGraphByValue_85B088E5F21D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExtraCode" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExtraCode" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExtraCode" } } } } } } }, "/api/ExtraCode/GetByValue": { "post": { "tags": [ "ExtraCode" ], "summary": "ExtraCode: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraCode-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraCode_GetByValue_F1CC5EFEB941", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraCode" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraCode" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraCode" } } } } } } }, "/api/ExtraCode/GetLookup": { "post": { "tags": [ "ExtraCode" ], "summary": "ExtraCode: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraCode-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraCode_GetLookup_CD7A8A14BBA3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ExtraCode/GetLookupByValue": { "post": { "tags": [ "ExtraCode" ], "summary": "ExtraCode: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraCode-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraCode_GetLookupByValue_74C5EA2F5A4A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ExtraCode/Page": { "get": { "tags": [ "ExtraCode" ], "summary": "ExtraCode: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraCode-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraCode_GetPage_6CEA4F5A85C5", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ExtraCode/PageAsc": { "get": { "tags": [ "ExtraCode" ], "summary": "ExtraCode: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraCode-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraCode_GetPageAsc_B31922E07108", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ExtraCode/SearchByValue": { "post": { "tags": [ "ExtraCode" ], "summary": "ExtraCode: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraCode-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraCode_SearchByValue_475602F6A60E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ExtraCode" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ExtraCode" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ExtraCode" } } } } } } }, "/api/ExtraCode/TryGetByValue": { "post": { "tags": [ "ExtraCode" ], "summary": "ExtraCode: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraCode-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraCode_TryGetByValue_8F2358C69169", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraCode" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraCode" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraCode" } } } } } } }, "/api/ExtraCode/UpsertGraph": { "put": { "tags": [ "ExtraCode" ], "summary": "ExtraCode: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraCode-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraCode_UpsertGraph_E2726F8A7873", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraCode" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraCode" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraCode" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraCode" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraCode" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraCode" } } } } } } }, "/api/ExtraCode/UpsertGraphWithExtraFields": { "put": { "tags": [ "ExtraCode" ], "summary": "ExtraCode: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraCode-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraCode_UpsertGraphWithExtraFields_52500D28BD9A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExtraCode" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExtraCode" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExtraCode" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExtraCode" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExtraCode" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExtraCode" } } } } } } }, "/api/ExtraField": { "get": { "tags": [ "ExtraField" ], "summary": "ExtraField: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraField-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraField_GetAll_8B55BB000785", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExtraField" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExtraField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExtraField" } } } } } }, "post": { "tags": [ "ExtraField" ], "summary": "ExtraField: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraField-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraField_Post_8E2D5FF769A9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraField" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraField" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraField" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraField" } } } } } }, "put": { "tags": [ "ExtraField" ], "summary": "ExtraField: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraField-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraField_Put_D1B8AF2121C8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraField" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraField" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraField" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraField" } } } } } } }, "/api/ExtraField/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "ExtraField" ], "summary": "ExtraField: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraField-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraField_GetPageByValue_E32DE4060B1A", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ExtraField/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "ExtraField" ], "summary": "ExtraField: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraField-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraField_GetPageByValue2_EC443F5AD7E9", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ExtraField/AddField": { "post": { "tags": [ "ExtraField" ], "summary": "ExtraField: AddExtraField", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraField-Create.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraField_AddExtraField_B339D97F2A99", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraField" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraField" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.String" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.String" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.String" } } } } } } }, "/api/ExtraField/AlterField": { "post": { "tags": [ "ExtraField" ], "summary": "ExtraField: AlterExtraField", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraField-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraField_AlterExtraField_87D6555C7270", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraField" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraField" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.String" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.String" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.String" } } } } } } }, "/api/ExtraField/ApplyDefaultConstraint": { "post": { "tags": [ "ExtraField" ], "summary": "ExtraField: ApplyDefaultConstraint", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraField-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraField_ApplyDefaultConstraint_1076448D8A81", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraField" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraField" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/ExtraField/ApplyMandatory": { "post": { "tags": [ "ExtraField" ], "summary": "ExtraField: ApplyMadatoryClause", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraField-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraField_ApplyMadatoryClause_074A955F0AC0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraField" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraField" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/ExtraField/ApplyUniqueConstraint": { "post": { "tags": [ "ExtraField" ], "summary": "ExtraField: ApplyUniqueConstraint", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraField-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraField_ApplyUniqueConstraint_5E23780ECB8F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraField" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraField" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/ExtraField/DeleteByFilter": { "post": { "tags": [ "ExtraField" ], "summary": "ExtraField: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraField-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraField_DeleteByFilter_D332A9F77128", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/ExtraField/DeleteField": { "post": { "tags": [ "ExtraField" ], "summary": "ExtraField: DeleteExtraField", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraField-Delete.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraField_DeleteExtraField_61D52653CF2A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraField" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraField" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/ExtraField/DropDefaultConstraint": { "post": { "tags": [ "ExtraField" ], "summary": "ExtraField: DropDefaultConstraint", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraField-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraField_DropDefaultConstraint_546C499A9EB6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraField" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraField" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/ExtraField/DropMandatory": { "post": { "tags": [ "ExtraField" ], "summary": "ExtraField: DropMadatoryClause", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraField-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraField_DropMadatoryClause_88A7DFC296A8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraField" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraField" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/ExtraField/DropUniqueConstraint": { "post": { "tags": [ "ExtraField" ], "summary": "ExtraField: DropUniqueConstraint", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraField-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraField_DropUniqueConstraint_86112E44DC6C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraField" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraField" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/ExtraField/GetAllByValue": { "post": { "tags": [ "ExtraField" ], "summary": "ExtraField: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraField-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraField_GetAllByValue_19D1132CAA60", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExtraField" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExtraField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExtraField" } } } } } } }, "/api/ExtraField/GetAllGraphByValue": { "post": { "tags": [ "ExtraField" ], "summary": "ExtraField: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraField-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraField_GetAllGraphByValue_BFBAC490CF2D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExtraField" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExtraField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExtraField" } } } } } } }, "/api/ExtraField/GetByValue": { "post": { "tags": [ "ExtraField" ], "summary": "ExtraField: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraField-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraField_GetByValue_BCF04081F2CA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraField" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraField" } } } } } } }, "/api/ExtraField/GetExtraFields/{tableName}": { "get": { "tags": [ "ExtraField" ], "summary": "ExtraField: GetExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraField-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraField_GetExtraFields_1BB2BABB747B", "parameters": [ { "name": "tableName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraField" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraField" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraField" } } } } } } } }, "/api/ExtraField/GetLookup": { "post": { "tags": [ "ExtraField" ], "summary": "ExtraField: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraField-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraField_GetLookup_8EAEDED9B837", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ExtraField/GetLookupByValue": { "post": { "tags": [ "ExtraField" ], "summary": "ExtraField: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraField-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraField_GetLookupByValue_48DF62524053", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ExtraField/HasDuplicates": { "post": { "tags": [ "ExtraField" ], "summary": "ExtraField: HasDuplicates", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraField-Read.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraField_HasDuplicates_C956E6473CA5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraField" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraField" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/ExtraField/Page": { "get": { "tags": [ "ExtraField" ], "summary": "ExtraField: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraField-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraField_GetPage_C012BA1C3769", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ExtraField/PageAsc": { "get": { "tags": [ "ExtraField" ], "summary": "ExtraField: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraField-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraField_GetPageAsc_9CA83DC29142", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ExtraField/SaveField": { "post": { "tags": [ "ExtraField" ], "summary": "ExtraField: SaveExtraField", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraField-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraField_SaveExtraField_DB0E31D3448A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraField" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraField" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraField" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraField" } } } } } } }, "/api/ExtraField/SearchByValue": { "post": { "tags": [ "ExtraField" ], "summary": "ExtraField: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraField-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraField_SearchByValue_A29BF507719E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ExtraField" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ExtraField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ExtraField" } } } } } } }, "/api/ExtraField/SetDefaultValue": { "post": { "tags": [ "ExtraField" ], "summary": "ExtraField: UpdateWithDefault", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraField-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraField_UpdateWithDefault_4AF0CB399A59", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraField" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraField" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/ExtraField/TryGetByValue": { "post": { "tags": [ "ExtraField" ], "summary": "ExtraField: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraField-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraField_TryGetByValue_6DFB7AA0F471", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraField" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraField" } } } } } } }, "/api/ExtraField/UpsertGraph": { "put": { "tags": [ "ExtraField" ], "summary": "ExtraField: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraField-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraField_UpsertGraph_490E448737DF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraField" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraField" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraField" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraField" } } } } } } }, "/api/ExtraField/UpsertGraphWithExtraFields": { "put": { "tags": [ "ExtraField" ], "summary": "ExtraField: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraField-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraField_UpsertGraphWithExtraFields_1706F16A814F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExtraField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExtraField" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExtraField" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExtraField" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExtraField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExtraField" } } } } } } }, "/api/ExtraField/ValidateField/{tablename}/{fieldname}": { "get": { "tags": [ "ExtraField" ], "summary": "ExtraField: ValidateField", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraField-Read.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraField_ValidateField_2A4D80284B95", "parameters": [ { "name": "tablename", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "fieldname", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ExtraPage": { "get": { "tags": [ "ExtraPage" ], "summary": "ExtraPage: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraPage-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraPage_GetAll_58F0D90B4C64", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExtraPage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExtraPage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExtraPage" } } } } } }, "post": { "tags": [ "ExtraPage" ], "summary": "ExtraPage: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraPage-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraPage_Post_B7314150EAB1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraPage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraPage" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraPage" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraPage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraPage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraPage" } } } } } }, "put": { "tags": [ "ExtraPage" ], "summary": "ExtraPage: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraPage-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraPage_Put_6F9B1D316306", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraPage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraPage" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraPage" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraPage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraPage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraPage" } } } } } } }, "/api/ExtraPage/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "ExtraPage" ], "summary": "ExtraPage: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraPage-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraPage_GetPageByValue_3FEFFCAC2CD0", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ExtraPage/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "ExtraPage" ], "summary": "ExtraPage: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraPage-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraPage_GetPageByValue2_3746B2ACD596", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ExtraPage/DeleteByFilter": { "post": { "tags": [ "ExtraPage" ], "summary": "ExtraPage: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraPage-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraPage_DeleteByFilter_F6681C96B946", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/ExtraPage/GetAllByValue": { "post": { "tags": [ "ExtraPage" ], "summary": "ExtraPage: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraPage-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraPage_GetAllByValue_CACBBE7AAE52", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExtraPage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExtraPage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExtraPage" } } } } } } }, "/api/ExtraPage/GetAllGraphByValue": { "post": { "tags": [ "ExtraPage" ], "summary": "ExtraPage: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraPage-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraPage_GetAllGraphByValue_B90C08CCDB78", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExtraPage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExtraPage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExtraPage" } } } } } } }, "/api/ExtraPage/GetByValue": { "post": { "tags": [ "ExtraPage" ], "summary": "ExtraPage: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraPage-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraPage_GetByValue_A7AA10827826", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraPage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraPage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraPage" } } } } } } }, "/api/ExtraPage/GetLookup": { "post": { "tags": [ "ExtraPage" ], "summary": "ExtraPage: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraPage-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraPage_GetLookup_B86B678D03E8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ExtraPage/GetLookupByValue": { "post": { "tags": [ "ExtraPage" ], "summary": "ExtraPage: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraPage-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraPage_GetLookupByValue_BF6A6A2178CF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ExtraPage/Page": { "get": { "tags": [ "ExtraPage" ], "summary": "ExtraPage: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraPage-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraPage_GetPage_6AD09CF92D7A", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ExtraPage/PageAsc": { "get": { "tags": [ "ExtraPage" ], "summary": "ExtraPage: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraPage-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraPage_GetPageAsc_7687607D8179", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ExtraPage/SearchByValue": { "post": { "tags": [ "ExtraPage" ], "summary": "ExtraPage: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraPage-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraPage_SearchByValue_340F4278E026", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ExtraPage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ExtraPage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ExtraPage" } } } } } } }, "/api/ExtraPage/TryGetByValue": { "post": { "tags": [ "ExtraPage" ], "summary": "ExtraPage: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraPage-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraPage_TryGetByValue_22750E3A849F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraPage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraPage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraPage" } } } } } } }, "/api/ExtraPage/UpsertGraph": { "put": { "tags": [ "ExtraPage" ], "summary": "ExtraPage: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraPage-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraPage_UpsertGraph_E579D5FE9658", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraPage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraPage" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraPage" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraPage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraPage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraPage" } } } } } } }, "/api/ExtraPage/UpsertGraphWithExtraFields": { "put": { "tags": [ "ExtraPage" ], "summary": "ExtraPage: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraPage-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraPage_UpsertGraphWithExtraFields_967081743A81", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExtraPage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExtraPage" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExtraPage" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExtraPage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExtraPage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExtraPage" } } } } } } }, "/api/ExtraPlugin": { "get": { "tags": [ "ExtraPlugin" ], "summary": "ExtraPlugin: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraPlugin-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraPlugin_GetAll_A4B392670E65", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExtraPlugin" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExtraPlugin" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExtraPlugin" } } } } } }, "post": { "tags": [ "ExtraPlugin" ], "summary": "ExtraPlugin: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraPlugin-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraPlugin_Post_F326E55A24CB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraPlugin" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraPlugin" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraPlugin" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraPlugin" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraPlugin" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraPlugin" } } } } } }, "put": { "tags": [ "ExtraPlugin" ], "summary": "ExtraPlugin: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraPlugin-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraPlugin_Put_33E62896993B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraPlugin" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraPlugin" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraPlugin" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraPlugin" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraPlugin" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraPlugin" } } } } } } }, "/api/ExtraPlugin/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "ExtraPlugin" ], "summary": "ExtraPlugin: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraPlugin-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraPlugin_GetPageByValue_1E1D54E6320F", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ExtraPlugin/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "ExtraPlugin" ], "summary": "ExtraPlugin: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraPlugin-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraPlugin_GetPageByValue2_FA93E3541CA8", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ExtraPlugin/DeleteByFilter": { "post": { "tags": [ "ExtraPlugin" ], "summary": "ExtraPlugin: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraPlugin-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraPlugin_DeleteByFilter_14152D0656E1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/ExtraPlugin/GetAllByValue": { "post": { "tags": [ "ExtraPlugin" ], "summary": "ExtraPlugin: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraPlugin-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraPlugin_GetAllByValue_866F17DA6654", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExtraPlugin" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExtraPlugin" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExtraPlugin" } } } } } } }, "/api/ExtraPlugin/GetAllGraphByValue": { "post": { "tags": [ "ExtraPlugin" ], "summary": "ExtraPlugin: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraPlugin-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraPlugin_GetAllGraphByValue_2B0E7AE9F204", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExtraPlugin" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExtraPlugin" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExtraPlugin" } } } } } } }, "/api/ExtraPlugin/GetByValue": { "post": { "tags": [ "ExtraPlugin" ], "summary": "ExtraPlugin: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraPlugin-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraPlugin_GetByValue_AAED6E1B680F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraPlugin" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraPlugin" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraPlugin" } } } } } } }, "/api/ExtraPlugin/GetLookup": { "post": { "tags": [ "ExtraPlugin" ], "summary": "ExtraPlugin: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraPlugin-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraPlugin_GetLookup_E088D66E0234", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ExtraPlugin/GetLookupByValue": { "post": { "tags": [ "ExtraPlugin" ], "summary": "ExtraPlugin: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraPlugin-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraPlugin_GetLookupByValue_236E38ADDCED", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ExtraPlugin/Page": { "get": { "tags": [ "ExtraPlugin" ], "summary": "ExtraPlugin: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraPlugin-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraPlugin_GetPage_C8AE546A6830", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ExtraPlugin/PageAsc": { "get": { "tags": [ "ExtraPlugin" ], "summary": "ExtraPlugin: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraPlugin-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraPlugin_GetPageAsc_8C91B2453B43", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ExtraPlugin/SearchByValue": { "post": { "tags": [ "ExtraPlugin" ], "summary": "ExtraPlugin: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraPlugin-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraPlugin_SearchByValue_14D103A5A964", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ExtraPlugin" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ExtraPlugin" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ExtraPlugin" } } } } } } }, "/api/ExtraPlugin/TryGetByValue": { "post": { "tags": [ "ExtraPlugin" ], "summary": "ExtraPlugin: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraPlugin-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraPlugin_TryGetByValue_0ED473CA2143", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraPlugin" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraPlugin" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraPlugin" } } } } } } }, "/api/ExtraPlugin/UpsertGraph": { "put": { "tags": [ "ExtraPlugin" ], "summary": "ExtraPlugin: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraPlugin-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraPlugin_UpsertGraph_A17B816F9C57", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraPlugin" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraPlugin" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraPlugin" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraPlugin" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraPlugin" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraPlugin" } } } } } } }, "/api/ExtraPlugin/UpsertGraphWithExtraFields": { "put": { "tags": [ "ExtraPlugin" ], "summary": "ExtraPlugin: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraPlugin-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraPlugin_UpsertGraphWithExtraFields_58BFF0B7DD69", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExtraPlugin" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExtraPlugin" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExtraPlugin" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExtraPlugin" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExtraPlugin" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExtraPlugin" } } } } } } }, "/api/ExtraTable": { "get": { "tags": [ "ExtraTable" ], "summary": "ExtraTable: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraTable_GetAll_D0C5E0780E67", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExtraTable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExtraTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExtraTable" } } } } } }, "post": { "tags": [ "ExtraTable" ], "summary": "ExtraTable: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraTable-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraTable_Post_6C0A9BC31B81", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraTable" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraTable" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraTable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraTable" } } } } } }, "put": { "tags": [ "ExtraTable" ], "summary": "ExtraTable: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraTable-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraTable_Put_17C763434557", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraTable" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraTable" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraTable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraTable" } } } } } } }, "/api/ExtraTable/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "ExtraTable" ], "summary": "ExtraTable: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraTable_GetPageByValue_07E0F3EEEE8C", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ExtraTable/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "ExtraTable" ], "summary": "ExtraTable: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraTable_GetPageByValue2_47296443AD06", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ExtraTable/CreateTable": { "post": { "tags": [ "ExtraTable" ], "summary": "ExtraTable: CreateTable", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraTable-Create.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraTable_CreateTable_A6667D3A946B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraTable" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraTable" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.String" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.String" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.String" } } } } } } }, "/api/ExtraTable/DeleteAuthRolePagePerRow": { "post": { "tags": [ "ExtraTable" ], "summary": "ExtraTable: DeleteAuthRolePagePermission", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraTable-Delete.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraTable_DeleteAuthRolePagePermission_601DDD529CEB", "requestBody": { "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } }, "text/json": { "schema": { "type": "integer", "format": "int32" } }, "application/*+json": { "schema": { "type": "integer", "format": "int32" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.String" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.String" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.String" } } } } } } }, "/api/ExtraTable/DeleteByFilter": { "post": { "tags": [ "ExtraTable" ], "summary": "ExtraTable: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraTable-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraTable_DeleteByFilter_188C3C87F3A4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/ExtraTable/DeleteTable": { "post": { "tags": [ "ExtraTable" ], "summary": "ExtraTable: DeleteExtraTable", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraTable-Delete.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraTable_DeleteExtraTable_0FA3C368DB97", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraTable" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraTable" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/ExtraTable/DropTable": { "post": { "tags": [ "ExtraTable" ], "summary": "ExtraTable: DropTable", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraTable-Delete.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraTable_DropTable_9134ECEAF1AE", "requestBody": { "content": { "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } }, "application/*+json": { "schema": { "type": "string" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.String" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.String" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.String" } } } } } } }, "/api/ExtraTable/GetAllByValue": { "post": { "tags": [ "ExtraTable" ], "summary": "ExtraTable: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraTable_GetAllByValue_C43F1F583872", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExtraTable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExtraTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExtraTable" } } } } } } }, "/api/ExtraTable/GetAllGraphByValue": { "post": { "tags": [ "ExtraTable" ], "summary": "ExtraTable: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraTable_GetAllGraphByValue_EA7796846306", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExtraTable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExtraTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExtraTable" } } } } } } }, "/api/ExtraTable/GetByValue": { "post": { "tags": [ "ExtraTable" ], "summary": "ExtraTable: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraTable_GetByValue_FCE29C84CA62", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraTable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraTable" } } } } } } }, "/api/ExtraTable/GetLookup": { "post": { "tags": [ "ExtraTable" ], "summary": "ExtraTable: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraTable_GetLookup_35403E6BC9C8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ExtraTable/GetLookupByValue": { "post": { "tags": [ "ExtraTable" ], "summary": "ExtraTable: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraTable_GetLookupByValue_C65BE5428690", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ExtraTable/HasNameUniqueConstraint": { "post": { "tags": [ "ExtraTable" ], "summary": "ExtraTable: HasNameUniqueConstraint", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraTable-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraTable_HasNameUniqueConstraint_A0828CE15C3A", "requestBody": { "content": { "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } }, "application/*+json": { "schema": { "type": "string" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/ExtraTable/Page": { "get": { "tags": [ "ExtraTable" ], "summary": "ExtraTable: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraTable_GetPage_F3756B340F19", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ExtraTable/PageAsc": { "get": { "tags": [ "ExtraTable" ], "summary": "ExtraTable: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraTable_GetPageAsc_0D37C462FE87", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ExtraTable/SaveTable": { "post": { "tags": [ "ExtraTable" ], "summary": "ExtraTable: SaveExtraTable", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraTable-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraTable_SaveExtraTable_ABC75E65974E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraTable" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraTable" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraTable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraTable" } } } } } } }, "/api/ExtraTable/SearchByValue": { "post": { "tags": [ "ExtraTable" ], "summary": "ExtraTable: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraTable_SearchByValue_E5A79D36B53E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ExtraTable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ExtraTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ExtraTable" } } } } } } }, "/api/ExtraTable/TryGetByValue": { "post": { "tags": [ "ExtraTable" ], "summary": "ExtraTable: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraTable_TryGetByValue_1C43065F4F42", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraTable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraTable" } } } } } } }, "/api/ExtraTable/UpsertGraph": { "put": { "tags": [ "ExtraTable" ], "summary": "ExtraTable: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraTable-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraTable_UpsertGraph_B3F29AD88283", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraTable" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraTable" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraTable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraTable" } } } } } } }, "/api/ExtraTable/UpsertGraphWithExtraFields": { "put": { "tags": [ "ExtraTable" ], "summary": "ExtraTable: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraTable-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraTable_UpsertGraphWithExtraFields_EEE1DCD4A538", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExtraTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExtraTable" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExtraTable" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExtraTable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExtraTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExtraTable" } } } } } } }, "/api/ExtraTableIndexType": { "get": { "tags": [ "ExtraTableIndexType" ], "summary": "ExtraTableIndexType: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraTableIndexType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraTableIndexType_GetAll_93A8F018855C", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExtraTableIndexType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExtraTableIndexType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExtraTableIndexType" } } } } } }, "post": { "tags": [ "ExtraTableIndexType" ], "summary": "ExtraTableIndexType: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraTableIndexType-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraTableIndexType_Post_79FFAD5AFDC2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraTableIndexType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraTableIndexType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraTableIndexType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraTableIndexType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraTableIndexType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraTableIndexType" } } } } } }, "put": { "tags": [ "ExtraTableIndexType" ], "summary": "ExtraTableIndexType: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraTableIndexType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraTableIndexType_Put_F7FFBB425230", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraTableIndexType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraTableIndexType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraTableIndexType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraTableIndexType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraTableIndexType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraTableIndexType" } } } } } } }, "/api/ExtraTableIndexType/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "ExtraTableIndexType" ], "summary": "ExtraTableIndexType: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraTableIndexType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraTableIndexType_GetPageByValue_B9D74D5CC2CE", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ExtraTableIndexType/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "ExtraTableIndexType" ], "summary": "ExtraTableIndexType: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraTableIndexType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraTableIndexType_GetPageByValue2_C1B633066C31", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ExtraTableIndexType/DeleteByFilter": { "post": { "tags": [ "ExtraTableIndexType" ], "summary": "ExtraTableIndexType: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraTableIndexType-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraTableIndexType_DeleteByFilter_2F242E5A02BB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/ExtraTableIndexType/GetAllByValue": { "post": { "tags": [ "ExtraTableIndexType" ], "summary": "ExtraTableIndexType: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraTableIndexType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraTableIndexType_GetAllByValue_5C34B9305522", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExtraTableIndexType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExtraTableIndexType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExtraTableIndexType" } } } } } } }, "/api/ExtraTableIndexType/GetAllGraphByValue": { "post": { "tags": [ "ExtraTableIndexType" ], "summary": "ExtraTableIndexType: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraTableIndexType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraTableIndexType_GetAllGraphByValue_1469EA136664", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExtraTableIndexType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExtraTableIndexType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExtraTableIndexType" } } } } } } }, "/api/ExtraTableIndexType/GetByValue": { "post": { "tags": [ "ExtraTableIndexType" ], "summary": "ExtraTableIndexType: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraTableIndexType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraTableIndexType_GetByValue_534490BF0457", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraTableIndexType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraTableIndexType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraTableIndexType" } } } } } } }, "/api/ExtraTableIndexType/GetLookup": { "post": { "tags": [ "ExtraTableIndexType" ], "summary": "ExtraTableIndexType: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraTableIndexType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraTableIndexType_GetLookup_981F4E49374B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ExtraTableIndexType/GetLookupByValue": { "post": { "tags": [ "ExtraTableIndexType" ], "summary": "ExtraTableIndexType: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraTableIndexType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraTableIndexType_GetLookupByValue_0BAFF3719228", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ExtraTableIndexType/Page": { "get": { "tags": [ "ExtraTableIndexType" ], "summary": "ExtraTableIndexType: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraTableIndexType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraTableIndexType_GetPage_65DBB25425E6", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ExtraTableIndexType/PageAsc": { "get": { "tags": [ "ExtraTableIndexType" ], "summary": "ExtraTableIndexType: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraTableIndexType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraTableIndexType_GetPageAsc_7820363F721F", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ExtraTableIndexType/SearchByValue": { "post": { "tags": [ "ExtraTableIndexType" ], "summary": "ExtraTableIndexType: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraTableIndexType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraTableIndexType_SearchByValue_92D933522092", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ExtraTableIndexType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ExtraTableIndexType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ExtraTableIndexType" } } } } } } }, "/api/ExtraTableIndexType/TryGetByValue": { "post": { "tags": [ "ExtraTableIndexType" ], "summary": "ExtraTableIndexType: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraTableIndexType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraTableIndexType_TryGetByValue_272DB5D852F7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraTableIndexType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraTableIndexType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraTableIndexType" } } } } } } }, "/api/ExtraTableIndexType/UpsertGraph": { "put": { "tags": [ "ExtraTableIndexType" ], "summary": "ExtraTableIndexType: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraTableIndexType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraTableIndexType_UpsertGraph_65E1568C2142", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraTableIndexType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraTableIndexType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraTableIndexType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraTableIndexType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraTableIndexType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraTableIndexType" } } } } } } }, "/api/ExtraTableIndexType/UpsertGraphWithExtraFields": { "put": { "tags": [ "ExtraTableIndexType" ], "summary": "ExtraTableIndexType: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ExtraTableIndexType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ExtraTableIndexType_UpsertGraphWithExtraFields_B4FC7FA909A4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExtraTableIndexType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExtraTableIndexType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExtraTableIndexType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExtraTableIndexType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExtraTableIndexType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExtraTableIndexType" } } } } } } }, "/api/FieldService": { "get": { "tags": [ "FieldService" ], "summary": "FieldService: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FieldService-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FieldService_GetAll_351FDEB52EF2", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FieldService" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FieldService" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FieldService" } } } } } }, "post": { "tags": [ "FieldService" ], "summary": "FieldService: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FieldService-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FieldService_Post_02044E5074BD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FieldService" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FieldService" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FieldService" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FieldService" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FieldService" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FieldService" } } } } } }, "put": { "tags": [ "FieldService" ], "summary": "FieldService: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FieldService-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FieldService_Put_025D19A9351E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FieldService" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FieldService" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FieldService" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FieldService" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FieldService" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FieldService" } } } } } } }, "/api/FieldService/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "FieldService" ], "summary": "FieldService: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FieldService-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FieldService_GetPageByValue_4868C38DB33C", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FieldService/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "FieldService" ], "summary": "FieldService: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FieldService-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FieldService_GetPageByValue2_219A3F362F41", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FieldService/DeleteByFilter": { "post": { "tags": [ "FieldService" ], "summary": "FieldService: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FieldService-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FieldService_DeleteByFilter_47E7302A1E94", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/FieldService/GetAllByValue": { "post": { "tags": [ "FieldService" ], "summary": "FieldService: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FieldService-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FieldService_GetAllByValue_57C98816AE27", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FieldService" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FieldService" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FieldService" } } } } } } }, "/api/FieldService/GetAllGraphByValue": { "post": { "tags": [ "FieldService" ], "summary": "FieldService: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FieldService-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FieldService_GetAllGraphByValue_19849A8C658E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FieldService" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FieldService" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FieldService" } } } } } } }, "/api/FieldService/GetByValue": { "post": { "tags": [ "FieldService" ], "summary": "FieldService: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FieldService-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FieldService_GetByValue_0F7E291C12D4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FieldService" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FieldService" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FieldService" } } } } } } }, "/api/FieldService/GetFieldServiceGanttData": { "get": { "tags": [ "FieldService" ], "summary": "FieldService: GetFieldServiceGanttData", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FieldService-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FieldService_GetFieldServiceGanttData_B90B7D991CBF", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Dto.FieldServiceDTO" } } } }, "application/json": { "schema": { "type": "array", "items": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Dto.FieldServiceDTO" } } } }, "text/json": { "schema": { "type": "array", "items": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Dto.FieldServiceDTO" } } } } } } } } }, "/api/FieldService/GetLookup": { "post": { "tags": [ "FieldService" ], "summary": "FieldService: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FieldService-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FieldService_GetLookup_0C205D22D553", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FieldService/GetLookupByValue": { "post": { "tags": [ "FieldService" ], "summary": "FieldService: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FieldService-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FieldService_GetLookupByValue_E1419488DA7B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FieldService/Page": { "get": { "tags": [ "FieldService" ], "summary": "FieldService: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FieldService-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FieldService_GetPage_380BC50293E6", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FieldService/PageAsc": { "get": { "tags": [ "FieldService" ], "summary": "FieldService: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FieldService-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FieldService_GetPageAsc_BFEB295E1C35", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FieldService/SearchByValue": { "post": { "tags": [ "FieldService" ], "summary": "FieldService: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FieldService-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FieldService_SearchByValue_4864C89582B2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FieldService" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FieldService" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FieldService" } } } } } } }, "/api/FieldService/Sproc_UpdateField": { "put": { "tags": [ "FieldService" ], "summary": "FieldService: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FieldService-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FieldService_Put_944596484E0D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FieldService_Sproc_UpdateField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FieldService_Sproc_UpdateField" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FieldService_Sproc_UpdateField" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FieldService_Sproc_UpdateField" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FieldService_Sproc_UpdateField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FieldService_Sproc_UpdateField" } } } } } } }, "/api/FieldService/TryGetByValue": { "post": { "tags": [ "FieldService" ], "summary": "FieldService: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FieldService-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FieldService_TryGetByValue_94FDC54B5A47", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FieldService" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FieldService" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FieldService" } } } } } } }, "/api/FieldService/UpsertGraph": { "put": { "tags": [ "FieldService" ], "summary": "FieldService: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FieldService-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FieldService_UpsertGraph_3D574DAE09DB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FieldService" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FieldService" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FieldService" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FieldService" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FieldService" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FieldService" } } } } } } }, "/api/FieldService/UpsertGraphWithExtraFields": { "put": { "tags": [ "FieldService" ], "summary": "FieldService: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FieldService-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FieldService_UpsertGraphWithExtraFields_12A5A343ADCA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FieldService" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FieldService" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FieldService" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FieldService" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FieldService" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FieldService" } } } } } } }, "/api/FieldServiceResource": { "get": { "tags": [ "FieldServiceResource" ], "summary": "FieldServiceResource: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FieldServiceResource-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FieldServiceResource_GetAll_072BC45CED03", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FieldServiceResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FieldServiceResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FieldServiceResource" } } } } } }, "post": { "tags": [ "FieldServiceResource" ], "summary": "FieldServiceResource: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FieldServiceResource-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FieldServiceResource_Post_FB5AC809C8DC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FieldServiceResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FieldServiceResource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FieldServiceResource" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FieldServiceResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FieldServiceResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FieldServiceResource" } } } } } }, "put": { "tags": [ "FieldServiceResource" ], "summary": "FieldServiceResource: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FieldServiceResource-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FieldServiceResource_Put_311DCAE04FD6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FieldServiceResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FieldServiceResource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FieldServiceResource" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FieldServiceResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FieldServiceResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FieldServiceResource" } } } } } } }, "/api/FieldServiceResource/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "FieldServiceResource" ], "summary": "FieldServiceResource: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FieldServiceResource-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FieldServiceResource_GetPageByValue_06619D100F72", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FieldServiceResource/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "FieldServiceResource" ], "summary": "FieldServiceResource: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FieldServiceResource-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FieldServiceResource_GetPageByValue2_394946DF00D6", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FieldServiceResource/DeleteByFilter": { "post": { "tags": [ "FieldServiceResource" ], "summary": "FieldServiceResource: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FieldServiceResource-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FieldServiceResource_DeleteByFilter_1CF108F18296", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/FieldServiceResource/GetAllByValue": { "post": { "tags": [ "FieldServiceResource" ], "summary": "FieldServiceResource: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FieldServiceResource-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FieldServiceResource_GetAllByValue_96FD72110AA6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FieldServiceResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FieldServiceResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FieldServiceResource" } } } } } } }, "/api/FieldServiceResource/GetAllGraphByValue": { "post": { "tags": [ "FieldServiceResource" ], "summary": "FieldServiceResource: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FieldServiceResource-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FieldServiceResource_GetAllGraphByValue_FAF848937AD6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FieldServiceResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FieldServiceResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FieldServiceResource" } } } } } } }, "/api/FieldServiceResource/GetByValue": { "post": { "tags": [ "FieldServiceResource" ], "summary": "FieldServiceResource: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FieldServiceResource-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FieldServiceResource_GetByValue_4E7080BE75D8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FieldServiceResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FieldServiceResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FieldServiceResource" } } } } } } }, "/api/FieldServiceResource/GetLookup": { "post": { "tags": [ "FieldServiceResource" ], "summary": "FieldServiceResource: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FieldServiceResource-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FieldServiceResource_GetLookup_31FA1D6B4C2E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FieldServiceResource/GetLookupByValue": { "post": { "tags": [ "FieldServiceResource" ], "summary": "FieldServiceResource: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FieldServiceResource-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FieldServiceResource_GetLookupByValue_D9FDA80F4C17", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FieldServiceResource/Page": { "get": { "tags": [ "FieldServiceResource" ], "summary": "FieldServiceResource: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FieldServiceResource-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FieldServiceResource_GetPage_A582172F6F4B", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FieldServiceResource/PageAsc": { "get": { "tags": [ "FieldServiceResource" ], "summary": "FieldServiceResource: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FieldServiceResource-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FieldServiceResource_GetPageAsc_021EF92D8601", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FieldServiceResource/SearchByValue": { "post": { "tags": [ "FieldServiceResource" ], "summary": "FieldServiceResource: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FieldServiceResource-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FieldServiceResource_SearchByValue_9D2DD2066CC6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FieldServiceResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FieldServiceResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FieldServiceResource" } } } } } } }, "/api/FieldServiceResource/TryGetByValue": { "post": { "tags": [ "FieldServiceResource" ], "summary": "FieldServiceResource: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FieldServiceResource-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FieldServiceResource_TryGetByValue_BD5965E1B339", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FieldServiceResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FieldServiceResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FieldServiceResource" } } } } } } }, "/api/FieldServiceResource/UpsertGraph": { "put": { "tags": [ "FieldServiceResource" ], "summary": "FieldServiceResource: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FieldServiceResource-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FieldServiceResource_UpsertGraph_A727EEFDA5DB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FieldServiceResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FieldServiceResource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FieldServiceResource" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FieldServiceResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FieldServiceResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FieldServiceResource" } } } } } } }, "/api/FieldServiceResource/UpsertGraphWithExtraFields": { "put": { "tags": [ "FieldServiceResource" ], "summary": "FieldServiceResource: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FieldServiceResource-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FieldServiceResource_UpsertGraphWithExtraFields_562BEFD8B9D7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FieldServiceResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FieldServiceResource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FieldServiceResource" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FieldServiceResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FieldServiceResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FieldServiceResource" } } } } } } }, "/api/FieldServiceResourceGroup": { "get": { "tags": [ "FieldServiceResourceGroup" ], "summary": "FieldServiceResourceGroup: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FieldServiceResourceGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FieldServiceResourceGroup_GetAll_4C3A170B1A61", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FieldServiceResourceGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FieldServiceResourceGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FieldServiceResourceGroup" } } } } } }, "post": { "tags": [ "FieldServiceResourceGroup" ], "summary": "FieldServiceResourceGroup: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FieldServiceResourceGroup-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FieldServiceResourceGroup_Post_D50333FF55CF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FieldServiceResourceGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FieldServiceResourceGroup" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FieldServiceResourceGroup" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FieldServiceResourceGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FieldServiceResourceGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FieldServiceResourceGroup" } } } } } }, "put": { "tags": [ "FieldServiceResourceGroup" ], "summary": "FieldServiceResourceGroup: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FieldServiceResourceGroup-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FieldServiceResourceGroup_Put_6D9524BB79B0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FieldServiceResourceGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FieldServiceResourceGroup" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FieldServiceResourceGroup" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FieldServiceResourceGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FieldServiceResourceGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FieldServiceResourceGroup" } } } } } } }, "/api/FieldServiceResourceGroup/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "FieldServiceResourceGroup" ], "summary": "FieldServiceResourceGroup: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FieldServiceResourceGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FieldServiceResourceGroup_GetPageByValue_9D7C5A003413", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FieldServiceResourceGroup/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "FieldServiceResourceGroup" ], "summary": "FieldServiceResourceGroup: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FieldServiceResourceGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FieldServiceResourceGroup_GetPageByValue2_C4170BC5FC22", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FieldServiceResourceGroup/DeleteByFilter": { "post": { "tags": [ "FieldServiceResourceGroup" ], "summary": "FieldServiceResourceGroup: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FieldServiceResourceGroup-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FieldServiceResourceGroup_DeleteByFilter_BDAFECE08E62", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/FieldServiceResourceGroup/GetAllByValue": { "post": { "tags": [ "FieldServiceResourceGroup" ], "summary": "FieldServiceResourceGroup: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FieldServiceResourceGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FieldServiceResourceGroup_GetAllByValue_DDBBCE49C25F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FieldServiceResourceGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FieldServiceResourceGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FieldServiceResourceGroup" } } } } } } }, "/api/FieldServiceResourceGroup/GetAllGraphByValue": { "post": { "tags": [ "FieldServiceResourceGroup" ], "summary": "FieldServiceResourceGroup: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FieldServiceResourceGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FieldServiceResourceGroup_GetAllGraphByValue_2FF9FD9399F5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FieldServiceResourceGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FieldServiceResourceGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FieldServiceResourceGroup" } } } } } } }, "/api/FieldServiceResourceGroup/GetByValue": { "post": { "tags": [ "FieldServiceResourceGroup" ], "summary": "FieldServiceResourceGroup: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FieldServiceResourceGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FieldServiceResourceGroup_GetByValue_B7620CC16800", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FieldServiceResourceGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FieldServiceResourceGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FieldServiceResourceGroup" } } } } } } }, "/api/FieldServiceResourceGroup/GetLookup": { "post": { "tags": [ "FieldServiceResourceGroup" ], "summary": "FieldServiceResourceGroup: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FieldServiceResourceGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FieldServiceResourceGroup_GetLookup_764230107372", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FieldServiceResourceGroup/GetLookupByValue": { "post": { "tags": [ "FieldServiceResourceGroup" ], "summary": "FieldServiceResourceGroup: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FieldServiceResourceGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FieldServiceResourceGroup_GetLookupByValue_84BB018CE14D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FieldServiceResourceGroup/Page": { "get": { "tags": [ "FieldServiceResourceGroup" ], "summary": "FieldServiceResourceGroup: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FieldServiceResourceGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FieldServiceResourceGroup_GetPage_E92E712FE54D", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FieldServiceResourceGroup/PageAsc": { "get": { "tags": [ "FieldServiceResourceGroup" ], "summary": "FieldServiceResourceGroup: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FieldServiceResourceGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FieldServiceResourceGroup_GetPageAsc_EBE65B9627EC", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FieldServiceResourceGroup/SearchByValue": { "post": { "tags": [ "FieldServiceResourceGroup" ], "summary": "FieldServiceResourceGroup: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FieldServiceResourceGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FieldServiceResourceGroup_SearchByValue_BF2BAD7C0A85", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FieldServiceResourceGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FieldServiceResourceGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FieldServiceResourceGroup" } } } } } } }, "/api/FieldServiceResourceGroup/TryGetByValue": { "post": { "tags": [ "FieldServiceResourceGroup" ], "summary": "FieldServiceResourceGroup: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FieldServiceResourceGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FieldServiceResourceGroup_TryGetByValue_82DEEC048B03", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FieldServiceResourceGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FieldServiceResourceGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FieldServiceResourceGroup" } } } } } } }, "/api/FieldServiceResourceGroup/UpsertGraph": { "put": { "tags": [ "FieldServiceResourceGroup" ], "summary": "FieldServiceResourceGroup: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FieldServiceResourceGroup-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FieldServiceResourceGroup_UpsertGraph_58F40AA6D744", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FieldServiceResourceGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FieldServiceResourceGroup" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FieldServiceResourceGroup" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FieldServiceResourceGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FieldServiceResourceGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FieldServiceResourceGroup" } } } } } } }, "/api/FieldServiceResourceGroup/UpsertGraphWithExtraFields": { "put": { "tags": [ "FieldServiceResourceGroup" ], "summary": "FieldServiceResourceGroup: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FieldServiceResourceGroup-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FieldServiceResourceGroup_UpsertGraphWithExtraFields_F746974F24BD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FieldServiceResourceGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FieldServiceResourceGroup" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FieldServiceResourceGroup" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FieldServiceResourceGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FieldServiceResourceGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FieldServiceResourceGroup" } } } } } } }, "/api/FieldServiceResourceSegment": { "get": { "tags": [ "FieldServiceResourceSegment" ], "summary": "FieldServiceResourceSegment: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FieldServiceResourceSegment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FieldServiceResourceSegment_GetAll_E29C7A0F28E7", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FieldServiceResourceSegment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FieldServiceResourceSegment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FieldServiceResourceSegment" } } } } } }, "post": { "tags": [ "FieldServiceResourceSegment" ], "summary": "FieldServiceResourceSegment: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FieldServiceResourceSegment-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FieldServiceResourceSegment_Post_E90096EB3AAE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FieldServiceResourceSegment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FieldServiceResourceSegment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FieldServiceResourceSegment" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FieldServiceResourceSegment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FieldServiceResourceSegment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FieldServiceResourceSegment" } } } } } }, "put": { "tags": [ "FieldServiceResourceSegment" ], "summary": "FieldServiceResourceSegment: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FieldServiceResourceSegment-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FieldServiceResourceSegment_Put_C1D915BD1952", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FieldServiceResourceSegment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FieldServiceResourceSegment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FieldServiceResourceSegment" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FieldServiceResourceSegment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FieldServiceResourceSegment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FieldServiceResourceSegment" } } } } } } }, "/api/FieldServiceResourceSegment/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "FieldServiceResourceSegment" ], "summary": "FieldServiceResourceSegment: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FieldServiceResourceSegment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FieldServiceResourceSegment_GetPageByValue_E966E05338B5", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FieldServiceResourceSegment/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "FieldServiceResourceSegment" ], "summary": "FieldServiceResourceSegment: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FieldServiceResourceSegment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FieldServiceResourceSegment_GetPageByValue2_E060FF9E2D1F", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FieldServiceResourceSegment/DeleteByFilter": { "post": { "tags": [ "FieldServiceResourceSegment" ], "summary": "FieldServiceResourceSegment: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FieldServiceResourceSegment-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FieldServiceResourceSegment_DeleteByFilter_4FB6B96CBB84", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/FieldServiceResourceSegment/GetAllByValue": { "post": { "tags": [ "FieldServiceResourceSegment" ], "summary": "FieldServiceResourceSegment: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FieldServiceResourceSegment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FieldServiceResourceSegment_GetAllByValue_211795D74695", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FieldServiceResourceSegment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FieldServiceResourceSegment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FieldServiceResourceSegment" } } } } } } }, "/api/FieldServiceResourceSegment/GetAllGraphByValue": { "post": { "tags": [ "FieldServiceResourceSegment" ], "summary": "FieldServiceResourceSegment: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FieldServiceResourceSegment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FieldServiceResourceSegment_GetAllGraphByValue_C67BEB3A8D4E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FieldServiceResourceSegment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FieldServiceResourceSegment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FieldServiceResourceSegment" } } } } } } }, "/api/FieldServiceResourceSegment/GetByValue": { "post": { "tags": [ "FieldServiceResourceSegment" ], "summary": "FieldServiceResourceSegment: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FieldServiceResourceSegment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FieldServiceResourceSegment_GetByValue_64E0B31E1BEA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FieldServiceResourceSegment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FieldServiceResourceSegment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FieldServiceResourceSegment" } } } } } } }, "/api/FieldServiceResourceSegment/GetLookup": { "post": { "tags": [ "FieldServiceResourceSegment" ], "summary": "FieldServiceResourceSegment: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FieldServiceResourceSegment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FieldServiceResourceSegment_GetLookup_86C215E30EF7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FieldServiceResourceSegment/GetLookupByValue": { "post": { "tags": [ "FieldServiceResourceSegment" ], "summary": "FieldServiceResourceSegment: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FieldServiceResourceSegment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FieldServiceResourceSegment_GetLookupByValue_1BB53887B8D7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FieldServiceResourceSegment/Page": { "get": { "tags": [ "FieldServiceResourceSegment" ], "summary": "FieldServiceResourceSegment: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FieldServiceResourceSegment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FieldServiceResourceSegment_GetPage_D84A68875908", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FieldServiceResourceSegment/PageAsc": { "get": { "tags": [ "FieldServiceResourceSegment" ], "summary": "FieldServiceResourceSegment: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FieldServiceResourceSegment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FieldServiceResourceSegment_GetPageAsc_ACEBCDCEA7E9", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FieldServiceResourceSegment/SearchByValue": { "post": { "tags": [ "FieldServiceResourceSegment" ], "summary": "FieldServiceResourceSegment: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FieldServiceResourceSegment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FieldServiceResourceSegment_SearchByValue_84A03838C680", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FieldServiceResourceSegment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FieldServiceResourceSegment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FieldServiceResourceSegment" } } } } } } }, "/api/FieldServiceResourceSegment/TryGetByValue": { "post": { "tags": [ "FieldServiceResourceSegment" ], "summary": "FieldServiceResourceSegment: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FieldServiceResourceSegment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FieldServiceResourceSegment_TryGetByValue_47CF73668EDC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FieldServiceResourceSegment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FieldServiceResourceSegment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FieldServiceResourceSegment" } } } } } } }, "/api/FieldServiceResourceSegment/UpsertGraph": { "put": { "tags": [ "FieldServiceResourceSegment" ], "summary": "FieldServiceResourceSegment: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FieldServiceResourceSegment-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FieldServiceResourceSegment_UpsertGraph_0BE61D9E5F22", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FieldServiceResourceSegment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FieldServiceResourceSegment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FieldServiceResourceSegment" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FieldServiceResourceSegment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FieldServiceResourceSegment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FieldServiceResourceSegment" } } } } } } }, "/api/FieldServiceResourceSegment/UpsertGraphWithExtraFields": { "put": { "tags": [ "FieldServiceResourceSegment" ], "summary": "FieldServiceResourceSegment: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FieldServiceResourceSegment-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FieldServiceResourceSegment_UpsertGraphWithExtraFields_BF82E2FDD706", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FieldServiceResourceSegment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FieldServiceResourceSegment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FieldServiceResourceSegment" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FieldServiceResourceSegment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FieldServiceResourceSegment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FieldServiceResourceSegment" } } } } } } }, "/api/FieldServiceStatus": { "get": { "tags": [ "FieldServiceStatus" ], "summary": "FieldServiceStatus: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FieldServiceStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FieldServiceStatus_GetAll_8CA1AD545BA7", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FieldServiceStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FieldServiceStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FieldServiceStatus" } } } } } }, "post": { "tags": [ "FieldServiceStatus" ], "summary": "FieldServiceStatus: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FieldServiceStatus-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FieldServiceStatus_Post_9BC6CB5BCCB4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FieldServiceStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FieldServiceStatus" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FieldServiceStatus" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FieldServiceStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FieldServiceStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FieldServiceStatus" } } } } } }, "put": { "tags": [ "FieldServiceStatus" ], "summary": "FieldServiceStatus: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FieldServiceStatus-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FieldServiceStatus_Put_A308360018F6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FieldServiceStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FieldServiceStatus" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FieldServiceStatus" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FieldServiceStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FieldServiceStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FieldServiceStatus" } } } } } } }, "/api/FieldServiceStatus/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "FieldServiceStatus" ], "summary": "FieldServiceStatus: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FieldServiceStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FieldServiceStatus_GetPageByValue_122F796E477F", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FieldServiceStatus/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "FieldServiceStatus" ], "summary": "FieldServiceStatus: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FieldServiceStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FieldServiceStatus_GetPageByValue2_9FB289E767BF", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FieldServiceStatus/DeleteByFilter": { "post": { "tags": [ "FieldServiceStatus" ], "summary": "FieldServiceStatus: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FieldServiceStatus-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FieldServiceStatus_DeleteByFilter_F5D5C4A75E28", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/FieldServiceStatus/GetAllByValue": { "post": { "tags": [ "FieldServiceStatus" ], "summary": "FieldServiceStatus: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FieldServiceStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FieldServiceStatus_GetAllByValue_626804F8674D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FieldServiceStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FieldServiceStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FieldServiceStatus" } } } } } } }, "/api/FieldServiceStatus/GetAllGraphByValue": { "post": { "tags": [ "FieldServiceStatus" ], "summary": "FieldServiceStatus: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FieldServiceStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FieldServiceStatus_GetAllGraphByValue_628897626390", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FieldServiceStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FieldServiceStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FieldServiceStatus" } } } } } } }, "/api/FieldServiceStatus/GetByValue": { "post": { "tags": [ "FieldServiceStatus" ], "summary": "FieldServiceStatus: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FieldServiceStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FieldServiceStatus_GetByValue_234DD4A5B45E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FieldServiceStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FieldServiceStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FieldServiceStatus" } } } } } } }, "/api/FieldServiceStatus/GetLookup": { "post": { "tags": [ "FieldServiceStatus" ], "summary": "FieldServiceStatus: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FieldServiceStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FieldServiceStatus_GetLookup_F57E7B176E9C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FieldServiceStatus/GetLookupByValue": { "post": { "tags": [ "FieldServiceStatus" ], "summary": "FieldServiceStatus: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FieldServiceStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FieldServiceStatus_GetLookupByValue_F28781528107", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FieldServiceStatus/Page": { "get": { "tags": [ "FieldServiceStatus" ], "summary": "FieldServiceStatus: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FieldServiceStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FieldServiceStatus_GetPage_E4F4E5C3D308", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FieldServiceStatus/PageAsc": { "get": { "tags": [ "FieldServiceStatus" ], "summary": "FieldServiceStatus: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FieldServiceStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FieldServiceStatus_GetPageAsc_D5FE4492AFAA", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FieldServiceStatus/SearchByValue": { "post": { "tags": [ "FieldServiceStatus" ], "summary": "FieldServiceStatus: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FieldServiceStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FieldServiceStatus_SearchByValue_91ACAD018AB3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FieldServiceStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FieldServiceStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FieldServiceStatus" } } } } } } }, "/api/FieldServiceStatus/TryGetByValue": { "post": { "tags": [ "FieldServiceStatus" ], "summary": "FieldServiceStatus: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FieldServiceStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FieldServiceStatus_TryGetByValue_F6D12CBC1DF5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FieldServiceStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FieldServiceStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FieldServiceStatus" } } } } } } }, "/api/FieldServiceStatus/UpsertGraph": { "put": { "tags": [ "FieldServiceStatus" ], "summary": "FieldServiceStatus: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FieldServiceStatus-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FieldServiceStatus_UpsertGraph_8206D3D92DE3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FieldServiceStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FieldServiceStatus" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FieldServiceStatus" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FieldServiceStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FieldServiceStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FieldServiceStatus" } } } } } } }, "/api/FieldServiceStatus/UpsertGraphWithExtraFields": { "put": { "tags": [ "FieldServiceStatus" ], "summary": "FieldServiceStatus: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FieldServiceStatus-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FieldServiceStatus_UpsertGraphWithExtraFields_FDBCC9EF64DF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FieldServiceStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FieldServiceStatus" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FieldServiceStatus" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FieldServiceStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FieldServiceStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FieldServiceStatus" } } } } } } }, "/api/FinanceAccountAssignment": { "get": { "tags": [ "FinanceAccountAssignment" ], "summary": "FinanceAccountAssignment: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountAssignment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountAssignment_GetAll_DB6F5272628A", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountAssignment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountAssignment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountAssignment" } } } } } }, "post": { "tags": [ "FinanceAccountAssignment" ], "summary": "FinanceAccountAssignment: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountAssignment-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountAssignment_Post_B0511B4B4E9F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountAssignment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountAssignment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountAssignment" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountAssignment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountAssignment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountAssignment" } } } } } }, "put": { "tags": [ "FinanceAccountAssignment" ], "summary": "FinanceAccountAssignment: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountAssignment-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountAssignment_Put_3A2B6B6F7D3F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountAssignment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountAssignment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountAssignment" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountAssignment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountAssignment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountAssignment" } } } } } } }, "/api/FinanceAccountAssignment/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "FinanceAccountAssignment" ], "summary": "FinanceAccountAssignment: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountAssignment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountAssignment_GetPageByValue_9BF9EEBDEEF9", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceAccountAssignment/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "FinanceAccountAssignment" ], "summary": "FinanceAccountAssignment: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountAssignment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountAssignment_GetPageByValue2_CD82B96E0C62", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceAccountAssignment/DeleteByFilter": { "post": { "tags": [ "FinanceAccountAssignment" ], "summary": "FinanceAccountAssignment: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountAssignment-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountAssignment_DeleteByFilter_FBD920C6C58A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/FinanceAccountAssignment/GetAllByValue": { "post": { "tags": [ "FinanceAccountAssignment" ], "summary": "FinanceAccountAssignment: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountAssignment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountAssignment_GetAllByValue_51935D187586", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountAssignment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountAssignment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountAssignment" } } } } } } }, "/api/FinanceAccountAssignment/GetAllGraphByValue": { "post": { "tags": [ "FinanceAccountAssignment" ], "summary": "FinanceAccountAssignment: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountAssignment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountAssignment_GetAllGraphByValue_9BA1FA97EE98", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountAssignment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountAssignment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountAssignment" } } } } } } }, "/api/FinanceAccountAssignment/GetByValue": { "post": { "tags": [ "FinanceAccountAssignment" ], "summary": "FinanceAccountAssignment: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountAssignment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountAssignment_GetByValue_D681A76EAE9D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountAssignment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountAssignment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountAssignment" } } } } } } }, "/api/FinanceAccountAssignment/GetLookup": { "post": { "tags": [ "FinanceAccountAssignment" ], "summary": "FinanceAccountAssignment: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountAssignment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountAssignment_GetLookup_1C674479E897", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceAccountAssignment/GetLookupByValue": { "post": { "tags": [ "FinanceAccountAssignment" ], "summary": "FinanceAccountAssignment: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountAssignment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountAssignment_GetLookupByValue_84D4FC4530C7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceAccountAssignment/Page": { "get": { "tags": [ "FinanceAccountAssignment" ], "summary": "FinanceAccountAssignment: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountAssignment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountAssignment_GetPage_3DE8518A6F70", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceAccountAssignment/PageAsc": { "get": { "tags": [ "FinanceAccountAssignment" ], "summary": "FinanceAccountAssignment: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountAssignment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountAssignment_GetPageAsc_2DAA651ACF9C", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceAccountAssignment/SearchByValue": { "post": { "tags": [ "FinanceAccountAssignment" ], "summary": "FinanceAccountAssignment: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountAssignment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountAssignment_SearchByValue_7409E449CD41", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceAccountAssignment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceAccountAssignment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceAccountAssignment" } } } } } } }, "/api/FinanceAccountAssignment/TryGetByValue": { "post": { "tags": [ "FinanceAccountAssignment" ], "summary": "FinanceAccountAssignment: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountAssignment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountAssignment_TryGetByValue_6ADCD6D3CA21", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountAssignment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountAssignment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountAssignment" } } } } } } }, "/api/FinanceAccountAssignment/UpsertGraph": { "put": { "tags": [ "FinanceAccountAssignment" ], "summary": "FinanceAccountAssignment: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountAssignment-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountAssignment_UpsertGraph_D416B50D5BAA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountAssignment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountAssignment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountAssignment" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountAssignment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountAssignment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountAssignment" } } } } } } }, "/api/FinanceAccountAssignment/UpsertGraphWithExtraFields": { "put": { "tags": [ "FinanceAccountAssignment" ], "summary": "FinanceAccountAssignment: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountAssignment-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountAssignment_UpsertGraphWithExtraFields_261A6CA13ED0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceAccountAssignment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceAccountAssignment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceAccountAssignment" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceAccountAssignment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceAccountAssignment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceAccountAssignment" } } } } } } }, "/api/FinanceAccountCategory": { "get": { "tags": [ "FinanceAccountCategory" ], "summary": "FinanceAccountCategory: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountCategory_GetAll_FDFDD4E0B750", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountCategory" } } } } } }, "post": { "tags": [ "FinanceAccountCategory" ], "summary": "FinanceAccountCategory: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountCategory-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountCategory_Post_195A5A2AD03D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountCategory" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountCategory" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountCategory" } } } } } }, "put": { "tags": [ "FinanceAccountCategory" ], "summary": "FinanceAccountCategory: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountCategory-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountCategory_Put_DEA46F1F5E39", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountCategory" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountCategory" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountCategory" } } } } } } }, "/api/FinanceAccountCategory/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "FinanceAccountCategory" ], "summary": "FinanceAccountCategory: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountCategory_GetPageByValue_02DF15D635F7", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceAccountCategory/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "FinanceAccountCategory" ], "summary": "FinanceAccountCategory: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountCategory_GetPageByValue2_66EBC48043B3", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceAccountCategory/DeleteByFilter": { "post": { "tags": [ "FinanceAccountCategory" ], "summary": "FinanceAccountCategory: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountCategory-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountCategory_DeleteByFilter_DB04AD0C9C30", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/FinanceAccountCategory/GetAllByValue": { "post": { "tags": [ "FinanceAccountCategory" ], "summary": "FinanceAccountCategory: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountCategory_GetAllByValue_7E4B543A7B83", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountCategory" } } } } } } }, "/api/FinanceAccountCategory/GetAllGraphByValue": { "post": { "tags": [ "FinanceAccountCategory" ], "summary": "FinanceAccountCategory: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountCategory_GetAllGraphByValue_2F5B48279544", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountCategory" } } } } } } }, "/api/FinanceAccountCategory/GetByValue": { "post": { "tags": [ "FinanceAccountCategory" ], "summary": "FinanceAccountCategory: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountCategory_GetByValue_E092E8F4C15E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountCategory" } } } } } } }, "/api/FinanceAccountCategory/GetLookup": { "post": { "tags": [ "FinanceAccountCategory" ], "summary": "FinanceAccountCategory: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountCategory_GetLookup_B05023D544C5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceAccountCategory/GetLookupByValue": { "post": { "tags": [ "FinanceAccountCategory" ], "summary": "FinanceAccountCategory: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountCategory_GetLookupByValue_829B10B51994", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceAccountCategory/Page": { "get": { "tags": [ "FinanceAccountCategory" ], "summary": "FinanceAccountCategory: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountCategory_GetPage_353CA76FB373", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceAccountCategory/PageAsc": { "get": { "tags": [ "FinanceAccountCategory" ], "summary": "FinanceAccountCategory: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountCategory_GetPageAsc_9ADF0193D55A", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceAccountCategory/SearchByValue": { "post": { "tags": [ "FinanceAccountCategory" ], "summary": "FinanceAccountCategory: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountCategory_SearchByValue_E0F6978297F9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceAccountCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceAccountCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceAccountCategory" } } } } } } }, "/api/FinanceAccountCategory/TryGetByValue": { "post": { "tags": [ "FinanceAccountCategory" ], "summary": "FinanceAccountCategory: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountCategory_TryGetByValue_EF204EA64C9D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountCategory" } } } } } } }, "/api/FinanceAccountCategory/UpsertGraph": { "put": { "tags": [ "FinanceAccountCategory" ], "summary": "FinanceAccountCategory: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountCategory-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountCategory_UpsertGraph_6C0A32ED7A5C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountCategory" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountCategory" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountCategory" } } } } } } }, "/api/FinanceAccountCategory/UpsertGraphWithExtraFields": { "put": { "tags": [ "FinanceAccountCategory" ], "summary": "FinanceAccountCategory: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountCategory-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountCategory_UpsertGraphWithExtraFields_D76AFC943BC0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceAccountCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceAccountCategory" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceAccountCategory" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceAccountCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceAccountCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceAccountCategory" } } } } } } }, "/api/FinanceAccountDetermination": { "get": { "tags": [ "FinanceAccountDetermination" ], "summary": "FinanceAccountDetermination: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountDetermination-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountDetermination_GetAll_EB105322A065", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountDetermination" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountDetermination" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountDetermination" } } } } } }, "post": { "tags": [ "FinanceAccountDetermination" ], "summary": "FinanceAccountDetermination: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountDetermination-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountDetermination_Post_AA391BBBF1CA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountDetermination" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountDetermination" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountDetermination" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountDetermination" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountDetermination" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountDetermination" } } } } } }, "put": { "tags": [ "FinanceAccountDetermination" ], "summary": "FinanceAccountDetermination: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountDetermination-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountDetermination_Put_8B85B5785279", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountDetermination" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountDetermination" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountDetermination" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountDetermination" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountDetermination" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountDetermination" } } } } } } }, "/api/FinanceAccountDetermination/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "FinanceAccountDetermination" ], "summary": "FinanceAccountDetermination: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountDetermination-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountDetermination_GetPageByValue_659686C7DFA9", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceAccountDetermination/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "FinanceAccountDetermination" ], "summary": "FinanceAccountDetermination: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountDetermination-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountDetermination_GetPageByValue2_81A93DECA0F5", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceAccountDetermination/DeleteByFilter": { "post": { "tags": [ "FinanceAccountDetermination" ], "summary": "FinanceAccountDetermination: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountDetermination-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountDetermination_DeleteByFilter_3B7B38F6A57B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/FinanceAccountDetermination/GetAllByValue": { "post": { "tags": [ "FinanceAccountDetermination" ], "summary": "FinanceAccountDetermination: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountDetermination-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountDetermination_GetAllByValue_44C28285D2FC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountDetermination" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountDetermination" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountDetermination" } } } } } } }, "/api/FinanceAccountDetermination/GetAllGraphByValue": { "post": { "tags": [ "FinanceAccountDetermination" ], "summary": "FinanceAccountDetermination: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountDetermination-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountDetermination_GetAllGraphByValue_EF36E66286E1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountDetermination" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountDetermination" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountDetermination" } } } } } } }, "/api/FinanceAccountDetermination/GetByValue": { "post": { "tags": [ "FinanceAccountDetermination" ], "summary": "FinanceAccountDetermination: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountDetermination-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountDetermination_GetByValue_1424E65A9B38", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountDetermination" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountDetermination" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountDetermination" } } } } } } }, "/api/FinanceAccountDetermination/GetLookup": { "post": { "tags": [ "FinanceAccountDetermination" ], "summary": "FinanceAccountDetermination: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountDetermination-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountDetermination_GetLookup_223B27BB104D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceAccountDetermination/GetLookupByValue": { "post": { "tags": [ "FinanceAccountDetermination" ], "summary": "FinanceAccountDetermination: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountDetermination-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountDetermination_GetLookupByValue_B92F01E17252", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceAccountDetermination/Page": { "get": { "tags": [ "FinanceAccountDetermination" ], "summary": "FinanceAccountDetermination: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountDetermination-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountDetermination_GetPage_B3D552C26709", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceAccountDetermination/PageAsc": { "get": { "tags": [ "FinanceAccountDetermination" ], "summary": "FinanceAccountDetermination: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountDetermination-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountDetermination_GetPageAsc_C5D26E91FC24", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceAccountDetermination/SearchByValue": { "post": { "tags": [ "FinanceAccountDetermination" ], "summary": "FinanceAccountDetermination: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountDetermination-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountDetermination_SearchByValue_86E0BDD9D8E4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceAccountDetermination" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceAccountDetermination" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceAccountDetermination" } } } } } } }, "/api/FinanceAccountDetermination/TryGetByValue": { "post": { "tags": [ "FinanceAccountDetermination" ], "summary": "FinanceAccountDetermination: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountDetermination-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountDetermination_TryGetByValue_D3F298F63DEB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountDetermination" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountDetermination" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountDetermination" } } } } } } }, "/api/FinanceAccountDetermination/UpsertGraph": { "put": { "tags": [ "FinanceAccountDetermination" ], "summary": "FinanceAccountDetermination: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountDetermination-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountDetermination_UpsertGraph_B12BAEE631E1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountDetermination" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountDetermination" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountDetermination" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountDetermination" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountDetermination" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountDetermination" } } } } } } }, "/api/FinanceAccountDetermination/UpsertGraphWithExtraFields": { "put": { "tags": [ "FinanceAccountDetermination" ], "summary": "FinanceAccountDetermination: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountDetermination-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountDetermination_UpsertGraphWithExtraFields_9BE5C88D12EC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceAccountDetermination" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceAccountDetermination" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceAccountDetermination" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceAccountDetermination" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceAccountDetermination" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceAccountDetermination" } } } } } } }, "/api/FinanceAccountGroup": { "get": { "tags": [ "FinanceAccountGroup" ], "summary": "FinanceAccountGroup: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountGroup_GetAll_7761F3A65D59", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountGroup" } } } } } }, "post": { "tags": [ "FinanceAccountGroup" ], "summary": "FinanceAccountGroup: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountGroup-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountGroup_Post_6C5AD0773718", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountGroup" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountGroup" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountGroup" } } } } } }, "put": { "tags": [ "FinanceAccountGroup" ], "summary": "FinanceAccountGroup: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountGroup-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountGroup_Put_76C2570D28E4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountGroup" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountGroup" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountGroup" } } } } } } }, "/api/FinanceAccountGroup/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "FinanceAccountGroup" ], "summary": "FinanceAccountGroup: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountGroup_GetPageByValue_8EF7605D4E80", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceAccountGroup/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "FinanceAccountGroup" ], "summary": "FinanceAccountGroup: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountGroup_GetPageByValue2_6813C86A59B6", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceAccountGroup/DeleteByFilter": { "post": { "tags": [ "FinanceAccountGroup" ], "summary": "FinanceAccountGroup: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountGroup-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountGroup_DeleteByFilter_AE3CAE34A70A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/FinanceAccountGroup/GetAllByValue": { "post": { "tags": [ "FinanceAccountGroup" ], "summary": "FinanceAccountGroup: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountGroup_GetAllByValue_9A17218E1C3C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountGroup" } } } } } } }, "/api/FinanceAccountGroup/GetAllGraphByValue": { "post": { "tags": [ "FinanceAccountGroup" ], "summary": "FinanceAccountGroup: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountGroup_GetAllGraphByValue_F564FB0A1C84", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountGroup" } } } } } } }, "/api/FinanceAccountGroup/GetByValue": { "post": { "tags": [ "FinanceAccountGroup" ], "summary": "FinanceAccountGroup: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountGroup_GetByValue_BCB34B5E8249", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountGroup" } } } } } } }, "/api/FinanceAccountGroup/GetLookup": { "post": { "tags": [ "FinanceAccountGroup" ], "summary": "FinanceAccountGroup: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountGroup_GetLookup_1C4215FA7371", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceAccountGroup/GetLookupByValue": { "post": { "tags": [ "FinanceAccountGroup" ], "summary": "FinanceAccountGroup: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountGroup_GetLookupByValue_8FFD19B0FBCD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceAccountGroup/Page": { "get": { "tags": [ "FinanceAccountGroup" ], "summary": "FinanceAccountGroup: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountGroup_GetPage_C1276424DCF5", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceAccountGroup/PageAsc": { "get": { "tags": [ "FinanceAccountGroup" ], "summary": "FinanceAccountGroup: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountGroup_GetPageAsc_32A9B43139D4", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceAccountGroup/PageFinanceAccountGroupsByParent/{ParentId}/{IncludeSubNodes}/{TopParentsOnly}": { "get": { "tags": [ "FinanceAccountGroup" ], "summary": "FinanceAccountGroup: GetPageFinanceAccountGroupsByParent", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountGroup-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountGroup_GetPageFinanceAccountGroupsByParent_3A620CBC002D", "parameters": [ { "name": "ParentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "IncludeSubNodes", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "TopParentsOnly", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceAccountGroup/SearchByValue": { "post": { "tags": [ "FinanceAccountGroup" ], "summary": "FinanceAccountGroup: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountGroup_SearchByValue_DF2313397D28", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceAccountGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceAccountGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceAccountGroup" } } } } } } }, "/api/FinanceAccountGroup/TryGetByValue": { "post": { "tags": [ "FinanceAccountGroup" ], "summary": "FinanceAccountGroup: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountGroup_TryGetByValue_E9EBA4CD7CC3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountGroup" } } } } } } }, "/api/FinanceAccountGroup/UpsertGraph": { "put": { "tags": [ "FinanceAccountGroup" ], "summary": "FinanceAccountGroup: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountGroup-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountGroup_UpsertGraph_C937852F398F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountGroup" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountGroup" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountGroup" } } } } } } }, "/api/FinanceAccountGroup/UpsertGraphWithExtraFields": { "put": { "tags": [ "FinanceAccountGroup" ], "summary": "FinanceAccountGroup: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountGroup-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountGroup_UpsertGraphWithExtraFields_052E6E2CD1B6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceAccountGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceAccountGroup" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceAccountGroup" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceAccountGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceAccountGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceAccountGroup" } } } } } } }, "/api/FinanceAccountInternalReconciliation": { "get": { "tags": [ "FinanceAccountInternalReconciliation" ], "summary": "FinanceAccountInternalReconciliation: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountInternalReconciliation-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountInternalReconciliation_GetAll_5F6B4AC2E7AF", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountInternalReconciliation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountInternalReconciliation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountInternalReconciliation" } } } } } }, "post": { "tags": [ "FinanceAccountInternalReconciliation" ], "summary": "FinanceAccountInternalReconciliation: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountInternalReconciliation-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountInternalReconciliation_Post_B4E232302491", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountInternalReconciliation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountInternalReconciliation" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountInternalReconciliation" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountInternalReconciliation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountInternalReconciliation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountInternalReconciliation" } } } } } }, "put": { "tags": [ "FinanceAccountInternalReconciliation" ], "summary": "FinanceAccountInternalReconciliation: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountInternalReconciliation-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountInternalReconciliation_Put_7A6D8B2C179F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountInternalReconciliation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountInternalReconciliation" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountInternalReconciliation" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountInternalReconciliation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountInternalReconciliation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountInternalReconciliation" } } } } } } }, "/api/FinanceAccountInternalReconciliation/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "FinanceAccountInternalReconciliation" ], "summary": "FinanceAccountInternalReconciliation: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountInternalReconciliation-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountInternalReconciliation_GetPageByValue_48C6DC470207", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceAccountInternalReconciliation/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "FinanceAccountInternalReconciliation" ], "summary": "FinanceAccountInternalReconciliation: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountInternalReconciliation-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountInternalReconciliation_GetPageByValue2_1384B6026C70", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceAccountInternalReconciliation/DeleteByFilter": { "post": { "tags": [ "FinanceAccountInternalReconciliation" ], "summary": "FinanceAccountInternalReconciliation: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountInternalReconciliation-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountInternalReconciliation_DeleteByFilter_0B1FEC1B01EF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/FinanceAccountInternalReconciliation/GetAllByValue": { "post": { "tags": [ "FinanceAccountInternalReconciliation" ], "summary": "FinanceAccountInternalReconciliation: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountInternalReconciliation-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountInternalReconciliation_GetAllByValue_C62A6F5B9DB8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountInternalReconciliation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountInternalReconciliation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountInternalReconciliation" } } } } } } }, "/api/FinanceAccountInternalReconciliation/GetAllGraphByValue": { "post": { "tags": [ "FinanceAccountInternalReconciliation" ], "summary": "FinanceAccountInternalReconciliation: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountInternalReconciliation-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountInternalReconciliation_GetAllGraphByValue_CD31BB901C91", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountInternalReconciliation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountInternalReconciliation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountInternalReconciliation" } } } } } } }, "/api/FinanceAccountInternalReconciliation/GetAttachmentCount": { "post": { "tags": [ "FinanceAccountInternalReconciliation" ], "summary": "FinanceAccountInternalReconciliation: GetAttachmentCount", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountInternalReconciliation-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountInternalReconciliation_GetAttachmentCount_77D571A8F04E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountInternalReconciliation_GetAttachmentCountRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountInternalReconciliation_GetAttachmentCountRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountInternalReconciliation_GetAttachmentCountRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/FinanceAccountInternalReconciliation/GetByValue": { "post": { "tags": [ "FinanceAccountInternalReconciliation" ], "summary": "FinanceAccountInternalReconciliation: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountInternalReconciliation-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountInternalReconciliation_GetByValue_E94DFA97E167", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountInternalReconciliation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountInternalReconciliation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountInternalReconciliation" } } } } } } }, "/api/FinanceAccountInternalReconciliation/GetLookup": { "post": { "tags": [ "FinanceAccountInternalReconciliation" ], "summary": "FinanceAccountInternalReconciliation: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountInternalReconciliation-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountInternalReconciliation_GetLookup_2B879615CC79", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceAccountInternalReconciliation/GetLookupByValue": { "post": { "tags": [ "FinanceAccountInternalReconciliation" ], "summary": "FinanceAccountInternalReconciliation: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountInternalReconciliation-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountInternalReconciliation_GetLookupByValue_D117C79F54EA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceAccountInternalReconciliation/Page": { "get": { "tags": [ "FinanceAccountInternalReconciliation" ], "summary": "FinanceAccountInternalReconciliation: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountInternalReconciliation-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountInternalReconciliation_GetPage_F9610F3985D6", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceAccountInternalReconciliation/PageAsc": { "get": { "tags": [ "FinanceAccountInternalReconciliation" ], "summary": "FinanceAccountInternalReconciliation: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountInternalReconciliation-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountInternalReconciliation_GetPageAsc_789F4BD2A3EB", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceAccountInternalReconciliation/PageFromView": { "get": { "tags": [ "FinanceAccountInternalReconciliation" ], "summary": "FinanceAccountInternalReconciliation: GetPageFromView", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountInternalReconciliation-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountInternalReconciliation_GetPageFromView_9BB9152B6452", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceAccountInternalReconciliation/ReconciliationCancellation": { "post": { "tags": [ "FinanceAccountInternalReconciliation" ], "summary": "FinanceAccountInternalReconciliation: ReconciliationCancellation", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountInternalReconciliation-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountInternalReconciliation_ReconciliationCancellation_A06A764375B0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountInternalReconciliation_ReconciliationCancellationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountInternalReconciliation_ReconciliationCancellationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountInternalReconciliation_ReconciliationCancellationRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/FinanceAccountInternalReconciliation/SaveAndPostInternalReconciliation": { "post": { "tags": [ "FinanceAccountInternalReconciliation" ], "summary": "FinanceAccountInternalReconciliation: SaveAndPostInternalReconciliation", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountInternalReconciliation-Create.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountInternalReconciliation_SaveAndPostInternalReconciliation_F744B8DCA4CC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountInternalReconciliationPostingDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountInternalReconciliationPostingDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountInternalReconciliationPostingDto" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/FinanceAccountInternalReconciliation/SearchByValue": { "post": { "tags": [ "FinanceAccountInternalReconciliation" ], "summary": "FinanceAccountInternalReconciliation: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountInternalReconciliation-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountInternalReconciliation_SearchByValue_7B4BA2DEF10F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceAccountInternalReconciliation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceAccountInternalReconciliation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceAccountInternalReconciliation" } } } } } } }, "/api/FinanceAccountInternalReconciliation/TryGetByValue": { "post": { "tags": [ "FinanceAccountInternalReconciliation" ], "summary": "FinanceAccountInternalReconciliation: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountInternalReconciliation-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountInternalReconciliation_TryGetByValue_E3A4A586B726", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountInternalReconciliation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountInternalReconciliation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountInternalReconciliation" } } } } } } }, "/api/FinanceAccountInternalReconciliation/UpsertGraph": { "put": { "tags": [ "FinanceAccountInternalReconciliation" ], "summary": "FinanceAccountInternalReconciliation: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountInternalReconciliation-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountInternalReconciliation_UpsertGraph_63FA79A76B7C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountInternalReconciliation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountInternalReconciliation" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountInternalReconciliation" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountInternalReconciliation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountInternalReconciliation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountInternalReconciliation" } } } } } } }, "/api/FinanceAccountInternalReconciliation/UpsertGraphWithExtraFields": { "put": { "tags": [ "FinanceAccountInternalReconciliation" ], "summary": "FinanceAccountInternalReconciliation: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountInternalReconciliation-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountInternalReconciliation_UpsertGraphWithExtraFields_E4F244821260", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceAccountInternalReconciliation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceAccountInternalReconciliation" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceAccountInternalReconciliation" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceAccountInternalReconciliation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceAccountInternalReconciliation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceAccountInternalReconciliation" } } } } } } }, "/api/FinanceAccountInternalReconciliationPosition": { "get": { "tags": [ "FinanceAccountInternalReconciliationPosition" ], "summary": "FinanceAccountInternalReconciliationPosition: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountInternalReconciliationPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountInternalReconciliationPosition_GetAll_739E52EC36B0", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountInternalReconciliationPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountInternalReconciliationPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountInternalReconciliationPosition" } } } } } }, "post": { "tags": [ "FinanceAccountInternalReconciliationPosition" ], "summary": "FinanceAccountInternalReconciliationPosition: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountInternalReconciliationPosition-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountInternalReconciliationPosition_Post_663F3E96DAB7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountInternalReconciliationPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountInternalReconciliationPosition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountInternalReconciliationPosition" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountInternalReconciliationPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountInternalReconciliationPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountInternalReconciliationPosition" } } } } } }, "put": { "tags": [ "FinanceAccountInternalReconciliationPosition" ], "summary": "FinanceAccountInternalReconciliationPosition: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountInternalReconciliationPosition-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountInternalReconciliationPosition_Put_C5DEE29090DB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountInternalReconciliationPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountInternalReconciliationPosition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountInternalReconciliationPosition" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountInternalReconciliationPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountInternalReconciliationPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountInternalReconciliationPosition" } } } } } } }, "/api/FinanceAccountInternalReconciliationPosition/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "FinanceAccountInternalReconciliationPosition" ], "summary": "FinanceAccountInternalReconciliationPosition: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountInternalReconciliationPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountInternalReconciliationPosition_GetPageByValue_3D83A55F596D", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceAccountInternalReconciliationPosition/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "FinanceAccountInternalReconciliationPosition" ], "summary": "FinanceAccountInternalReconciliationPosition: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountInternalReconciliationPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountInternalReconciliationPosition_GetPageByValue2_D33F3ED84AF0", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceAccountInternalReconciliationPosition/DeleteByFilter": { "post": { "tags": [ "FinanceAccountInternalReconciliationPosition" ], "summary": "FinanceAccountInternalReconciliationPosition: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountInternalReconciliationPosition-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountInternalReconciliationPosition_DeleteByFilter_87A1AFED0BBD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/FinanceAccountInternalReconciliationPosition/GetAllByValue": { "post": { "tags": [ "FinanceAccountInternalReconciliationPosition" ], "summary": "FinanceAccountInternalReconciliationPosition: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountInternalReconciliationPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountInternalReconciliationPosition_GetAllByValue_192BA055AD03", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountInternalReconciliationPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountInternalReconciliationPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountInternalReconciliationPosition" } } } } } } }, "/api/FinanceAccountInternalReconciliationPosition/GetAllGraphByValue": { "post": { "tags": [ "FinanceAccountInternalReconciliationPosition" ], "summary": "FinanceAccountInternalReconciliationPosition: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountInternalReconciliationPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountInternalReconciliationPosition_GetAllGraphByValue_5909C337DCA8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountInternalReconciliationPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountInternalReconciliationPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountInternalReconciliationPosition" } } } } } } }, "/api/FinanceAccountInternalReconciliationPosition/GetByValue": { "post": { "tags": [ "FinanceAccountInternalReconciliationPosition" ], "summary": "FinanceAccountInternalReconciliationPosition: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountInternalReconciliationPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountInternalReconciliationPosition_GetByValue_8E40AC2E24CA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountInternalReconciliationPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountInternalReconciliationPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountInternalReconciliationPosition" } } } } } } }, "/api/FinanceAccountInternalReconciliationPosition/GetFromViewReconciliationPositions": { "post": { "tags": [ "FinanceAccountInternalReconciliationPosition" ], "summary": "FinanceAccountInternalReconciliationPosition: GetFromViewReconciliationPositions", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountInternalReconciliationPosition-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountInternalReconciliationPosition_GetFromViewReconciliationPositions_E8C4A28539BF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountInternalReconciliationPosition_GetReconciliationPositionsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountInternalReconciliationPosition_GetReconciliationPositionsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountInternalReconciliationPosition_GetReconciliationPositionsRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW621_FinanceAccountReconciliationPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW621_FinanceAccountReconciliationPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW621_FinanceAccountReconciliationPosition" } } } } } } }, "/api/FinanceAccountInternalReconciliationPosition/GetLookup": { "post": { "tags": [ "FinanceAccountInternalReconciliationPosition" ], "summary": "FinanceAccountInternalReconciliationPosition: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountInternalReconciliationPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountInternalReconciliationPosition_GetLookup_3520E029E078", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceAccountInternalReconciliationPosition/GetLookupByValue": { "post": { "tags": [ "FinanceAccountInternalReconciliationPosition" ], "summary": "FinanceAccountInternalReconciliationPosition: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountInternalReconciliationPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountInternalReconciliationPosition_GetLookupByValue_3E327ED1F0FA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceAccountInternalReconciliationPosition/Page": { "get": { "tags": [ "FinanceAccountInternalReconciliationPosition" ], "summary": "FinanceAccountInternalReconciliationPosition: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountInternalReconciliationPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountInternalReconciliationPosition_GetPage_02979BBF2224", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceAccountInternalReconciliationPosition/PageAsc": { "get": { "tags": [ "FinanceAccountInternalReconciliationPosition" ], "summary": "FinanceAccountInternalReconciliationPosition: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountInternalReconciliationPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountInternalReconciliationPosition_GetPageAsc_F000A51B231F", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceAccountInternalReconciliationPosition/SearchByValue": { "post": { "tags": [ "FinanceAccountInternalReconciliationPosition" ], "summary": "FinanceAccountInternalReconciliationPosition: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountInternalReconciliationPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountInternalReconciliationPosition_SearchByValue_25F05F852A30", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceAccountInternalReconciliationPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceAccountInternalReconciliationPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceAccountInternalReconciliationPosition" } } } } } } }, "/api/FinanceAccountInternalReconciliationPosition/TryGetByValue": { "post": { "tags": [ "FinanceAccountInternalReconciliationPosition" ], "summary": "FinanceAccountInternalReconciliationPosition: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountInternalReconciliationPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountInternalReconciliationPosition_TryGetByValue_9F433C5F47F2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountInternalReconciliationPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountInternalReconciliationPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountInternalReconciliationPosition" } } } } } } }, "/api/FinanceAccountInternalReconciliationPosition/UpsertGraph": { "put": { "tags": [ "FinanceAccountInternalReconciliationPosition" ], "summary": "FinanceAccountInternalReconciliationPosition: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountInternalReconciliationPosition-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountInternalReconciliationPosition_UpsertGraph_6FBCC103EE3D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountInternalReconciliationPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountInternalReconciliationPosition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountInternalReconciliationPosition" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountInternalReconciliationPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountInternalReconciliationPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountInternalReconciliationPosition" } } } } } } }, "/api/FinanceAccountInternalReconciliationPosition/UpsertGraphWithExtraFields": { "put": { "tags": [ "FinanceAccountInternalReconciliationPosition" ], "summary": "FinanceAccountInternalReconciliationPosition: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountInternalReconciliationPosition-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountInternalReconciliationPosition_UpsertGraphWithExtraFields_EEBD1AA0F138", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceAccountInternalReconciliationPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceAccountInternalReconciliationPosition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceAccountInternalReconciliationPosition" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceAccountInternalReconciliationPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceAccountInternalReconciliationPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceAccountInternalReconciliationPosition" } } } } } } }, "/api/FinanceAccountPlan": { "get": { "tags": [ "FinanceAccountPlan" ], "summary": "FinanceAccountPlan: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountPlan-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountPlan_GetAll_19F0CC5A77FD", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountPlan" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountPlan" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountPlan" } } } } } }, "post": { "tags": [ "FinanceAccountPlan" ], "summary": "FinanceAccountPlan: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountPlan-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountPlan_Post_451D9945B1CB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountPlan" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountPlan" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountPlan" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountPlan" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountPlan" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountPlan" } } } } } }, "put": { "tags": [ "FinanceAccountPlan" ], "summary": "FinanceAccountPlan: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountPlan-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountPlan_Put_64243058C81D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountPlan" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountPlan" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountPlan" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountPlan" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountPlan" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountPlan" } } } } } } }, "/api/FinanceAccountPlan/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "FinanceAccountPlan" ], "summary": "FinanceAccountPlan: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountPlan-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountPlan_GetPageByValue_C45BDFEEE316", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceAccountPlan/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "FinanceAccountPlan" ], "summary": "FinanceAccountPlan: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountPlan-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountPlan_GetPageByValue2_135542DFF8A3", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceAccountPlan/DeleteByFilter": { "post": { "tags": [ "FinanceAccountPlan" ], "summary": "FinanceAccountPlan: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountPlan-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountPlan_DeleteByFilter_7E3AEE0D3857", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/FinanceAccountPlan/GetAllByValue": { "post": { "tags": [ "FinanceAccountPlan" ], "summary": "FinanceAccountPlan: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountPlan-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountPlan_GetAllByValue_6F907C840C32", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountPlan" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountPlan" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountPlan" } } } } } } }, "/api/FinanceAccountPlan/GetAllGraphByValue": { "post": { "tags": [ "FinanceAccountPlan" ], "summary": "FinanceAccountPlan: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountPlan-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountPlan_GetAllGraphByValue_782C857AE8CD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountPlan" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountPlan" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountPlan" } } } } } } }, "/api/FinanceAccountPlan/GetByValue": { "post": { "tags": [ "FinanceAccountPlan" ], "summary": "FinanceAccountPlan: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountPlan-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountPlan_GetByValue_090356DF868A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountPlan" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountPlan" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountPlan" } } } } } } }, "/api/FinanceAccountPlan/GetLookup": { "post": { "tags": [ "FinanceAccountPlan" ], "summary": "FinanceAccountPlan: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountPlan-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountPlan_GetLookup_4B37D9E64C83", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceAccountPlan/GetLookupByValue": { "post": { "tags": [ "FinanceAccountPlan" ], "summary": "FinanceAccountPlan: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountPlan-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountPlan_GetLookupByValue_9596FCCE6B43", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceAccountPlan/Page": { "get": { "tags": [ "FinanceAccountPlan" ], "summary": "FinanceAccountPlan: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountPlan-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountPlan_GetPage_88DF257DEFD5", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceAccountPlan/PageAsc": { "get": { "tags": [ "FinanceAccountPlan" ], "summary": "FinanceAccountPlan: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountPlan-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountPlan_GetPageAsc_F0BFEBE978F8", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceAccountPlan/PageFromView/{GroupId}/{IncludeSubNodes}/{activeOnly}/{favoriteOnly}/{onlyDirect}/{filterByForeignCurrency}/{filterForeignCurrencyId}/{onlyAssetAccounts}": { "get": { "tags": [ "FinanceAccountPlan" ], "summary": "FinanceAccountPlan: GetPageFromView", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountPlan-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountPlan_GetPageFromView_8EED24195A88", "parameters": [ { "name": "GroupId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "IncludeSubNodes", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "activeOnly", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "favoriteOnly", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "onlyDirect", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "filterByForeignCurrency", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "filterForeignCurrencyId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "onlyAssetAccounts", "in": "path", "required": true, "schema": { "type": "boolean", "default": false } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceAccountPlan/SearchByValue": { "post": { "tags": [ "FinanceAccountPlan" ], "summary": "FinanceAccountPlan: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountPlan-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountPlan_SearchByValue_776C28D4B461", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceAccountPlan" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceAccountPlan" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceAccountPlan" } } } } } } }, "/api/FinanceAccountPlan/TryGetByValue": { "post": { "tags": [ "FinanceAccountPlan" ], "summary": "FinanceAccountPlan: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountPlan-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountPlan_TryGetByValue_56EE73BC9DD9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountPlan" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountPlan" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountPlan" } } } } } } }, "/api/FinanceAccountPlan/UpsertGraph": { "put": { "tags": [ "FinanceAccountPlan" ], "summary": "FinanceAccountPlan: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountPlan-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountPlan_UpsertGraph_9E3EE0B1D09F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountPlan" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountPlan" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountPlan" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountPlan" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountPlan" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountPlan" } } } } } } }, "/api/FinanceAccountPlan/UpsertGraphWithExtraFields": { "put": { "tags": [ "FinanceAccountPlan" ], "summary": "FinanceAccountPlan: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountPlan-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountPlan_UpsertGraphWithExtraFields_E928595C1F27", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceAccountPlan" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceAccountPlan" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceAccountPlan" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceAccountPlan" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceAccountPlan" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceAccountPlan" } } } } } } }, "/api/FinanceAccountPurpose": { "get": { "tags": [ "FinanceAccountPurpose" ], "summary": "FinanceAccountPurpose: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountPurpose-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountPurpose_GetAll_4897A3283DBA", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountPurpose" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountPurpose" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountPurpose" } } } } } }, "post": { "tags": [ "FinanceAccountPurpose" ], "summary": "FinanceAccountPurpose: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountPurpose-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountPurpose_Post_B86E5E36FA5A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountPurpose" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountPurpose" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountPurpose" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountPurpose" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountPurpose" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountPurpose" } } } } } }, "put": { "tags": [ "FinanceAccountPurpose" ], "summary": "FinanceAccountPurpose: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountPurpose-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountPurpose_Put_79BCED8398CA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountPurpose" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountPurpose" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountPurpose" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountPurpose" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountPurpose" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountPurpose" } } } } } } }, "/api/FinanceAccountPurpose/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "FinanceAccountPurpose" ], "summary": "FinanceAccountPurpose: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountPurpose-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountPurpose_GetPageByValue_710DBCD3B93C", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceAccountPurpose/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "FinanceAccountPurpose" ], "summary": "FinanceAccountPurpose: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountPurpose-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountPurpose_GetPageByValue2_CBD9E8927400", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceAccountPurpose/DeleteByFilter": { "post": { "tags": [ "FinanceAccountPurpose" ], "summary": "FinanceAccountPurpose: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountPurpose-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountPurpose_DeleteByFilter_CFB984DD963C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/FinanceAccountPurpose/GetAllByValue": { "post": { "tags": [ "FinanceAccountPurpose" ], "summary": "FinanceAccountPurpose: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountPurpose-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountPurpose_GetAllByValue_063651267AB7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountPurpose" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountPurpose" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountPurpose" } } } } } } }, "/api/FinanceAccountPurpose/GetAllGraphByValue": { "post": { "tags": [ "FinanceAccountPurpose" ], "summary": "FinanceAccountPurpose: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountPurpose-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountPurpose_GetAllGraphByValue_BC238AA331C7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountPurpose" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountPurpose" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountPurpose" } } } } } } }, "/api/FinanceAccountPurpose/GetByValue": { "post": { "tags": [ "FinanceAccountPurpose" ], "summary": "FinanceAccountPurpose: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountPurpose-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountPurpose_GetByValue_E907B9D18A6A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountPurpose" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountPurpose" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountPurpose" } } } } } } }, "/api/FinanceAccountPurpose/GetLookup": { "post": { "tags": [ "FinanceAccountPurpose" ], "summary": "FinanceAccountPurpose: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountPurpose-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountPurpose_GetLookup_5265F3B86A34", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceAccountPurpose/GetLookupByValue": { "post": { "tags": [ "FinanceAccountPurpose" ], "summary": "FinanceAccountPurpose: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountPurpose-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountPurpose_GetLookupByValue_E79D89842648", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceAccountPurpose/Page": { "get": { "tags": [ "FinanceAccountPurpose" ], "summary": "FinanceAccountPurpose: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountPurpose-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountPurpose_GetPage_F2A9E220C8EB", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceAccountPurpose/PageAsc": { "get": { "tags": [ "FinanceAccountPurpose" ], "summary": "FinanceAccountPurpose: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountPurpose-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountPurpose_GetPageAsc_AB3E5E44E03B", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceAccountPurpose/SearchByValue": { "post": { "tags": [ "FinanceAccountPurpose" ], "summary": "FinanceAccountPurpose: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountPurpose-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountPurpose_SearchByValue_C79881EBFE9A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceAccountPurpose" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceAccountPurpose" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceAccountPurpose" } } } } } } }, "/api/FinanceAccountPurpose/TryGetByValue": { "post": { "tags": [ "FinanceAccountPurpose" ], "summary": "FinanceAccountPurpose: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountPurpose-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountPurpose_TryGetByValue_B4F27C397CE3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountPurpose" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountPurpose" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountPurpose" } } } } } } }, "/api/FinanceAccountPurpose/UpsertGraph": { "put": { "tags": [ "FinanceAccountPurpose" ], "summary": "FinanceAccountPurpose: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountPurpose-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountPurpose_UpsertGraph_16616AF94481", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountPurpose" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountPurpose" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountPurpose" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountPurpose" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountPurpose" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountPurpose" } } } } } } }, "/api/FinanceAccountPurpose/UpsertGraphWithExtraFields": { "put": { "tags": [ "FinanceAccountPurpose" ], "summary": "FinanceAccountPurpose: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountPurpose-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountPurpose_UpsertGraphWithExtraFields_D3BF6A83F206", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceAccountPurpose" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceAccountPurpose" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceAccountPurpose" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceAccountPurpose" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceAccountPurpose" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceAccountPurpose" } } } } } } }, "/api/FinanceAccountType": { "get": { "tags": [ "FinanceAccountType" ], "summary": "FinanceAccountType: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountType_GetAll_41E70AD73093", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountType" } } } } } }, "post": { "tags": [ "FinanceAccountType" ], "summary": "FinanceAccountType: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountType-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountType_Post_728246FD1637", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountType" } } } } } }, "put": { "tags": [ "FinanceAccountType" ], "summary": "FinanceAccountType: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountType_Put_CCF198FBD0E1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountType" } } } } } } }, "/api/FinanceAccountType/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "FinanceAccountType" ], "summary": "FinanceAccountType: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountType_GetPageByValue_88B97816B90F", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceAccountType/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "FinanceAccountType" ], "summary": "FinanceAccountType: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountType_GetPageByValue2_EE647236B405", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceAccountType/DeleteByFilter": { "post": { "tags": [ "FinanceAccountType" ], "summary": "FinanceAccountType: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountType-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountType_DeleteByFilter_FB2F79274325", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/FinanceAccountType/GetAllByValue": { "post": { "tags": [ "FinanceAccountType" ], "summary": "FinanceAccountType: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountType_GetAllByValue_2DE5263E004D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountType" } } } } } } }, "/api/FinanceAccountType/GetAllGraphByValue": { "post": { "tags": [ "FinanceAccountType" ], "summary": "FinanceAccountType: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountType_GetAllGraphByValue_971A41C1D3E1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountType" } } } } } } }, "/api/FinanceAccountType/GetByValue": { "post": { "tags": [ "FinanceAccountType" ], "summary": "FinanceAccountType: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountType_GetByValue_8A7C9038B1AE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountType" } } } } } } }, "/api/FinanceAccountType/GetLookup": { "post": { "tags": [ "FinanceAccountType" ], "summary": "FinanceAccountType: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountType_GetLookup_0912DBB292DC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceAccountType/GetLookupByValue": { "post": { "tags": [ "FinanceAccountType" ], "summary": "FinanceAccountType: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountType_GetLookupByValue_7B4452A16134", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceAccountType/Page": { "get": { "tags": [ "FinanceAccountType" ], "summary": "FinanceAccountType: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountType_GetPage_D646C5EC3127", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceAccountType/PageAsc": { "get": { "tags": [ "FinanceAccountType" ], "summary": "FinanceAccountType: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountType_GetPageAsc_C29302E4D034", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceAccountType/SearchByValue": { "post": { "tags": [ "FinanceAccountType" ], "summary": "FinanceAccountType: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountType_SearchByValue_4B1CD6B8F74A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceAccountType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceAccountType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceAccountType" } } } } } } }, "/api/FinanceAccountType/TryGetByValue": { "post": { "tags": [ "FinanceAccountType" ], "summary": "FinanceAccountType: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountType_TryGetByValue_F74DBE6C43DE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountType" } } } } } } }, "/api/FinanceAccountType/UpsertGraph": { "put": { "tags": [ "FinanceAccountType" ], "summary": "FinanceAccountType: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountType_UpsertGraph_CA8EC8187FE1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountType" } } } } } } }, "/api/FinanceAccountType/UpsertGraphWithExtraFields": { "put": { "tags": [ "FinanceAccountType" ], "summary": "FinanceAccountType: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceAccountType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceAccountType_UpsertGraphWithExtraFields_27C4D0E17A83", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceAccountType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceAccountType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceAccountType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceAccountType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceAccountType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceAccountType" } } } } } } }, "/api/FinanceBalanceGroup": { "get": { "tags": [ "FinanceBalanceGroup" ], "summary": "FinanceBalanceGroup: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceBalanceGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceBalanceGroup_GetAll_321ABDAC1A94", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceBalanceGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceBalanceGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceBalanceGroup" } } } } } }, "post": { "tags": [ "FinanceBalanceGroup" ], "summary": "FinanceBalanceGroup: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceBalanceGroup-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceBalanceGroup_Post_5C932DC1C81F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceBalanceGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceBalanceGroup" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceBalanceGroup" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceBalanceGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceBalanceGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceBalanceGroup" } } } } } }, "put": { "tags": [ "FinanceBalanceGroup" ], "summary": "FinanceBalanceGroup: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceBalanceGroup-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceBalanceGroup_Put_172022A3A2D9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceBalanceGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceBalanceGroup" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceBalanceGroup" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceBalanceGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceBalanceGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceBalanceGroup" } } } } } } }, "/api/FinanceBalanceGroup/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "FinanceBalanceGroup" ], "summary": "FinanceBalanceGroup: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceBalanceGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceBalanceGroup_GetPageByValue_FA0C93E27744", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceBalanceGroup/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "FinanceBalanceGroup" ], "summary": "FinanceBalanceGroup: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceBalanceGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceBalanceGroup_GetPageByValue2_A40EB5A6BB31", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceBalanceGroup/DeleteByFilter": { "post": { "tags": [ "FinanceBalanceGroup" ], "summary": "FinanceBalanceGroup: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceBalanceGroup-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceBalanceGroup_DeleteByFilter_26920F6784A6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/FinanceBalanceGroup/GetAllByValue": { "post": { "tags": [ "FinanceBalanceGroup" ], "summary": "FinanceBalanceGroup: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceBalanceGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceBalanceGroup_GetAllByValue_4F83ED071156", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceBalanceGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceBalanceGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceBalanceGroup" } } } } } } }, "/api/FinanceBalanceGroup/GetAllGraphByValue": { "post": { "tags": [ "FinanceBalanceGroup" ], "summary": "FinanceBalanceGroup: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceBalanceGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceBalanceGroup_GetAllGraphByValue_B27C270776FB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceBalanceGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceBalanceGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceBalanceGroup" } } } } } } }, "/api/FinanceBalanceGroup/GetByValue": { "post": { "tags": [ "FinanceBalanceGroup" ], "summary": "FinanceBalanceGroup: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceBalanceGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceBalanceGroup_GetByValue_1DCD6A3469AE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceBalanceGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceBalanceGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceBalanceGroup" } } } } } } }, "/api/FinanceBalanceGroup/GetLookup": { "post": { "tags": [ "FinanceBalanceGroup" ], "summary": "FinanceBalanceGroup: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceBalanceGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceBalanceGroup_GetLookup_D29AA9E3E153", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceBalanceGroup/GetLookupByValue": { "post": { "tags": [ "FinanceBalanceGroup" ], "summary": "FinanceBalanceGroup: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceBalanceGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceBalanceGroup_GetLookupByValue_11613EEC680D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceBalanceGroup/Page": { "get": { "tags": [ "FinanceBalanceGroup" ], "summary": "FinanceBalanceGroup: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceBalanceGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceBalanceGroup_GetPage_1ABB840AB334", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceBalanceGroup/PageAsc": { "get": { "tags": [ "FinanceBalanceGroup" ], "summary": "FinanceBalanceGroup: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceBalanceGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceBalanceGroup_GetPageAsc_DB4BE7A83956", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceBalanceGroup/PageFinanceBalanceGroupsByParent/{ParentId}/{IncludeSubNodes}/{TopParentsOnly}": { "get": { "tags": [ "FinanceBalanceGroup" ], "summary": "FinanceBalanceGroup: GetPageFinanceBalanceGroupsByParent", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceBalanceGroup-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceBalanceGroup_GetPageFinanceBalanceGroupsByParent_96E253BB74F4", "parameters": [ { "name": "ParentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "IncludeSubNodes", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "TopParentsOnly", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceBalanceGroup/SearchByValue": { "post": { "tags": [ "FinanceBalanceGroup" ], "summary": "FinanceBalanceGroup: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceBalanceGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceBalanceGroup_SearchByValue_3C86AB55662F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceBalanceGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceBalanceGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceBalanceGroup" } } } } } } }, "/api/FinanceBalanceGroup/TryGetByValue": { "post": { "tags": [ "FinanceBalanceGroup" ], "summary": "FinanceBalanceGroup: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceBalanceGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceBalanceGroup_TryGetByValue_9E16BE43165E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceBalanceGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceBalanceGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceBalanceGroup" } } } } } } }, "/api/FinanceBalanceGroup/UpsertGraph": { "put": { "tags": [ "FinanceBalanceGroup" ], "summary": "FinanceBalanceGroup: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceBalanceGroup-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceBalanceGroup_UpsertGraph_066EEF7C59E8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceBalanceGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceBalanceGroup" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceBalanceGroup" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceBalanceGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceBalanceGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceBalanceGroup" } } } } } } }, "/api/FinanceBalanceGroup/UpsertGraphWithExtraFields": { "put": { "tags": [ "FinanceBalanceGroup" ], "summary": "FinanceBalanceGroup: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceBalanceGroup-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceBalanceGroup_UpsertGraphWithExtraFields_73B8ECE2E285", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceBalanceGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceBalanceGroup" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceBalanceGroup" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceBalanceGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceBalanceGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceBalanceGroup" } } } } } } }, "/api/FinanceBusinessAssessmentGroup": { "get": { "tags": [ "FinanceBusinessAssessmentGroup" ], "summary": "FinanceBusinessAssessmentGroup: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceBusinessAssessmentGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceBusinessAssessmentGroup_GetAll_96C26E180879", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceBusinessAssessmentGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceBusinessAssessmentGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceBusinessAssessmentGroup" } } } } } }, "post": { "tags": [ "FinanceBusinessAssessmentGroup" ], "summary": "FinanceBusinessAssessmentGroup: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceBusinessAssessmentGroup-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceBusinessAssessmentGroup_Post_C6B2B7289B80", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceBusinessAssessmentGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceBusinessAssessmentGroup" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceBusinessAssessmentGroup" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceBusinessAssessmentGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceBusinessAssessmentGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceBusinessAssessmentGroup" } } } } } }, "put": { "tags": [ "FinanceBusinessAssessmentGroup" ], "summary": "FinanceBusinessAssessmentGroup: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceBusinessAssessmentGroup-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceBusinessAssessmentGroup_Put_92034D5AF2B5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceBusinessAssessmentGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceBusinessAssessmentGroup" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceBusinessAssessmentGroup" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceBusinessAssessmentGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceBusinessAssessmentGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceBusinessAssessmentGroup" } } } } } } }, "/api/FinanceBusinessAssessmentGroup/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "FinanceBusinessAssessmentGroup" ], "summary": "FinanceBusinessAssessmentGroup: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceBusinessAssessmentGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceBusinessAssessmentGroup_GetPageByValue_C5569019E885", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceBusinessAssessmentGroup/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "FinanceBusinessAssessmentGroup" ], "summary": "FinanceBusinessAssessmentGroup: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceBusinessAssessmentGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceBusinessAssessmentGroup_GetPageByValue2_836E6B06BD67", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceBusinessAssessmentGroup/DeleteByFilter": { "post": { "tags": [ "FinanceBusinessAssessmentGroup" ], "summary": "FinanceBusinessAssessmentGroup: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceBusinessAssessmentGroup-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceBusinessAssessmentGroup_DeleteByFilter_3C45ACB4DD4B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/FinanceBusinessAssessmentGroup/GetAllByValue": { "post": { "tags": [ "FinanceBusinessAssessmentGroup" ], "summary": "FinanceBusinessAssessmentGroup: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceBusinessAssessmentGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceBusinessAssessmentGroup_GetAllByValue_28A6A9844861", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceBusinessAssessmentGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceBusinessAssessmentGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceBusinessAssessmentGroup" } } } } } } }, "/api/FinanceBusinessAssessmentGroup/GetAllGraphByValue": { "post": { "tags": [ "FinanceBusinessAssessmentGroup" ], "summary": "FinanceBusinessAssessmentGroup: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceBusinessAssessmentGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceBusinessAssessmentGroup_GetAllGraphByValue_04BCD4D8D958", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceBusinessAssessmentGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceBusinessAssessmentGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceBusinessAssessmentGroup" } } } } } } }, "/api/FinanceBusinessAssessmentGroup/GetByValue": { "post": { "tags": [ "FinanceBusinessAssessmentGroup" ], "summary": "FinanceBusinessAssessmentGroup: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceBusinessAssessmentGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceBusinessAssessmentGroup_GetByValue_8AC7A926B6A5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceBusinessAssessmentGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceBusinessAssessmentGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceBusinessAssessmentGroup" } } } } } } }, "/api/FinanceBusinessAssessmentGroup/GetLookup": { "post": { "tags": [ "FinanceBusinessAssessmentGroup" ], "summary": "FinanceBusinessAssessmentGroup: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceBusinessAssessmentGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceBusinessAssessmentGroup_GetLookup_196D7CA820A4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceBusinessAssessmentGroup/GetLookupByValue": { "post": { "tags": [ "FinanceBusinessAssessmentGroup" ], "summary": "FinanceBusinessAssessmentGroup: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceBusinessAssessmentGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceBusinessAssessmentGroup_GetLookupByValue_F2394142541D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceBusinessAssessmentGroup/Page": { "get": { "tags": [ "FinanceBusinessAssessmentGroup" ], "summary": "FinanceBusinessAssessmentGroup: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceBusinessAssessmentGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceBusinessAssessmentGroup_GetPage_0FBDDDEC5215", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceBusinessAssessmentGroup/PageAsc": { "get": { "tags": [ "FinanceBusinessAssessmentGroup" ], "summary": "FinanceBusinessAssessmentGroup: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceBusinessAssessmentGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceBusinessAssessmentGroup_GetPageAsc_927F0716559C", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceBusinessAssessmentGroup/PageFinanceBusinessAssessmentGroupsByParent/{ParentId}/{IncludeSubNodes}/{TopParentsOnly}": { "get": { "tags": [ "FinanceBusinessAssessmentGroup" ], "summary": "FinanceBusinessAssessmentGroup: GetPageFinanceBusinessAssessmentGroupsByParent", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceBusinessAssessmentGroup-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceBusinessAssessmentGroup_GetPageFinanceBusinessAssessmentGroupsByParent_5F6BD3F45DA3", "parameters": [ { "name": "ParentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "IncludeSubNodes", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "TopParentsOnly", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceBusinessAssessmentGroup/SearchByValue": { "post": { "tags": [ "FinanceBusinessAssessmentGroup" ], "summary": "FinanceBusinessAssessmentGroup: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceBusinessAssessmentGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceBusinessAssessmentGroup_SearchByValue_03F3201C74D3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceBusinessAssessmentGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceBusinessAssessmentGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceBusinessAssessmentGroup" } } } } } } }, "/api/FinanceBusinessAssessmentGroup/TryGetByValue": { "post": { "tags": [ "FinanceBusinessAssessmentGroup" ], "summary": "FinanceBusinessAssessmentGroup: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceBusinessAssessmentGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceBusinessAssessmentGroup_TryGetByValue_74671BF4FB2E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceBusinessAssessmentGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceBusinessAssessmentGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceBusinessAssessmentGroup" } } } } } } }, "/api/FinanceBusinessAssessmentGroup/UpsertGraph": { "put": { "tags": [ "FinanceBusinessAssessmentGroup" ], "summary": "FinanceBusinessAssessmentGroup: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceBusinessAssessmentGroup-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceBusinessAssessmentGroup_UpsertGraph_B2FBFC888E58", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceBusinessAssessmentGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceBusinessAssessmentGroup" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceBusinessAssessmentGroup" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceBusinessAssessmentGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceBusinessAssessmentGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceBusinessAssessmentGroup" } } } } } } }, "/api/FinanceBusinessAssessmentGroup/UpsertGraphWithExtraFields": { "put": { "tags": [ "FinanceBusinessAssessmentGroup" ], "summary": "FinanceBusinessAssessmentGroup: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceBusinessAssessmentGroup-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceBusinessAssessmentGroup_UpsertGraphWithExtraFields_5591AB293C4C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceBusinessAssessmentGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceBusinessAssessmentGroup" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceBusinessAssessmentGroup" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceBusinessAssessmentGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceBusinessAssessmentGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceBusinessAssessmentGroup" } } } } } } }, "/api/FinanceClosingPosting": { "get": { "tags": [ "FinanceClosingPosting" ], "summary": "FinanceClosingPosting: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceClosingPosting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceClosingPosting_GetAll_14C96A23D888", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceClosingPosting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceClosingPosting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceClosingPosting" } } } } } }, "post": { "tags": [ "FinanceClosingPosting" ], "summary": "FinanceClosingPosting: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceClosingPosting-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceClosingPosting_Post_49BA27CE7D84", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceClosingPosting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceClosingPosting" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceClosingPosting" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceClosingPosting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceClosingPosting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceClosingPosting" } } } } } }, "put": { "tags": [ "FinanceClosingPosting" ], "summary": "FinanceClosingPosting: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceClosingPosting-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceClosingPosting_Put_754EAC303C34", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceClosingPosting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceClosingPosting" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceClosingPosting" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceClosingPosting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceClosingPosting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceClosingPosting" } } } } } } }, "/api/FinanceClosingPosting/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "FinanceClosingPosting" ], "summary": "FinanceClosingPosting: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceClosingPosting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceClosingPosting_GetPageByValue_B556B113A7BE", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceClosingPosting/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "FinanceClosingPosting" ], "summary": "FinanceClosingPosting: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceClosingPosting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceClosingPosting_GetPageByValue2_B05DDB50AE9C", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceClosingPosting/CreateNewFinanceClosingPosting": { "post": { "tags": [ "FinanceClosingPosting" ], "summary": "FinanceClosingPosting: CreateNewFinanceClosingPosting", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceClosingPosting-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceClosingPosting_CreateNewFinanceClosingPosting_4CF3D50ABA85", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceClosingPosting_CreateNewRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceClosingPosting_CreateNewRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceClosingPosting_CreateNewRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceClosingPosting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceClosingPosting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceClosingPosting" } } } } } } }, "/api/FinanceClosingPosting/DeleteByFilter": { "post": { "tags": [ "FinanceClosingPosting" ], "summary": "FinanceClosingPosting: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceClosingPosting-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceClosingPosting_DeleteByFilter_FBCF4769AF33", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/FinanceClosingPosting/DeleteFinanceClosingPosting": { "post": { "tags": [ "FinanceClosingPosting" ], "summary": "FinanceClosingPosting: DeleteFinanceClosingPosting", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceClosingPosting-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceClosingPosting_DeleteFinanceClosingPosting_1A2931C23B6E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceClosingPosting_DeleteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceClosingPosting_DeleteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceClosingPosting_DeleteRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/FinanceClosingPosting/GetAllByValue": { "post": { "tags": [ "FinanceClosingPosting" ], "summary": "FinanceClosingPosting: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceClosingPosting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceClosingPosting_GetAllByValue_5CF89C2673BB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceClosingPosting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceClosingPosting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceClosingPosting" } } } } } } }, "/api/FinanceClosingPosting/GetAllGraphByValue": { "post": { "tags": [ "FinanceClosingPosting" ], "summary": "FinanceClosingPosting: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceClosingPosting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceClosingPosting_GetAllGraphByValue_D54D2DE10F40", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceClosingPosting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceClosingPosting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceClosingPosting" } } } } } } }, "/api/FinanceClosingPosting/GetByValue": { "post": { "tags": [ "FinanceClosingPosting" ], "summary": "FinanceClosingPosting: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceClosingPosting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceClosingPosting_GetByValue_44EC54010DFA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceClosingPosting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceClosingPosting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceClosingPosting" } } } } } } }, "/api/FinanceClosingPosting/GetLookup": { "post": { "tags": [ "FinanceClosingPosting" ], "summary": "FinanceClosingPosting: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceClosingPosting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceClosingPosting_GetLookup_EDA59A470CD8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceClosingPosting/GetLookupByValue": { "post": { "tags": [ "FinanceClosingPosting" ], "summary": "FinanceClosingPosting: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceClosingPosting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceClosingPosting_GetLookupByValue_894583EE19DD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceClosingPosting/Page": { "get": { "tags": [ "FinanceClosingPosting" ], "summary": "FinanceClosingPosting: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceClosingPosting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceClosingPosting_GetPage_F6DA3232F516", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceClosingPosting/PageAsc": { "get": { "tags": [ "FinanceClosingPosting" ], "summary": "FinanceClosingPosting: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceClosingPosting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceClosingPosting_GetPageAsc_FEC460E6D149", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceClosingPosting/SearchByValue": { "post": { "tags": [ "FinanceClosingPosting" ], "summary": "FinanceClosingPosting: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceClosingPosting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceClosingPosting_SearchByValue_8FFBBB94770C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceClosingPosting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceClosingPosting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceClosingPosting" } } } } } } }, "/api/FinanceClosingPosting/TryGetByValue": { "post": { "tags": [ "FinanceClosingPosting" ], "summary": "FinanceClosingPosting: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceClosingPosting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceClosingPosting_TryGetByValue_79B6B546C796", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceClosingPosting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceClosingPosting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceClosingPosting" } } } } } } }, "/api/FinanceClosingPosting/UpdateClosingPosting_Info": { "post": { "tags": [ "FinanceClosingPosting" ], "summary": "FinanceClosingPosting: UpdateClosingPosting_Info", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceClosingPosting-Read.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceClosingPosting_UpdateClosingPosting_Info_E737C9C37A55", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceClosingPosting_UpdateInfoRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceClosingPosting_UpdateInfoRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceClosingPosting_UpdateInfoRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/FinanceClosingPosting/UpdateClosingPosting_ReceiptDate": { "post": { "tags": [ "FinanceClosingPosting" ], "summary": "FinanceClosingPosting: UpdateClosingPosting_ReceiptDate", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceClosingPosting-Read.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceClosingPosting_UpdateClosingPosting_ReceiptDate_87B25D99122F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceClosingPosting_UpdateReceiptDateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceClosingPosting_UpdateReceiptDateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceClosingPosting_UpdateReceiptDateRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/FinanceClosingPosting/UpdateClosingPosting_ReceiptNumber": { "post": { "tags": [ "FinanceClosingPosting" ], "summary": "FinanceClosingPosting: UpdateClosingPosting_ReceiptNumber", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceClosingPosting-Read.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceClosingPosting_UpdateClosingPosting_ReceiptNumber_ACA2632FC989", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceClosingPosting_UpdateReceiptNumberRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceClosingPosting_UpdateReceiptNumberRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceClosingPosting_UpdateReceiptNumberRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/FinanceClosingPosting/UpsertGraph": { "put": { "tags": [ "FinanceClosingPosting" ], "summary": "FinanceClosingPosting: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceClosingPosting-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceClosingPosting_UpsertGraph_708FE9EB6FEE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceClosingPosting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceClosingPosting" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceClosingPosting" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceClosingPosting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceClosingPosting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceClosingPosting" } } } } } } }, "/api/FinanceClosingPosting/UpsertGraphWithExtraFields": { "put": { "tags": [ "FinanceClosingPosting" ], "summary": "FinanceClosingPosting: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceClosingPosting-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceClosingPosting_UpsertGraphWithExtraFields_30F20A80484E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceClosingPosting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceClosingPosting" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceClosingPosting" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceClosingPosting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceClosingPosting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceClosingPosting" } } } } } } }, "/api/FinanceClosingPostingPosition": { "get": { "tags": [ "FinanceClosingPostingPosition" ], "summary": "FinanceClosingPostingPosition: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceClosingPostingPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceClosingPostingPosition_GetAll_524AC157CDA1", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceClosingPostingPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceClosingPostingPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceClosingPostingPosition" } } } } } }, "post": { "tags": [ "FinanceClosingPostingPosition" ], "summary": "FinanceClosingPostingPosition: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceClosingPostingPosition-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceClosingPostingPosition_Post_0622C1A602AA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceClosingPostingPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceClosingPostingPosition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceClosingPostingPosition" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceClosingPostingPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceClosingPostingPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceClosingPostingPosition" } } } } } }, "put": { "tags": [ "FinanceClosingPostingPosition" ], "summary": "FinanceClosingPostingPosition: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceClosingPostingPosition-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceClosingPostingPosition_Put_A23D591C4C54", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceClosingPostingPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceClosingPostingPosition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceClosingPostingPosition" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceClosingPostingPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceClosingPostingPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceClosingPostingPosition" } } } } } } }, "/api/FinanceClosingPostingPosition/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "FinanceClosingPostingPosition" ], "summary": "FinanceClosingPostingPosition: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceClosingPostingPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceClosingPostingPosition_GetPageByValue_C60B337328A3", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceClosingPostingPosition/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "FinanceClosingPostingPosition" ], "summary": "FinanceClosingPostingPosition: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceClosingPostingPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceClosingPostingPosition_GetPageByValue2_D4FF2AF10050", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceClosingPostingPosition/DeleteByFilter": { "post": { "tags": [ "FinanceClosingPostingPosition" ], "summary": "FinanceClosingPostingPosition: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceClosingPostingPosition-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceClosingPostingPosition_DeleteByFilter_AE7FA6647419", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/FinanceClosingPostingPosition/DeleteFinanceClosingPostingPosition": { "post": { "tags": [ "FinanceClosingPostingPosition" ], "summary": "FinanceClosingPostingPosition: DeleteFinanceClosingPostingPosition", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceClosingPostingPosition-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceClosingPostingPosition_DeleteFinanceClosingPostingPosition_B1B5E5079C76", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceClosingPostingPosition_DeleteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceClosingPostingPosition_DeleteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceClosingPostingPosition_DeleteRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/FinanceClosingPostingPosition/GetAllByValue": { "post": { "tags": [ "FinanceClosingPostingPosition" ], "summary": "FinanceClosingPostingPosition: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceClosingPostingPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceClosingPostingPosition_GetAllByValue_1CA33F267503", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceClosingPostingPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceClosingPostingPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceClosingPostingPosition" } } } } } } }, "/api/FinanceClosingPostingPosition/GetAllFromViewByValue": { "post": { "tags": [ "FinanceClosingPostingPosition" ], "summary": "FinanceClosingPostingPosition: GetAllFromViewByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceClosingPostingPosition-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceClosingPostingPosition_GetAllFromViewByValue_429C432DA78D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceClosingPostingPosition_GetAllFromViewByValueRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceClosingPostingPosition_GetAllFromViewByValueRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceClosingPostingPosition_GetAllFromViewByValueRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW645_FinanceClosingPostingPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW645_FinanceClosingPostingPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW645_FinanceClosingPostingPosition" } } } } } } }, "/api/FinanceClosingPostingPosition/GetAllGraphByValue": { "post": { "tags": [ "FinanceClosingPostingPosition" ], "summary": "FinanceClosingPostingPosition: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceClosingPostingPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceClosingPostingPosition_GetAllGraphByValue_36D36CA4C920", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceClosingPostingPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceClosingPostingPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceClosingPostingPosition" } } } } } } }, "/api/FinanceClosingPostingPosition/GetByValue": { "post": { "tags": [ "FinanceClosingPostingPosition" ], "summary": "FinanceClosingPostingPosition: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceClosingPostingPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceClosingPostingPosition_GetByValue_0EB6FE506AAA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceClosingPostingPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceClosingPostingPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceClosingPostingPosition" } } } } } } }, "/api/FinanceClosingPostingPosition/GetLookup": { "post": { "tags": [ "FinanceClosingPostingPosition" ], "summary": "FinanceClosingPostingPosition: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceClosingPostingPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceClosingPostingPosition_GetLookup_F2CC6479EC19", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceClosingPostingPosition/GetLookupByValue": { "post": { "tags": [ "FinanceClosingPostingPosition" ], "summary": "FinanceClosingPostingPosition: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceClosingPostingPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceClosingPostingPosition_GetLookupByValue_8EB2E7531711", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceClosingPostingPosition/Page": { "get": { "tags": [ "FinanceClosingPostingPosition" ], "summary": "FinanceClosingPostingPosition: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceClosingPostingPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceClosingPostingPosition_GetPage_6A0653A05B11", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceClosingPostingPosition/PageAsc": { "get": { "tags": [ "FinanceClosingPostingPosition" ], "summary": "FinanceClosingPostingPosition: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceClosingPostingPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceClosingPostingPosition_GetPageAsc_7643744F810F", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceClosingPostingPosition/SaveFinanceClosingPostingDraft": { "post": { "tags": [ "FinanceClosingPostingPosition" ], "summary": "FinanceClosingPostingPosition: SaveFinanceClosingPostingDraft", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceClosingPostingPosition-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceClosingPostingPosition_SaveFinanceClosingPostingDraft_992BD5CA5675", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceClosingPostingPosition_SaveDraftRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceClosingPostingPosition_SaveDraftRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceClosingPostingPosition_SaveDraftRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PostFinanceClosingPostingResult" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PostFinanceClosingPostingResult" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PostFinanceClosingPostingResult" } } } } } } } }, "/api/FinanceClosingPostingPosition/SearchByValue": { "post": { "tags": [ "FinanceClosingPostingPosition" ], "summary": "FinanceClosingPostingPosition: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceClosingPostingPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceClosingPostingPosition_SearchByValue_5C366E5423F7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceClosingPostingPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceClosingPostingPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceClosingPostingPosition" } } } } } } }, "/api/FinanceClosingPostingPosition/TryGetByValue": { "post": { "tags": [ "FinanceClosingPostingPosition" ], "summary": "FinanceClosingPostingPosition: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceClosingPostingPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceClosingPostingPosition_TryGetByValue_41E2E05C2869", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceClosingPostingPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceClosingPostingPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceClosingPostingPosition" } } } } } } }, "/api/FinanceClosingPostingPosition/UpsertGraph": { "put": { "tags": [ "FinanceClosingPostingPosition" ], "summary": "FinanceClosingPostingPosition: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceClosingPostingPosition-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceClosingPostingPosition_UpsertGraph_48C1C4796D95", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceClosingPostingPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceClosingPostingPosition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceClosingPostingPosition" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceClosingPostingPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceClosingPostingPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceClosingPostingPosition" } } } } } } }, "/api/FinanceClosingPostingPosition/UpsertGraphWithExtraFields": { "put": { "tags": [ "FinanceClosingPostingPosition" ], "summary": "FinanceClosingPostingPosition: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceClosingPostingPosition-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceClosingPostingPosition_UpsertGraphWithExtraFields_FCB2C74353CE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceClosingPostingPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceClosingPostingPosition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceClosingPostingPosition" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceClosingPostingPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceClosingPostingPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceClosingPostingPosition" } } } } } } }, "/api/FinanceCompanyBankAccount": { "get": { "tags": [ "FinanceCompanyBankAccount" ], "summary": "FinanceCompanyBankAccount: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceCompanyBankAccount-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceCompanyBankAccount_GetAll_3E3E096B3378", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceCompanyBankAccount" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceCompanyBankAccount" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceCompanyBankAccount" } } } } } }, "post": { "tags": [ "FinanceCompanyBankAccount" ], "summary": "FinanceCompanyBankAccount: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceCompanyBankAccount-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceCompanyBankAccount_Post_FCBB1C674709", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceCompanyBankAccount" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceCompanyBankAccount" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceCompanyBankAccount" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceCompanyBankAccount" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceCompanyBankAccount" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceCompanyBankAccount" } } } } } }, "put": { "tags": [ "FinanceCompanyBankAccount" ], "summary": "FinanceCompanyBankAccount: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceCompanyBankAccount-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceCompanyBankAccount_Put_CC388FF09D0C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceCompanyBankAccount" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceCompanyBankAccount" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceCompanyBankAccount" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceCompanyBankAccount" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceCompanyBankAccount" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceCompanyBankAccount" } } } } } } }, "/api/FinanceCompanyBankAccount/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "FinanceCompanyBankAccount" ], "summary": "FinanceCompanyBankAccount: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceCompanyBankAccount-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceCompanyBankAccount_GetPageByValue_4210DC78C797", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceCompanyBankAccount/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "FinanceCompanyBankAccount" ], "summary": "FinanceCompanyBankAccount: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceCompanyBankAccount-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceCompanyBankAccount_GetPageByValue2_3E0945822C4F", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceCompanyBankAccount/DeleteByFilter": { "post": { "tags": [ "FinanceCompanyBankAccount" ], "summary": "FinanceCompanyBankAccount: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceCompanyBankAccount-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceCompanyBankAccount_DeleteByFilter_18733055D42B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/FinanceCompanyBankAccount/GetAllByValue": { "post": { "tags": [ "FinanceCompanyBankAccount" ], "summary": "FinanceCompanyBankAccount: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceCompanyBankAccount-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceCompanyBankAccount_GetAllByValue_E8814E52B6FE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceCompanyBankAccount" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceCompanyBankAccount" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceCompanyBankAccount" } } } } } } }, "/api/FinanceCompanyBankAccount/GetAllGraphByValue": { "post": { "tags": [ "FinanceCompanyBankAccount" ], "summary": "FinanceCompanyBankAccount: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceCompanyBankAccount-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceCompanyBankAccount_GetAllGraphByValue_61D8366A0CB8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceCompanyBankAccount" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceCompanyBankAccount" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceCompanyBankAccount" } } } } } } }, "/api/FinanceCompanyBankAccount/GetByValue": { "post": { "tags": [ "FinanceCompanyBankAccount" ], "summary": "FinanceCompanyBankAccount: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceCompanyBankAccount-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceCompanyBankAccount_GetByValue_4E5715B7B308", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceCompanyBankAccount" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceCompanyBankAccount" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceCompanyBankAccount" } } } } } } }, "/api/FinanceCompanyBankAccount/GetLookup": { "post": { "tags": [ "FinanceCompanyBankAccount" ], "summary": "FinanceCompanyBankAccount: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceCompanyBankAccount-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceCompanyBankAccount_GetLookup_7C29BBA9F26F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceCompanyBankAccount/GetLookupByValue": { "post": { "tags": [ "FinanceCompanyBankAccount" ], "summary": "FinanceCompanyBankAccount: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceCompanyBankAccount-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceCompanyBankAccount_GetLookupByValue_4E30A1F2691C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceCompanyBankAccount/Page": { "get": { "tags": [ "FinanceCompanyBankAccount" ], "summary": "FinanceCompanyBankAccount: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceCompanyBankAccount-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceCompanyBankAccount_GetPage_58A057D2AE01", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceCompanyBankAccount/PageAsc": { "get": { "tags": [ "FinanceCompanyBankAccount" ], "summary": "FinanceCompanyBankAccount: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceCompanyBankAccount-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceCompanyBankAccount_GetPageAsc_D76479D7B76F", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceCompanyBankAccount/SearchByValue": { "post": { "tags": [ "FinanceCompanyBankAccount" ], "summary": "FinanceCompanyBankAccount: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceCompanyBankAccount-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceCompanyBankAccount_SearchByValue_CF5374C7635F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceCompanyBankAccount" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceCompanyBankAccount" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceCompanyBankAccount" } } } } } } }, "/api/FinanceCompanyBankAccount/TryGetByValue": { "post": { "tags": [ "FinanceCompanyBankAccount" ], "summary": "FinanceCompanyBankAccount: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceCompanyBankAccount-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceCompanyBankAccount_TryGetByValue_11E69848F95D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceCompanyBankAccount" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceCompanyBankAccount" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceCompanyBankAccount" } } } } } } }, "/api/FinanceCompanyBankAccount/UpsertGraph": { "put": { "tags": [ "FinanceCompanyBankAccount" ], "summary": "FinanceCompanyBankAccount: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceCompanyBankAccount-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceCompanyBankAccount_UpsertGraph_D10F6399062F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceCompanyBankAccount" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceCompanyBankAccount" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceCompanyBankAccount" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceCompanyBankAccount" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceCompanyBankAccount" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceCompanyBankAccount" } } } } } } }, "/api/FinanceCompanyBankAccount/UpsertGraphWithExtraFields": { "put": { "tags": [ "FinanceCompanyBankAccount" ], "summary": "FinanceCompanyBankAccount: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceCompanyBankAccount-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceCompanyBankAccount_UpsertGraphWithExtraFields_C9C6614D2FA2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceCompanyBankAccount" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceCompanyBankAccount" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceCompanyBankAccount" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceCompanyBankAccount" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceCompanyBankAccount" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceCompanyBankAccount" } } } } } } }, "/api/FinanceCostBearer": { "get": { "tags": [ "FinanceCostBearer" ], "summary": "FinanceCostBearer: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceCostBearer-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceCostBearer_GetAll_5554594834D5", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceCostBearer" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceCostBearer" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceCostBearer" } } } } } }, "post": { "tags": [ "FinanceCostBearer" ], "summary": "FinanceCostBearer: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceCostBearer-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceCostBearer_Post_24BD86E339F0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceCostBearer" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceCostBearer" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceCostBearer" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceCostBearer" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceCostBearer" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceCostBearer" } } } } } }, "put": { "tags": [ "FinanceCostBearer" ], "summary": "FinanceCostBearer: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceCostBearer-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceCostBearer_Put_6DF37454A20E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceCostBearer" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceCostBearer" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceCostBearer" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceCostBearer" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceCostBearer" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceCostBearer" } } } } } } }, "/api/FinanceCostBearer/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "FinanceCostBearer" ], "summary": "FinanceCostBearer: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceCostBearer-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceCostBearer_GetPageByValue_073B2482B8E1", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceCostBearer/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "FinanceCostBearer" ], "summary": "FinanceCostBearer: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceCostBearer-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceCostBearer_GetPageByValue2_FC84C3926373", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceCostBearer/DeleteByFilter": { "post": { "tags": [ "FinanceCostBearer" ], "summary": "FinanceCostBearer: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceCostBearer-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceCostBearer_DeleteByFilter_DE18374EAADD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/FinanceCostBearer/GetAllByValue": { "post": { "tags": [ "FinanceCostBearer" ], "summary": "FinanceCostBearer: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceCostBearer-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceCostBearer_GetAllByValue_A23BECE13E54", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceCostBearer" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceCostBearer" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceCostBearer" } } } } } } }, "/api/FinanceCostBearer/GetAllGraphByValue": { "post": { "tags": [ "FinanceCostBearer" ], "summary": "FinanceCostBearer: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceCostBearer-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceCostBearer_GetAllGraphByValue_84F2AB01CBD6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceCostBearer" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceCostBearer" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceCostBearer" } } } } } } }, "/api/FinanceCostBearer/GetByValue": { "post": { "tags": [ "FinanceCostBearer" ], "summary": "FinanceCostBearer: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceCostBearer-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceCostBearer_GetByValue_A33346D0CDC2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceCostBearer" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceCostBearer" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceCostBearer" } } } } } } }, "/api/FinanceCostBearer/GetLookup": { "post": { "tags": [ "FinanceCostBearer" ], "summary": "FinanceCostBearer: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceCostBearer-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceCostBearer_GetLookup_B21B147A3586", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceCostBearer/GetLookupByValue": { "post": { "tags": [ "FinanceCostBearer" ], "summary": "FinanceCostBearer: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceCostBearer-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceCostBearer_GetLookupByValue_55F7C6D15A5A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceCostBearer/Page": { "get": { "tags": [ "FinanceCostBearer" ], "summary": "FinanceCostBearer: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceCostBearer-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceCostBearer_GetPage_E67F1C8B6EDA", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceCostBearer/PageAsc": { "get": { "tags": [ "FinanceCostBearer" ], "summary": "FinanceCostBearer: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceCostBearer-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceCostBearer_GetPageAsc_8700D436CF1D", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceCostBearer/SearchByValue": { "post": { "tags": [ "FinanceCostBearer" ], "summary": "FinanceCostBearer: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceCostBearer-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceCostBearer_SearchByValue_E7F125DEBB18", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceCostBearer" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceCostBearer" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceCostBearer" } } } } } } }, "/api/FinanceCostBearer/TryGetByValue": { "post": { "tags": [ "FinanceCostBearer" ], "summary": "FinanceCostBearer: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceCostBearer-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceCostBearer_TryGetByValue_387E57510487", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceCostBearer" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceCostBearer" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceCostBearer" } } } } } } }, "/api/FinanceCostBearer/UpsertGraph": { "put": { "tags": [ "FinanceCostBearer" ], "summary": "FinanceCostBearer: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceCostBearer-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceCostBearer_UpsertGraph_D88BFC91A9C3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceCostBearer" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceCostBearer" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceCostBearer" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceCostBearer" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceCostBearer" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceCostBearer" } } } } } } }, "/api/FinanceCostBearer/UpsertGraphWithExtraFields": { "put": { "tags": [ "FinanceCostBearer" ], "summary": "FinanceCostBearer: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceCostBearer-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceCostBearer_UpsertGraphWithExtraFields_B6A870270217", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceCostBearer" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceCostBearer" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceCostBearer" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceCostBearer" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceCostBearer" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceCostBearer" } } } } } } }, "/api/FinanceCostCenter": { "get": { "tags": [ "FinanceCostCenter" ], "summary": "FinanceCostCenter: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceCostCenter-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceCostCenter_GetAll_FA82C2E47EB5", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceCostCenter" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceCostCenter" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceCostCenter" } } } } } }, "post": { "tags": [ "FinanceCostCenter" ], "summary": "FinanceCostCenter: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceCostCenter-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceCostCenter_Post_CD5084BA2265", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceCostCenter" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceCostCenter" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceCostCenter" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceCostCenter" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceCostCenter" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceCostCenter" } } } } } }, "put": { "tags": [ "FinanceCostCenter" ], "summary": "FinanceCostCenter: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceCostCenter-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceCostCenter_Put_8E4121219FE2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceCostCenter" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceCostCenter" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceCostCenter" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceCostCenter" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceCostCenter" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceCostCenter" } } } } } } }, "/api/FinanceCostCenter/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "FinanceCostCenter" ], "summary": "FinanceCostCenter: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceCostCenter-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceCostCenter_GetPageByValue_91E7D7D91488", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceCostCenter/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "FinanceCostCenter" ], "summary": "FinanceCostCenter: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceCostCenter-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceCostCenter_GetPageByValue2_775F279C11F2", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceCostCenter/DeleteByFilter": { "post": { "tags": [ "FinanceCostCenter" ], "summary": "FinanceCostCenter: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceCostCenter-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceCostCenter_DeleteByFilter_104AC293DC92", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/FinanceCostCenter/GetAllByValue": { "post": { "tags": [ "FinanceCostCenter" ], "summary": "FinanceCostCenter: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceCostCenter-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceCostCenter_GetAllByValue_AB50804923D1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceCostCenter" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceCostCenter" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceCostCenter" } } } } } } }, "/api/FinanceCostCenter/GetAllGraphByValue": { "post": { "tags": [ "FinanceCostCenter" ], "summary": "FinanceCostCenter: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceCostCenter-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceCostCenter_GetAllGraphByValue_BCB7F0F3A316", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceCostCenter" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceCostCenter" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceCostCenter" } } } } } } }, "/api/FinanceCostCenter/GetByValue": { "post": { "tags": [ "FinanceCostCenter" ], "summary": "FinanceCostCenter: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceCostCenter-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceCostCenter_GetByValue_413A3E337706", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceCostCenter" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceCostCenter" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceCostCenter" } } } } } } }, "/api/FinanceCostCenter/GetLookup": { "post": { "tags": [ "FinanceCostCenter" ], "summary": "FinanceCostCenter: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceCostCenter-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceCostCenter_GetLookup_CA123717E997", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceCostCenter/GetLookupByValue": { "post": { "tags": [ "FinanceCostCenter" ], "summary": "FinanceCostCenter: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceCostCenter-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceCostCenter_GetLookupByValue_244B2D896B1F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceCostCenter/Page": { "get": { "tags": [ "FinanceCostCenter" ], "summary": "FinanceCostCenter: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceCostCenter-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceCostCenter_GetPage_3B2DD8ACC283", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceCostCenter/PageAsc": { "get": { "tags": [ "FinanceCostCenter" ], "summary": "FinanceCostCenter: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceCostCenter-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceCostCenter_GetPageAsc_494F0476C413", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceCostCenter/SearchByValue": { "post": { "tags": [ "FinanceCostCenter" ], "summary": "FinanceCostCenter: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceCostCenter-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceCostCenter_SearchByValue_F2D2E808392A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceCostCenter" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceCostCenter" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceCostCenter" } } } } } } }, "/api/FinanceCostCenter/TryGetByValue": { "post": { "tags": [ "FinanceCostCenter" ], "summary": "FinanceCostCenter: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceCostCenter-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceCostCenter_TryGetByValue_CDBA4DFB7B56", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceCostCenter" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceCostCenter" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceCostCenter" } } } } } } }, "/api/FinanceCostCenter/UpsertGraph": { "put": { "tags": [ "FinanceCostCenter" ], "summary": "FinanceCostCenter: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceCostCenter-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceCostCenter_UpsertGraph_E01DF93FAD6F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceCostCenter" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceCostCenter" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceCostCenter" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceCostCenter" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceCostCenter" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceCostCenter" } } } } } } }, "/api/FinanceCostCenter/UpsertGraphWithExtraFields": { "put": { "tags": [ "FinanceCostCenter" ], "summary": "FinanceCostCenter: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceCostCenter-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceCostCenter_UpsertGraphWithExtraFields_AAB8C01AEC85", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceCostCenter" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceCostCenter" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceCostCenter" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceCostCenter" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceCostCenter" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceCostCenter" } } } } } } }, "/api/FinanceCostType": { "get": { "tags": [ "FinanceCostType" ], "summary": "FinanceCostType: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceCostType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceCostType_GetAll_0A9C25A56CAB", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceCostType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceCostType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceCostType" } } } } } }, "post": { "tags": [ "FinanceCostType" ], "summary": "FinanceCostType: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceCostType-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceCostType_Post_AF980F0C1812", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceCostType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceCostType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceCostType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceCostType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceCostType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceCostType" } } } } } }, "put": { "tags": [ "FinanceCostType" ], "summary": "FinanceCostType: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceCostType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceCostType_Put_4A20EB7FA788", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceCostType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceCostType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceCostType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceCostType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceCostType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceCostType" } } } } } } }, "/api/FinanceCostType/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "FinanceCostType" ], "summary": "FinanceCostType: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceCostType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceCostType_GetPageByValue_185B887BB73D", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceCostType/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "FinanceCostType" ], "summary": "FinanceCostType: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceCostType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceCostType_GetPageByValue2_AA2EAB163E80", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceCostType/DeleteByFilter": { "post": { "tags": [ "FinanceCostType" ], "summary": "FinanceCostType: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceCostType-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceCostType_DeleteByFilter_EC1185B73342", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/FinanceCostType/GetAllByValue": { "post": { "tags": [ "FinanceCostType" ], "summary": "FinanceCostType: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceCostType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceCostType_GetAllByValue_1DD094A7D918", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceCostType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceCostType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceCostType" } } } } } } }, "/api/FinanceCostType/GetAllGraphByValue": { "post": { "tags": [ "FinanceCostType" ], "summary": "FinanceCostType: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceCostType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceCostType_GetAllGraphByValue_E0FC2C90CD17", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceCostType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceCostType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceCostType" } } } } } } }, "/api/FinanceCostType/GetByValue": { "post": { "tags": [ "FinanceCostType" ], "summary": "FinanceCostType: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceCostType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceCostType_GetByValue_ED58B3ADD98F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceCostType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceCostType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceCostType" } } } } } } }, "/api/FinanceCostType/GetLookup": { "post": { "tags": [ "FinanceCostType" ], "summary": "FinanceCostType: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceCostType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceCostType_GetLookup_4ABF07C061DA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceCostType/GetLookupByValue": { "post": { "tags": [ "FinanceCostType" ], "summary": "FinanceCostType: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceCostType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceCostType_GetLookupByValue_68DDC320985E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceCostType/Page": { "get": { "tags": [ "FinanceCostType" ], "summary": "FinanceCostType: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceCostType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceCostType_GetPage_B11F8ECD2516", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceCostType/PageAsc": { "get": { "tags": [ "FinanceCostType" ], "summary": "FinanceCostType: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceCostType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceCostType_GetPageAsc_41BE57F61D24", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceCostType/SearchByValue": { "post": { "tags": [ "FinanceCostType" ], "summary": "FinanceCostType: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceCostType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceCostType_SearchByValue_0650E92AED87", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceCostType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceCostType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceCostType" } } } } } } }, "/api/FinanceCostType/TryGetByValue": { "post": { "tags": [ "FinanceCostType" ], "summary": "FinanceCostType: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceCostType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceCostType_TryGetByValue_FA7C835B69AB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceCostType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceCostType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceCostType" } } } } } } }, "/api/FinanceCostType/UpsertGraph": { "put": { "tags": [ "FinanceCostType" ], "summary": "FinanceCostType: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceCostType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceCostType_UpsertGraph_050231B66D08", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceCostType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceCostType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceCostType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceCostType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceCostType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceCostType" } } } } } } }, "/api/FinanceCostType/UpsertGraphWithExtraFields": { "put": { "tags": [ "FinanceCostType" ], "summary": "FinanceCostType: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceCostType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceCostType_UpsertGraphWithExtraFields_6B2DFECE98AD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceCostType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceCostType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceCostType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceCostType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceCostType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceCostType" } } } } } } }, "/api/FinanceDunning": { "get": { "tags": [ "FinanceDunning" ], "summary": "FinanceDunning: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceDunning-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceDunning_GetAll_1034DAF684E6", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceDunning" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceDunning" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceDunning" } } } } } }, "post": { "tags": [ "FinanceDunning" ], "summary": "FinanceDunning: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceDunning-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceDunning_Post_D18ED35792B2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceDunning" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceDunning" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceDunning" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceDunning" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceDunning" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceDunning" } } } } } }, "put": { "tags": [ "FinanceDunning" ], "summary": "FinanceDunning: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceDunning-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceDunning_Put_6C9EC937F90A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceDunning" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceDunning" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceDunning" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceDunning" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceDunning" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceDunning" } } } } } } }, "/api/FinanceDunning/{FinanceDunningId}/PerformOutputControlFormat_Email": { "post": { "tags": [ "FinanceDunning" ], "summary": "FinanceDunning: PerformOutputControlFormat_Email", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceDunning-Create.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceDunning_PerformOutputControlFormat_Email_F2B0EBF417E6", "parameters": [ { "name": "FinanceDunningId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "saveAsDraft", "in": "query", "schema": { "type": "boolean", "default": false } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Email" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Email" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Email" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/FinanceDunning/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "FinanceDunning" ], "summary": "FinanceDunning: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceDunning-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceDunning_GetPageByValue_A283950FB7B3", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceDunning/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "FinanceDunning" ], "summary": "FinanceDunning: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceDunning-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceDunning_GetPageByValue2_0BB4E38EED55", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceDunning/DeleteByFilter": { "post": { "tags": [ "FinanceDunning" ], "summary": "FinanceDunning: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceDunning-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceDunning_DeleteByFilter_414B566291F1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/FinanceDunning/DownloadArchivedFile/{financeDunningId}": { "get": { "tags": [ "FinanceDunning" ], "summary": "FinanceDunning: DownloadArchivedFile", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceDunning-Read.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceDunning_DownloadArchivedFile_BD5F4F2660DD", "parameters": [ { "name": "financeDunningId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceDunning/GetAllByValue": { "post": { "tags": [ "FinanceDunning" ], "summary": "FinanceDunning: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceDunning-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceDunning_GetAllByValue_79BDE54A71F4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceDunning" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceDunning" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceDunning" } } } } } } }, "/api/FinanceDunning/GetAllGraphByValue": { "post": { "tags": [ "FinanceDunning" ], "summary": "FinanceDunning: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceDunning-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceDunning_GetAllGraphByValue_3901C05F4CE4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceDunning" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceDunning" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceDunning" } } } } } } }, "/api/FinanceDunning/GetByValue": { "post": { "tags": [ "FinanceDunning" ], "summary": "FinanceDunning: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceDunning-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceDunning_GetByValue_617ADE87366A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceDunning" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceDunning" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceDunning" } } } } } } }, "/api/FinanceDunning/GetLookup": { "post": { "tags": [ "FinanceDunning" ], "summary": "FinanceDunning: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceDunning-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceDunning_GetLookup_839332080FA2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceDunning/GetLookupByValue": { "post": { "tags": [ "FinanceDunning" ], "summary": "FinanceDunning: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceDunning-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceDunning_GetLookupByValue_9FE6B3174E8A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceDunning/Page": { "get": { "tags": [ "FinanceDunning" ], "summary": "FinanceDunning: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceDunning-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceDunning_GetPage_FB5A584C08AE", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceDunning/PageAsc": { "get": { "tags": [ "FinanceDunning" ], "summary": "FinanceDunning: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceDunning-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceDunning_GetPageAsc_F73D11A819FA", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceDunning/SearchByValue": { "post": { "tags": [ "FinanceDunning" ], "summary": "FinanceDunning: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceDunning-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceDunning_SearchByValue_AFF5DBF3F958", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceDunning" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceDunning" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceDunning" } } } } } } }, "/api/FinanceDunning/TryGetByValue": { "post": { "tags": [ "FinanceDunning" ], "summary": "FinanceDunning: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceDunning-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceDunning_TryGetByValue_EABF7B4BB949", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceDunning" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceDunning" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceDunning" } } } } } } }, "/api/FinanceDunning/UpsertGraph": { "put": { "tags": [ "FinanceDunning" ], "summary": "FinanceDunning: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceDunning-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceDunning_UpsertGraph_7FC453BC33AB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceDunning" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceDunning" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceDunning" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceDunning" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceDunning" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceDunning" } } } } } } }, "/api/FinanceDunning/UpsertGraphWithExtraFields": { "put": { "tags": [ "FinanceDunning" ], "summary": "FinanceDunning: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceDunning-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceDunning_UpsertGraphWithExtraFields_7F4D72C32977", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceDunning" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceDunning" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceDunning" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceDunning" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceDunning" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceDunning" } } } } } } }, "/api/FinanceDunningLevel": { "get": { "tags": [ "FinanceDunningLevel" ], "summary": "FinanceDunningLevel: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceDunningLevel-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceDunningLevel_GetAll_A4B8A77ACC0B", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceDunningLevel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceDunningLevel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceDunningLevel" } } } } } }, "post": { "tags": [ "FinanceDunningLevel" ], "summary": "FinanceDunningLevel: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceDunningLevel-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceDunningLevel_Post_0D4E7E3CA9E3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceDunningLevel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceDunningLevel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceDunningLevel" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceDunningLevel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceDunningLevel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceDunningLevel" } } } } } }, "put": { "tags": [ "FinanceDunningLevel" ], "summary": "FinanceDunningLevel: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceDunningLevel-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceDunningLevel_Put_5CC364E8AD52", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceDunningLevel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceDunningLevel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceDunningLevel" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceDunningLevel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceDunningLevel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceDunningLevel" } } } } } } }, "/api/FinanceDunningLevel/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "FinanceDunningLevel" ], "summary": "FinanceDunningLevel: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceDunningLevel-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceDunningLevel_GetPageByValue_78E2D7C96610", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceDunningLevel/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "FinanceDunningLevel" ], "summary": "FinanceDunningLevel: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceDunningLevel-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceDunningLevel_GetPageByValue2_2E45F1F7DF39", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceDunningLevel/DeleteByFilter": { "post": { "tags": [ "FinanceDunningLevel" ], "summary": "FinanceDunningLevel: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceDunningLevel-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceDunningLevel_DeleteByFilter_F76A8B24547E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/FinanceDunningLevel/GetAllByValue": { "post": { "tags": [ "FinanceDunningLevel" ], "summary": "FinanceDunningLevel: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceDunningLevel-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceDunningLevel_GetAllByValue_A8BBE4EB2A6F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceDunningLevel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceDunningLevel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceDunningLevel" } } } } } } }, "/api/FinanceDunningLevel/GetAllGraphByValue": { "post": { "tags": [ "FinanceDunningLevel" ], "summary": "FinanceDunningLevel: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceDunningLevel-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceDunningLevel_GetAllGraphByValue_E4CA094E93AA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceDunningLevel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceDunningLevel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceDunningLevel" } } } } } } }, "/api/FinanceDunningLevel/GetByValue": { "post": { "tags": [ "FinanceDunningLevel" ], "summary": "FinanceDunningLevel: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceDunningLevel-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceDunningLevel_GetByValue_CE1135F593A9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceDunningLevel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceDunningLevel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceDunningLevel" } } } } } } }, "/api/FinanceDunningLevel/GetLookup": { "post": { "tags": [ "FinanceDunningLevel" ], "summary": "FinanceDunningLevel: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceDunningLevel-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceDunningLevel_GetLookup_B1E89752D69E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceDunningLevel/GetLookupByValue": { "post": { "tags": [ "FinanceDunningLevel" ], "summary": "FinanceDunningLevel: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceDunningLevel-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceDunningLevel_GetLookupByValue_56EE635F7142", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceDunningLevel/Page": { "get": { "tags": [ "FinanceDunningLevel" ], "summary": "FinanceDunningLevel: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceDunningLevel-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceDunningLevel_GetPage_3D4FC4E077DE", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceDunningLevel/PageAsc": { "get": { "tags": [ "FinanceDunningLevel" ], "summary": "FinanceDunningLevel: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceDunningLevel-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceDunningLevel_GetPageAsc_C41C56FCFD03", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceDunningLevel/SearchByValue": { "post": { "tags": [ "FinanceDunningLevel" ], "summary": "FinanceDunningLevel: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceDunningLevel-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceDunningLevel_SearchByValue_908F6FC40906", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceDunningLevel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceDunningLevel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceDunningLevel" } } } } } } }, "/api/FinanceDunningLevel/TryGetByValue": { "post": { "tags": [ "FinanceDunningLevel" ], "summary": "FinanceDunningLevel: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceDunningLevel-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceDunningLevel_TryGetByValue_03BFC1CFFB5A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceDunningLevel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceDunningLevel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceDunningLevel" } } } } } } }, "/api/FinanceDunningLevel/UpsertGraph": { "put": { "tags": [ "FinanceDunningLevel" ], "summary": "FinanceDunningLevel: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceDunningLevel-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceDunningLevel_UpsertGraph_47523632C5A7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceDunningLevel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceDunningLevel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceDunningLevel" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceDunningLevel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceDunningLevel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceDunningLevel" } } } } } } }, "/api/FinanceDunningLevel/UpsertGraphWithExtraFields": { "put": { "tags": [ "FinanceDunningLevel" ], "summary": "FinanceDunningLevel: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceDunningLevel-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceDunningLevel_UpsertGraphWithExtraFields_9763C1486FD3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceDunningLevel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceDunningLevel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceDunningLevel" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceDunningLevel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceDunningLevel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceDunningLevel" } } } } } } }, "/api/FinanceDunningPosition": { "get": { "tags": [ "FinanceDunningPosition" ], "summary": "FinanceDunningPosition: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceDunningPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceDunningPosition_GetAll_8CBCCA617BEC", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceDunningPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceDunningPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceDunningPosition" } } } } } }, "post": { "tags": [ "FinanceDunningPosition" ], "summary": "FinanceDunningPosition: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceDunningPosition-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceDunningPosition_Post_281EC90A063B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceDunningPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceDunningPosition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceDunningPosition" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceDunningPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceDunningPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceDunningPosition" } } } } } }, "put": { "tags": [ "FinanceDunningPosition" ], "summary": "FinanceDunningPosition: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceDunningPosition-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceDunningPosition_Put_A68DB61D1D60", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceDunningPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceDunningPosition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceDunningPosition" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceDunningPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceDunningPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceDunningPosition" } } } } } } }, "/api/FinanceDunningPosition/{DunningId}/PageFromViewByDunningId": { "get": { "tags": [ "FinanceDunningPosition" ], "summary": "FinanceDunningPosition: GetPageFromViewByArticleId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceDunningPosition-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceDunningPosition_GetPageFromViewByArticleId_A4172BFC4E55", "parameters": [ { "name": "DunningId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceDunningPosition/{OpenProcurement}/PageFromViewUnmatched": { "get": { "tags": [ "FinanceDunningPosition" ], "summary": "FinanceDunningPosition: GetPageFromViewUnmatched", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceDunningPosition-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceDunningPosition_GetPageFromViewUnmatched_53F1C9EA53B8", "parameters": [ { "name": "FilterUnmatched", "in": "query", "schema": { "type": "boolean" } }, { "name": "OpenProcurement", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceDunningPosition/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "FinanceDunningPosition" ], "summary": "FinanceDunningPosition: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceDunningPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceDunningPosition_GetPageByValue_FDD0B95006C6", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceDunningPosition/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "FinanceDunningPosition" ], "summary": "FinanceDunningPosition: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceDunningPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceDunningPosition_GetPageByValue2_7232DA452D03", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceDunningPosition/Clear": { "get": { "tags": [ "FinanceDunningPosition" ], "summary": "FinanceDunningPosition: ClearProcurement", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceDunningPosition-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceDunningPosition_ClearProcurement_EAB6299843B7", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/FinanceDunningPosition/CreateDunning": { "get": { "tags": [ "FinanceDunningPosition" ], "summary": "FinanceDunningPosition: CreateDunning", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceDunningPosition-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceDunningPosition_CreateDunning_3ACEFD7B09EA", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/FinanceDunningPosition/DeleteByFilter": { "post": { "tags": [ "FinanceDunningPosition" ], "summary": "FinanceDunningPosition: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceDunningPosition-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceDunningPosition_DeleteByFilter_5DFD6112FD39", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/FinanceDunningPosition/GetAllByValue": { "post": { "tags": [ "FinanceDunningPosition" ], "summary": "FinanceDunningPosition: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceDunningPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceDunningPosition_GetAllByValue_E10FF0933651", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceDunningPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceDunningPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceDunningPosition" } } } } } } }, "/api/FinanceDunningPosition/GetAllGraphByValue": { "post": { "tags": [ "FinanceDunningPosition" ], "summary": "FinanceDunningPosition: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceDunningPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceDunningPosition_GetAllGraphByValue_933684CD4A60", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceDunningPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceDunningPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceDunningPosition" } } } } } } }, "/api/FinanceDunningPosition/GetByValue": { "post": { "tags": [ "FinanceDunningPosition" ], "summary": "FinanceDunningPosition: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceDunningPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceDunningPosition_GetByValue_E873E0ED23A3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceDunningPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceDunningPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceDunningPosition" } } } } } } }, "/api/FinanceDunningPosition/GetLookup": { "post": { "tags": [ "FinanceDunningPosition" ], "summary": "FinanceDunningPosition: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceDunningPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceDunningPosition_GetLookup_9D670B1B357A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceDunningPosition/GetLookupByValue": { "post": { "tags": [ "FinanceDunningPosition" ], "summary": "FinanceDunningPosition: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceDunningPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceDunningPosition_GetLookupByValue_6C40B2589BE2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceDunningPosition/Page": { "get": { "tags": [ "FinanceDunningPosition" ], "summary": "FinanceDunningPosition: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceDunningPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceDunningPosition_GetPage_86BA127043CD", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceDunningPosition/PageAsc": { "get": { "tags": [ "FinanceDunningPosition" ], "summary": "FinanceDunningPosition: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceDunningPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceDunningPosition_GetPageAsc_3A66ED4A9078", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceDunningPosition/PageFromView": { "get": { "tags": [ "FinanceDunningPosition" ], "summary": "FinanceDunningPosition: GetPageFromView", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceDunningPosition-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceDunningPosition_GetPageFromView_7D2D05744334", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceDunningPosition/RunWizard": { "post": { "tags": [ "FinanceDunningPosition" ], "summary": "FinanceDunningPosition: RunWizard", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceDunningPosition-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceDunningPosition_RunWizard_5DEFA86A492C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceDunningPosition_RunWizardRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceDunningPosition_RunWizardRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceDunningPosition_RunWizardRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/FinanceDunningPosition/SearchByValue": { "post": { "tags": [ "FinanceDunningPosition" ], "summary": "FinanceDunningPosition: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceDunningPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceDunningPosition_SearchByValue_96C789A6A9B4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceDunningPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceDunningPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceDunningPosition" } } } } } } }, "/api/FinanceDunningPosition/TryGetByValue": { "post": { "tags": [ "FinanceDunningPosition" ], "summary": "FinanceDunningPosition: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceDunningPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceDunningPosition_TryGetByValue_4C4D1DD9461C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceDunningPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceDunningPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceDunningPosition" } } } } } } }, "/api/FinanceDunningPosition/UpsertGraph": { "put": { "tags": [ "FinanceDunningPosition" ], "summary": "FinanceDunningPosition: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceDunningPosition-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceDunningPosition_UpsertGraph_2B0782186D48", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceDunningPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceDunningPosition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceDunningPosition" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceDunningPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceDunningPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceDunningPosition" } } } } } } }, "/api/FinanceDunningPosition/UpsertGraphWithExtraFields": { "put": { "tags": [ "FinanceDunningPosition" ], "summary": "FinanceDunningPosition: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceDunningPosition-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceDunningPosition_UpsertGraphWithExtraFields_202D6458712D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceDunningPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceDunningPosition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceDunningPosition" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceDunningPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceDunningPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceDunningPosition" } } } } } } }, "/api/FinanceEInvoiceTaxKeyCategory": { "get": { "tags": [ "FinanceEInvoiceTaxKeyCategory" ], "summary": "FinanceEInvoiceTaxKeyCategory: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceEInvoiceTaxKeyCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceEInvoiceTaxKeyCategory_GetAll_71A2A506287D", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceEInvoiceTaxKeyCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceEInvoiceTaxKeyCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceEInvoiceTaxKeyCategory" } } } } } }, "post": { "tags": [ "FinanceEInvoiceTaxKeyCategory" ], "summary": "FinanceEInvoiceTaxKeyCategory: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceEInvoiceTaxKeyCategory-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceEInvoiceTaxKeyCategory_Post_F620FE319D32", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceEInvoiceTaxKeyCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceEInvoiceTaxKeyCategory" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceEInvoiceTaxKeyCategory" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceEInvoiceTaxKeyCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceEInvoiceTaxKeyCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceEInvoiceTaxKeyCategory" } } } } } }, "put": { "tags": [ "FinanceEInvoiceTaxKeyCategory" ], "summary": "FinanceEInvoiceTaxKeyCategory: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceEInvoiceTaxKeyCategory-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceEInvoiceTaxKeyCategory_Put_22E2836E4698", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceEInvoiceTaxKeyCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceEInvoiceTaxKeyCategory" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceEInvoiceTaxKeyCategory" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceEInvoiceTaxKeyCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceEInvoiceTaxKeyCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceEInvoiceTaxKeyCategory" } } } } } } }, "/api/FinanceEInvoiceTaxKeyCategory/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "FinanceEInvoiceTaxKeyCategory" ], "summary": "FinanceEInvoiceTaxKeyCategory: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceEInvoiceTaxKeyCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceEInvoiceTaxKeyCategory_GetPageByValue_7A672CA82F90", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceEInvoiceTaxKeyCategory/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "FinanceEInvoiceTaxKeyCategory" ], "summary": "FinanceEInvoiceTaxKeyCategory: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceEInvoiceTaxKeyCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceEInvoiceTaxKeyCategory_GetPageByValue2_59C382476A8F", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceEInvoiceTaxKeyCategory/DeleteByFilter": { "post": { "tags": [ "FinanceEInvoiceTaxKeyCategory" ], "summary": "FinanceEInvoiceTaxKeyCategory: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceEInvoiceTaxKeyCategory-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceEInvoiceTaxKeyCategory_DeleteByFilter_F6C8257F2545", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/FinanceEInvoiceTaxKeyCategory/GetAllByValue": { "post": { "tags": [ "FinanceEInvoiceTaxKeyCategory" ], "summary": "FinanceEInvoiceTaxKeyCategory: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceEInvoiceTaxKeyCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceEInvoiceTaxKeyCategory_GetAllByValue_356ED4796B13", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceEInvoiceTaxKeyCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceEInvoiceTaxKeyCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceEInvoiceTaxKeyCategory" } } } } } } }, "/api/FinanceEInvoiceTaxKeyCategory/GetAllGraphByValue": { "post": { "tags": [ "FinanceEInvoiceTaxKeyCategory" ], "summary": "FinanceEInvoiceTaxKeyCategory: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceEInvoiceTaxKeyCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceEInvoiceTaxKeyCategory_GetAllGraphByValue_57DDB5F9F43A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceEInvoiceTaxKeyCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceEInvoiceTaxKeyCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceEInvoiceTaxKeyCategory" } } } } } } }, "/api/FinanceEInvoiceTaxKeyCategory/GetByValue": { "post": { "tags": [ "FinanceEInvoiceTaxKeyCategory" ], "summary": "FinanceEInvoiceTaxKeyCategory: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceEInvoiceTaxKeyCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceEInvoiceTaxKeyCategory_GetByValue_805939B216AF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceEInvoiceTaxKeyCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceEInvoiceTaxKeyCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceEInvoiceTaxKeyCategory" } } } } } } }, "/api/FinanceEInvoiceTaxKeyCategory/GetLookup": { "post": { "tags": [ "FinanceEInvoiceTaxKeyCategory" ], "summary": "FinanceEInvoiceTaxKeyCategory: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceEInvoiceTaxKeyCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceEInvoiceTaxKeyCategory_GetLookup_22A0884469B2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceEInvoiceTaxKeyCategory/GetLookupByValue": { "post": { "tags": [ "FinanceEInvoiceTaxKeyCategory" ], "summary": "FinanceEInvoiceTaxKeyCategory: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceEInvoiceTaxKeyCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceEInvoiceTaxKeyCategory_GetLookupByValue_56554BB6BBCB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceEInvoiceTaxKeyCategory/Page": { "get": { "tags": [ "FinanceEInvoiceTaxKeyCategory" ], "summary": "FinanceEInvoiceTaxKeyCategory: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceEInvoiceTaxKeyCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceEInvoiceTaxKeyCategory_GetPage_8B851325E42A", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceEInvoiceTaxKeyCategory/PageAsc": { "get": { "tags": [ "FinanceEInvoiceTaxKeyCategory" ], "summary": "FinanceEInvoiceTaxKeyCategory: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceEInvoiceTaxKeyCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceEInvoiceTaxKeyCategory_GetPageAsc_4ED770621543", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceEInvoiceTaxKeyCategory/SearchByValue": { "post": { "tags": [ "FinanceEInvoiceTaxKeyCategory" ], "summary": "FinanceEInvoiceTaxKeyCategory: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceEInvoiceTaxKeyCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceEInvoiceTaxKeyCategory_SearchByValue_C6DB61319932", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceEInvoiceTaxKeyCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceEInvoiceTaxKeyCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceEInvoiceTaxKeyCategory" } } } } } } }, "/api/FinanceEInvoiceTaxKeyCategory/TryGetByValue": { "post": { "tags": [ "FinanceEInvoiceTaxKeyCategory" ], "summary": "FinanceEInvoiceTaxKeyCategory: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceEInvoiceTaxKeyCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceEInvoiceTaxKeyCategory_TryGetByValue_2F40D625F6EF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceEInvoiceTaxKeyCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceEInvoiceTaxKeyCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceEInvoiceTaxKeyCategory" } } } } } } }, "/api/FinanceEInvoiceTaxKeyCategory/UpsertGraph": { "put": { "tags": [ "FinanceEInvoiceTaxKeyCategory" ], "summary": "FinanceEInvoiceTaxKeyCategory: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceEInvoiceTaxKeyCategory-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceEInvoiceTaxKeyCategory_UpsertGraph_B30DF7610A3D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceEInvoiceTaxKeyCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceEInvoiceTaxKeyCategory" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceEInvoiceTaxKeyCategory" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceEInvoiceTaxKeyCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceEInvoiceTaxKeyCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceEInvoiceTaxKeyCategory" } } } } } } }, "/api/FinanceEInvoiceTaxKeyCategory/UpsertGraphWithExtraFields": { "put": { "tags": [ "FinanceEInvoiceTaxKeyCategory" ], "summary": "FinanceEInvoiceTaxKeyCategory: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceEInvoiceTaxKeyCategory-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceEInvoiceTaxKeyCategory_UpsertGraphWithExtraFields_4FB47A1B53C4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceEInvoiceTaxKeyCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceEInvoiceTaxKeyCategory" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceEInvoiceTaxKeyCategory" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceEInvoiceTaxKeyCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceEInvoiceTaxKeyCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceEInvoiceTaxKeyCategory" } } } } } } }, "/api/FinanceFixedAsset": { "get": { "tags": [ "FinanceFixedAsset" ], "summary": "FinanceFixedAsset: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAsset-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAsset_GetAll_A3FFBAD23853", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAsset" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAsset" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAsset" } } } } } }, "post": { "tags": [ "FinanceFixedAsset" ], "summary": "FinanceFixedAsset: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAsset-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAsset_Post_7B47A00A75FB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAsset" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAsset" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAsset" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAsset" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAsset" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAsset" } } } } } }, "put": { "tags": [ "FinanceFixedAsset" ], "summary": "FinanceFixedAsset: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAsset-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAsset_Put_522ADDC87FEC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAsset" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAsset" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAsset" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAsset" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAsset" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAsset" } } } } } } }, "/api/FinanceFixedAsset/{FixedAssetId}/GetMinUnpostedCycleNumber": { "get": { "tags": [ "FinanceFixedAsset" ], "summary": "FinanceFixedAsset: GetMinUnpostedCycleNumber", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAsset-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAsset_GetMinUnpostedCycleNumber_CCD85CA4D9F2", "parameters": [ { "name": "FixedAssetId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Nullable_Of_System.Int64" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Nullable_Of_System.Int64" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Nullable_Of_System.Int64" } } } } } } }, "/api/FinanceFixedAsset/{FixedAssetId}/GetSwitchToLinearOptions": { "get": { "tags": [ "FinanceFixedAsset" ], "summary": "FinanceFixedAsset: GetSwitchToLinearOptions", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAsset-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAsset_GetSwitchToLinearOptions_1846FFF278D1", "parameters": [ { "name": "FixedAssetId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAsset_SwitchToLinearOptionsResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAsset_SwitchToLinearOptionsResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAsset_SwitchToLinearOptionsResult" } } } } } } }, "/api/FinanceFixedAsset/{FixedAssetId}/PageFromViewByFixedAssetId": { "get": { "tags": [ "FinanceFixedAsset" ], "summary": "FinanceFixedAsset: GetPageFromViewByFixedAssetId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAsset-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAsset_GetPageFromViewByFixedAssetId_863B66A94D3F", "parameters": [ { "name": "FixedAssetId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceFixedAsset/{groupId}/{includeSubNodes}/PageByGroup": { "get": { "tags": [ "FinanceFixedAsset" ], "summary": "FinanceFixedAsset: GetPageByGroup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAsset-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAsset_GetPageByGroup_61FF4D44E04D", "parameters": [ { "name": "groupId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "includeSubNodes", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceFixedAsset/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "FinanceFixedAsset" ], "summary": "FinanceFixedAsset: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAsset-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAsset_GetPageByValue_D8419865F9AE", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceFixedAsset/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "FinanceFixedAsset" ], "summary": "FinanceFixedAsset: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAsset-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAsset_GetPageByValue2_0F270F5E4A48", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceFixedAsset/CopyDepreciationTypeDetails": { "post": { "tags": [ "FinanceFixedAsset" ], "summary": "FinanceFixedAsset: CopyDepreciationTypeDetails", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAsset-Update.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAsset_CopyDepreciationTypeDetails_AB88C6485412", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAsset_CopyDepreciationTypeDetailsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAsset_CopyDepreciationTypeDetailsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAsset_CopyDepreciationTypeDetailsRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/FinanceFixedAsset/CreateDepreciationPosting": { "post": { "tags": [ "FinanceFixedAsset" ], "summary": "FinanceFixedAsset: CreateDepreciationPosting", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAsset-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAsset_CreateDepreciationPosting_A4FE755F14A1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAsset_CreateDepreciationPostingRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAsset_CreateDepreciationPostingRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAsset_CreateDepreciationPostingRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/FinanceFixedAsset/CreateDepreciations": { "post": { "tags": [ "FinanceFixedAsset" ], "summary": "FinanceFixedAsset: CreateDepreciations", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAsset-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAsset_CreateDepreciations_1A1590FB148C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAsset_SuggestDepreciationsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAsset_SuggestDepreciationsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAsset_SuggestDepreciationsRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xPROC696_FinanceFixedAssetWizard_PostingResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xPROC696_FinanceFixedAssetWizard_PostingResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xPROC696_FinanceFixedAssetWizard_PostingResult" } } } } } } }, "/api/FinanceFixedAsset/DeleteByFilter": { "post": { "tags": [ "FinanceFixedAsset" ], "summary": "FinanceFixedAsset: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAsset-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAsset_DeleteByFilter_E4D8F69E6D1C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/FinanceFixedAsset/DeleteDepreciationSuggestions": { "post": { "tags": [ "FinanceFixedAsset" ], "summary": "FinanceFixedAsset: DeleteDepreciationSuggestions", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAsset-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAsset_DeleteDepreciationSuggestions_533062847636", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAsset_DeleteDepreciationSuggestionsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAsset_DeleteDepreciationSuggestionsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAsset_DeleteDepreciationSuggestionsRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/FinanceFixedAsset/DisposalPreview": { "post": { "tags": [ "FinanceFixedAsset" ], "summary": "FinanceFixedAsset: DisposalPreview", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAsset-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAsset_DisposalPreview_789F39D66CF7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAsset_DisposalPreviewRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAsset_DisposalPreviewRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAsset_DisposalPreviewRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAsset_DisposalPreviewResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAsset_DisposalPreviewResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAsset_DisposalPreviewResult" } } } } } } }, "/api/FinanceFixedAsset/Dispose": { "post": { "tags": [ "FinanceFixedAsset" ], "summary": "FinanceFixedAsset: Dispose", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAsset-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAsset_Dispose_633B659D6063", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAsset_DisposeRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAsset_DisposeRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAsset_DisposeRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/FinanceFixedAsset/GetAllByValue": { "post": { "tags": [ "FinanceFixedAsset" ], "summary": "FinanceFixedAsset: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAsset-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAsset_GetAllByValue_3976FE35D658", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAsset" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAsset" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAsset" } } } } } } }, "/api/FinanceFixedAsset/GetAllGraphByValue": { "post": { "tags": [ "FinanceFixedAsset" ], "summary": "FinanceFixedAsset: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAsset-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAsset_GetAllGraphByValue_00F18975BD4C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAsset" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAsset" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAsset" } } } } } } }, "/api/FinanceFixedAsset/GetByValue": { "post": { "tags": [ "FinanceFixedAsset" ], "summary": "FinanceFixedAsset: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAsset-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAsset_GetByValue_A96BD845C527", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAsset" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAsset" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAsset" } } } } } } }, "/api/FinanceFixedAsset/GetLookup": { "post": { "tags": [ "FinanceFixedAsset" ], "summary": "FinanceFixedAsset: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAsset-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAsset_GetLookup_56527A0B669B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceFixedAsset/GetLookupByValue": { "post": { "tags": [ "FinanceFixedAsset" ], "summary": "FinanceFixedAsset: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAsset-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAsset_GetLookupByValue_676AA28268BB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceFixedAsset/LinkPosting": { "post": { "tags": [ "FinanceFixedAsset" ], "summary": "FinanceFixedAsset: LinkPosting", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAsset-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAsset_LinkPosting_2FC622A45A2F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAsset_LinkPostingRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAsset_LinkPostingRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAsset_LinkPostingRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/FinanceFixedAsset/Page": { "get": { "tags": [ "FinanceFixedAsset" ], "summary": "FinanceFixedAsset: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAsset-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAsset_GetPage_2F0B4021E3D0", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceFixedAsset/PageAsc": { "get": { "tags": [ "FinanceFixedAsset" ], "summary": "FinanceFixedAsset: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAsset-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAsset_GetPageAsc_2CCB9C5F12D0", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceFixedAsset/SearchByValue": { "post": { "tags": [ "FinanceFixedAsset" ], "summary": "FinanceFixedAsset: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAsset-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAsset_SearchByValue_04D92772AA8D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceFixedAsset" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceFixedAsset" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceFixedAsset" } } } } } } }, "/api/FinanceFixedAsset/SuggestDepreciations": { "post": { "tags": [ "FinanceFixedAsset" ], "summary": "FinanceFixedAsset: SuggestDepreciations", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAsset-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAsset_SuggestDepreciations_012DD9405216", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAsset_SuggestDepreciationsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAsset_SuggestDepreciationsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAsset_SuggestDepreciationsRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/FinanceFixedAsset/SwitchToLinear": { "post": { "tags": [ "FinanceFixedAsset" ], "summary": "FinanceFixedAsset: SwitchToLinear", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAsset-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAsset_SwitchToLinear_1C512F5D6703", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAsset_SwitchToLinearRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAsset_SwitchToLinearRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAsset_SwitchToLinearRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/FinanceFixedAsset/TryGetByValue": { "post": { "tags": [ "FinanceFixedAsset" ], "summary": "FinanceFixedAsset: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAsset-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAsset_TryGetByValue_DD7F179A1BE2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAsset" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAsset" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAsset" } } } } } } }, "/api/FinanceFixedAsset/UpsertGraph": { "put": { "tags": [ "FinanceFixedAsset" ], "summary": "FinanceFixedAsset: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAsset-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAsset_UpsertGraph_6524BFB3CDB0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAsset" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAsset" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAsset" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAsset" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAsset" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAsset" } } } } } } }, "/api/FinanceFixedAsset/UpsertGraphWithExtraFields": { "put": { "tags": [ "FinanceFixedAsset" ], "summary": "FinanceFixedAsset: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAsset-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAsset_UpsertGraphWithExtraFields_C2C170DBBF17", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAsset" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAsset" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAsset" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAsset" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAsset" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAsset" } } } } } } }, "/api/FinanceFixedAssetClass": { "get": { "tags": [ "FinanceFixedAssetClass" ], "summary": "FinanceFixedAssetClass: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetClass-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetClass_GetAll_36F0D3E75245", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetClass" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetClass" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetClass" } } } } } }, "post": { "tags": [ "FinanceFixedAssetClass" ], "summary": "FinanceFixedAssetClass: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetClass-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetClass_Post_9D256EB2BD6C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetClass" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetClass" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetClass" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetClass" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetClass" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetClass" } } } } } }, "put": { "tags": [ "FinanceFixedAssetClass" ], "summary": "FinanceFixedAssetClass: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetClass-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetClass_Put_639C173B6702", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetClass" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetClass" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetClass" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetClass" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetClass" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetClass" } } } } } } }, "/api/FinanceFixedAssetClass/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "FinanceFixedAssetClass" ], "summary": "FinanceFixedAssetClass: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetClass-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetClass_GetPageByValue_7287A4552F50", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceFixedAssetClass/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "FinanceFixedAssetClass" ], "summary": "FinanceFixedAssetClass: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetClass-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetClass_GetPageByValue2_0DB9E11CFD9A", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceFixedAssetClass/DeleteByFilter": { "post": { "tags": [ "FinanceFixedAssetClass" ], "summary": "FinanceFixedAssetClass: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetClass-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetClass_DeleteByFilter_1D4607A77602", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/FinanceFixedAssetClass/GetAllByValue": { "post": { "tags": [ "FinanceFixedAssetClass" ], "summary": "FinanceFixedAssetClass: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetClass-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetClass_GetAllByValue_F5C19280D570", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetClass" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetClass" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetClass" } } } } } } }, "/api/FinanceFixedAssetClass/GetAllGraphByValue": { "post": { "tags": [ "FinanceFixedAssetClass" ], "summary": "FinanceFixedAssetClass: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetClass-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetClass_GetAllGraphByValue_8B6EA808D959", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetClass" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetClass" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetClass" } } } } } } }, "/api/FinanceFixedAssetClass/GetByValue": { "post": { "tags": [ "FinanceFixedAssetClass" ], "summary": "FinanceFixedAssetClass: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetClass-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetClass_GetByValue_DA91BEC0AD0E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetClass" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetClass" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetClass" } } } } } } }, "/api/FinanceFixedAssetClass/GetLookup": { "post": { "tags": [ "FinanceFixedAssetClass" ], "summary": "FinanceFixedAssetClass: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetClass-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetClass_GetLookup_3C54BA4B5AB6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceFixedAssetClass/GetLookupByValue": { "post": { "tags": [ "FinanceFixedAssetClass" ], "summary": "FinanceFixedAssetClass: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetClass-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetClass_GetLookupByValue_E1359A3D169E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceFixedAssetClass/Page": { "get": { "tags": [ "FinanceFixedAssetClass" ], "summary": "FinanceFixedAssetClass: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetClass-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetClass_GetPage_A8F22D70B1AF", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceFixedAssetClass/PageAsc": { "get": { "tags": [ "FinanceFixedAssetClass" ], "summary": "FinanceFixedAssetClass: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetClass-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetClass_GetPageAsc_FC00F1DDEF9B", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceFixedAssetClass/PageFinanceFixedAssetClassesByParent/{ParentId}/{IncludeSubNodes}/{TopParentsOnly}": { "get": { "tags": [ "FinanceFixedAssetClass" ], "summary": "FinanceFixedAssetClass: GetPageFinanceFixedAssetClassesByParent", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetClass-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetClass_GetPageFinanceFixedAssetClassesByParent_407672261CE8", "parameters": [ { "name": "ParentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "IncludeSubNodes", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "TopParentsOnly", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceFixedAssetClass/SearchByValue": { "post": { "tags": [ "FinanceFixedAssetClass" ], "summary": "FinanceFixedAssetClass: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetClass-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetClass_SearchByValue_29BBFA662B7B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceFixedAssetClass" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceFixedAssetClass" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceFixedAssetClass" } } } } } } }, "/api/FinanceFixedAssetClass/TryGetByValue": { "post": { "tags": [ "FinanceFixedAssetClass" ], "summary": "FinanceFixedAssetClass: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetClass-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetClass_TryGetByValue_D278B248ADF5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetClass" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetClass" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetClass" } } } } } } }, "/api/FinanceFixedAssetClass/UpsertGraph": { "put": { "tags": [ "FinanceFixedAssetClass" ], "summary": "FinanceFixedAssetClass: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetClass-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetClass_UpsertGraph_3143FF5B0EDC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetClass" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetClass" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetClass" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetClass" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetClass" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetClass" } } } } } } }, "/api/FinanceFixedAssetClass/UpsertGraphWithExtraFields": { "put": { "tags": [ "FinanceFixedAssetClass" ], "summary": "FinanceFixedAssetClass: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetClass-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetClass_UpsertGraphWithExtraFields_8867351C69FF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAssetClass" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAssetClass" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAssetClass" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAssetClass" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAssetClass" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAssetClass" } } } } } } }, "/api/FinanceFixedAssetDepreciationCyclePeriod": { "get": { "tags": [ "FinanceFixedAssetDepreciationCyclePeriod" ], "summary": "FinanceFixedAssetDepreciationCyclePeriod: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDepreciationCyclePeriod-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDepreciationCyclePeriod_GetAll_F152EF625DA5", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationCyclePeriod" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationCyclePeriod" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationCyclePeriod" } } } } } }, "post": { "tags": [ "FinanceFixedAssetDepreciationCyclePeriod" ], "summary": "FinanceFixedAssetDepreciationCyclePeriod: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDepreciationCyclePeriod-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDepreciationCyclePeriod_Post_9381C5CE8C1A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDepreciationCyclePeriod" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDepreciationCyclePeriod" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDepreciationCyclePeriod" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationCyclePeriod" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationCyclePeriod" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationCyclePeriod" } } } } } }, "put": { "tags": [ "FinanceFixedAssetDepreciationCyclePeriod" ], "summary": "FinanceFixedAssetDepreciationCyclePeriod: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDepreciationCyclePeriod-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDepreciationCyclePeriod_Put_D8A7200E40A4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDepreciationCyclePeriod" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDepreciationCyclePeriod" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDepreciationCyclePeriod" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationCyclePeriod" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationCyclePeriod" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationCyclePeriod" } } } } } } }, "/api/FinanceFixedAssetDepreciationCyclePeriod/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "FinanceFixedAssetDepreciationCyclePeriod" ], "summary": "FinanceFixedAssetDepreciationCyclePeriod: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDepreciationCyclePeriod-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDepreciationCyclePeriod_GetPageByValue_4FADCE0D61FE", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceFixedAssetDepreciationCyclePeriod/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "FinanceFixedAssetDepreciationCyclePeriod" ], "summary": "FinanceFixedAssetDepreciationCyclePeriod: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDepreciationCyclePeriod-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDepreciationCyclePeriod_GetPageByValue2_B1DA1D247A60", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceFixedAssetDepreciationCyclePeriod/DeleteByFilter": { "post": { "tags": [ "FinanceFixedAssetDepreciationCyclePeriod" ], "summary": "FinanceFixedAssetDepreciationCyclePeriod: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDepreciationCyclePeriod-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDepreciationCyclePeriod_DeleteByFilter_87BF0DD07395", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/FinanceFixedAssetDepreciationCyclePeriod/GetAllByValue": { "post": { "tags": [ "FinanceFixedAssetDepreciationCyclePeriod" ], "summary": "FinanceFixedAssetDepreciationCyclePeriod: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDepreciationCyclePeriod-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDepreciationCyclePeriod_GetAllByValue_E06BC373DD85", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationCyclePeriod" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationCyclePeriod" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationCyclePeriod" } } } } } } }, "/api/FinanceFixedAssetDepreciationCyclePeriod/GetAllGraphByValue": { "post": { "tags": [ "FinanceFixedAssetDepreciationCyclePeriod" ], "summary": "FinanceFixedAssetDepreciationCyclePeriod: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDepreciationCyclePeriod-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDepreciationCyclePeriod_GetAllGraphByValue_B957667A468B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationCyclePeriod" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationCyclePeriod" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationCyclePeriod" } } } } } } }, "/api/FinanceFixedAssetDepreciationCyclePeriod/GetByValue": { "post": { "tags": [ "FinanceFixedAssetDepreciationCyclePeriod" ], "summary": "FinanceFixedAssetDepreciationCyclePeriod: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDepreciationCyclePeriod-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDepreciationCyclePeriod_GetByValue_B87D38CDFEFC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationCyclePeriod" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationCyclePeriod" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationCyclePeriod" } } } } } } }, "/api/FinanceFixedAssetDepreciationCyclePeriod/GetLookup": { "post": { "tags": [ "FinanceFixedAssetDepreciationCyclePeriod" ], "summary": "FinanceFixedAssetDepreciationCyclePeriod: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDepreciationCyclePeriod-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDepreciationCyclePeriod_GetLookup_520E6879A383", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceFixedAssetDepreciationCyclePeriod/GetLookupByValue": { "post": { "tags": [ "FinanceFixedAssetDepreciationCyclePeriod" ], "summary": "FinanceFixedAssetDepreciationCyclePeriod: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDepreciationCyclePeriod-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDepreciationCyclePeriod_GetLookupByValue_5202013D1217", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceFixedAssetDepreciationCyclePeriod/Page": { "get": { "tags": [ "FinanceFixedAssetDepreciationCyclePeriod" ], "summary": "FinanceFixedAssetDepreciationCyclePeriod: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDepreciationCyclePeriod-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDepreciationCyclePeriod_GetPage_7C3732ED5418", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceFixedAssetDepreciationCyclePeriod/PageAsc": { "get": { "tags": [ "FinanceFixedAssetDepreciationCyclePeriod" ], "summary": "FinanceFixedAssetDepreciationCyclePeriod: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDepreciationCyclePeriod-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDepreciationCyclePeriod_GetPageAsc_F4A2DB2E68F0", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceFixedAssetDepreciationCyclePeriod/SearchByValue": { "post": { "tags": [ "FinanceFixedAssetDepreciationCyclePeriod" ], "summary": "FinanceFixedAssetDepreciationCyclePeriod: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDepreciationCyclePeriod-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDepreciationCyclePeriod_SearchByValue_8415E971324A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationCyclePeriod" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationCyclePeriod" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationCyclePeriod" } } } } } } }, "/api/FinanceFixedAssetDepreciationCyclePeriod/TryGetByValue": { "post": { "tags": [ "FinanceFixedAssetDepreciationCyclePeriod" ], "summary": "FinanceFixedAssetDepreciationCyclePeriod: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDepreciationCyclePeriod-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDepreciationCyclePeriod_TryGetByValue_CF384444D8E0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationCyclePeriod" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationCyclePeriod" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationCyclePeriod" } } } } } } }, "/api/FinanceFixedAssetDepreciationCyclePeriod/UpsertGraph": { "put": { "tags": [ "FinanceFixedAssetDepreciationCyclePeriod" ], "summary": "FinanceFixedAssetDepreciationCyclePeriod: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDepreciationCyclePeriod-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDepreciationCyclePeriod_UpsertGraph_CC622F66989E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDepreciationCyclePeriod" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDepreciationCyclePeriod" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDepreciationCyclePeriod" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationCyclePeriod" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationCyclePeriod" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationCyclePeriod" } } } } } } }, "/api/FinanceFixedAssetDepreciationCyclePeriod/UpsertGraphWithExtraFields": { "put": { "tags": [ "FinanceFixedAssetDepreciationCyclePeriod" ], "summary": "FinanceFixedAssetDepreciationCyclePeriod: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDepreciationCyclePeriod-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDepreciationCyclePeriod_UpsertGraphWithExtraFields_529A79677703", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationCyclePeriod" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationCyclePeriod" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationCyclePeriod" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationCyclePeriod" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationCyclePeriod" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationCyclePeriod" } } } } } } }, "/api/FinanceFixedAssetDepreciationMethod": { "get": { "tags": [ "FinanceFixedAssetDepreciationMethod" ], "summary": "FinanceFixedAssetDepreciationMethod: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDepreciationMethod-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDepreciationMethod_GetAll_D6672B8AAD15", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationMethod" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationMethod" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationMethod" } } } } } }, "post": { "tags": [ "FinanceFixedAssetDepreciationMethod" ], "summary": "FinanceFixedAssetDepreciationMethod: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDepreciationMethod-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDepreciationMethod_Post_52417DED8E1F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDepreciationMethod" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDepreciationMethod" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDepreciationMethod" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationMethod" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationMethod" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationMethod" } } } } } }, "put": { "tags": [ "FinanceFixedAssetDepreciationMethod" ], "summary": "FinanceFixedAssetDepreciationMethod: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDepreciationMethod-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDepreciationMethod_Put_F9AA34692BB5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDepreciationMethod" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDepreciationMethod" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDepreciationMethod" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationMethod" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationMethod" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationMethod" } } } } } } }, "/api/FinanceFixedAssetDepreciationMethod/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "FinanceFixedAssetDepreciationMethod" ], "summary": "FinanceFixedAssetDepreciationMethod: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDepreciationMethod-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDepreciationMethod_GetPageByValue_38FF60F5818E", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceFixedAssetDepreciationMethod/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "FinanceFixedAssetDepreciationMethod" ], "summary": "FinanceFixedAssetDepreciationMethod: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDepreciationMethod-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDepreciationMethod_GetPageByValue2_B6EA66DD0B78", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceFixedAssetDepreciationMethod/DeleteByFilter": { "post": { "tags": [ "FinanceFixedAssetDepreciationMethod" ], "summary": "FinanceFixedAssetDepreciationMethod: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDepreciationMethod-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDepreciationMethod_DeleteByFilter_7A328CD75D3D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/FinanceFixedAssetDepreciationMethod/GetAllByValue": { "post": { "tags": [ "FinanceFixedAssetDepreciationMethod" ], "summary": "FinanceFixedAssetDepreciationMethod: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDepreciationMethod-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDepreciationMethod_GetAllByValue_02C8CDBD607C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationMethod" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationMethod" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationMethod" } } } } } } }, "/api/FinanceFixedAssetDepreciationMethod/GetAllGraphByValue": { "post": { "tags": [ "FinanceFixedAssetDepreciationMethod" ], "summary": "FinanceFixedAssetDepreciationMethod: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDepreciationMethod-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDepreciationMethod_GetAllGraphByValue_E5DC047ABB7D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationMethod" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationMethod" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationMethod" } } } } } } }, "/api/FinanceFixedAssetDepreciationMethod/GetByValue": { "post": { "tags": [ "FinanceFixedAssetDepreciationMethod" ], "summary": "FinanceFixedAssetDepreciationMethod: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDepreciationMethod-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDepreciationMethod_GetByValue_5AF267D93A1A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationMethod" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationMethod" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationMethod" } } } } } } }, "/api/FinanceFixedAssetDepreciationMethod/GetLookup": { "post": { "tags": [ "FinanceFixedAssetDepreciationMethod" ], "summary": "FinanceFixedAssetDepreciationMethod: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDepreciationMethod-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDepreciationMethod_GetLookup_B13D35C9D062", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceFixedAssetDepreciationMethod/GetLookupByValue": { "post": { "tags": [ "FinanceFixedAssetDepreciationMethod" ], "summary": "FinanceFixedAssetDepreciationMethod: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDepreciationMethod-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDepreciationMethod_GetLookupByValue_33BD81FF536F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceFixedAssetDepreciationMethod/Page": { "get": { "tags": [ "FinanceFixedAssetDepreciationMethod" ], "summary": "FinanceFixedAssetDepreciationMethod: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDepreciationMethod-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDepreciationMethod_GetPage_4553D45E45B0", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceFixedAssetDepreciationMethod/PageAsc": { "get": { "tags": [ "FinanceFixedAssetDepreciationMethod" ], "summary": "FinanceFixedAssetDepreciationMethod: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDepreciationMethod-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDepreciationMethod_GetPageAsc_CCFD115B6B59", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceFixedAssetDepreciationMethod/SearchByValue": { "post": { "tags": [ "FinanceFixedAssetDepreciationMethod" ], "summary": "FinanceFixedAssetDepreciationMethod: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDepreciationMethod-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDepreciationMethod_SearchByValue_7EAB00A8834F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationMethod" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationMethod" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationMethod" } } } } } } }, "/api/FinanceFixedAssetDepreciationMethod/TryGetByValue": { "post": { "tags": [ "FinanceFixedAssetDepreciationMethod" ], "summary": "FinanceFixedAssetDepreciationMethod: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDepreciationMethod-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDepreciationMethod_TryGetByValue_1DAF95FECB12", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationMethod" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationMethod" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationMethod" } } } } } } }, "/api/FinanceFixedAssetDepreciationMethod/UpsertGraph": { "put": { "tags": [ "FinanceFixedAssetDepreciationMethod" ], "summary": "FinanceFixedAssetDepreciationMethod: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDepreciationMethod-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDepreciationMethod_UpsertGraph_76FB71358846", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDepreciationMethod" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDepreciationMethod" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDepreciationMethod" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationMethod" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationMethod" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationMethod" } } } } } } }, "/api/FinanceFixedAssetDepreciationMethod/UpsertGraphWithExtraFields": { "put": { "tags": [ "FinanceFixedAssetDepreciationMethod" ], "summary": "FinanceFixedAssetDepreciationMethod: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDepreciationMethod-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDepreciationMethod_UpsertGraphWithExtraFields_39045772DAA8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationMethod" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationMethod" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationMethod" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationMethod" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationMethod" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationMethod" } } } } } } }, "/api/FinanceFixedAssetDepreciationPlan": { "get": { "tags": [ "FinanceFixedAssetDepreciationPlan" ], "summary": "FinanceFixedAssetDepreciationPlan: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDepreciationPlan-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDepreciationPlan_GetAll_E8BB7597623C", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationPlan" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationPlan" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationPlan" } } } } } }, "post": { "tags": [ "FinanceFixedAssetDepreciationPlan" ], "summary": "FinanceFixedAssetDepreciationPlan: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDepreciationPlan-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDepreciationPlan_Post_D6E7E2CF7287", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDepreciationPlan" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDepreciationPlan" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDepreciationPlan" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationPlan" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationPlan" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationPlan" } } } } } }, "put": { "tags": [ "FinanceFixedAssetDepreciationPlan" ], "summary": "FinanceFixedAssetDepreciationPlan: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDepreciationPlan-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDepreciationPlan_Put_A504A1599370", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDepreciationPlan" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDepreciationPlan" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDepreciationPlan" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationPlan" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationPlan" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationPlan" } } } } } } }, "/api/FinanceFixedAssetDepreciationPlan/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "FinanceFixedAssetDepreciationPlan" ], "summary": "FinanceFixedAssetDepreciationPlan: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDepreciationPlan-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDepreciationPlan_GetPageByValue_EB668A5AE4C6", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceFixedAssetDepreciationPlan/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "FinanceFixedAssetDepreciationPlan" ], "summary": "FinanceFixedAssetDepreciationPlan: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDepreciationPlan-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDepreciationPlan_GetPageByValue2_35D57C4312EE", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceFixedAssetDepreciationPlan/DeleteByFilter": { "post": { "tags": [ "FinanceFixedAssetDepreciationPlan" ], "summary": "FinanceFixedAssetDepreciationPlan: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDepreciationPlan-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDepreciationPlan_DeleteByFilter_7AEEA5282B56", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/FinanceFixedAssetDepreciationPlan/GetAllByValue": { "post": { "tags": [ "FinanceFixedAssetDepreciationPlan" ], "summary": "FinanceFixedAssetDepreciationPlan: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDepreciationPlan-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDepreciationPlan_GetAllByValue_A4A4FBEABDAA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationPlan" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationPlan" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationPlan" } } } } } } }, "/api/FinanceFixedAssetDepreciationPlan/GetAllGraphByValue": { "post": { "tags": [ "FinanceFixedAssetDepreciationPlan" ], "summary": "FinanceFixedAssetDepreciationPlan: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDepreciationPlan-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDepreciationPlan_GetAllGraphByValue_8E5AADE19559", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationPlan" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationPlan" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationPlan" } } } } } } }, "/api/FinanceFixedAssetDepreciationPlan/GetByValue": { "post": { "tags": [ "FinanceFixedAssetDepreciationPlan" ], "summary": "FinanceFixedAssetDepreciationPlan: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDepreciationPlan-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDepreciationPlan_GetByValue_EF921A496C8C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationPlan" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationPlan" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationPlan" } } } } } } }, "/api/FinanceFixedAssetDepreciationPlan/GetLookup": { "post": { "tags": [ "FinanceFixedAssetDepreciationPlan" ], "summary": "FinanceFixedAssetDepreciationPlan: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDepreciationPlan-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDepreciationPlan_GetLookup_968C9D685861", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceFixedAssetDepreciationPlan/GetLookupByValue": { "post": { "tags": [ "FinanceFixedAssetDepreciationPlan" ], "summary": "FinanceFixedAssetDepreciationPlan: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDepreciationPlan-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDepreciationPlan_GetLookupByValue_AB8F48A2BDBF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceFixedAssetDepreciationPlan/Page": { "get": { "tags": [ "FinanceFixedAssetDepreciationPlan" ], "summary": "FinanceFixedAssetDepreciationPlan: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDepreciationPlan-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDepreciationPlan_GetPage_3A1C4C3C079D", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceFixedAssetDepreciationPlan/PageAsc": { "get": { "tags": [ "FinanceFixedAssetDepreciationPlan" ], "summary": "FinanceFixedAssetDepreciationPlan: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDepreciationPlan-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDepreciationPlan_GetPageAsc_4114FB838350", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceFixedAssetDepreciationPlan/SearchByValue": { "post": { "tags": [ "FinanceFixedAssetDepreciationPlan" ], "summary": "FinanceFixedAssetDepreciationPlan: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDepreciationPlan-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDepreciationPlan_SearchByValue_3C6074AD644E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationPlan" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationPlan" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationPlan" } } } } } } }, "/api/FinanceFixedAssetDepreciationPlan/TryGetByValue": { "post": { "tags": [ "FinanceFixedAssetDepreciationPlan" ], "summary": "FinanceFixedAssetDepreciationPlan: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDepreciationPlan-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDepreciationPlan_TryGetByValue_9F54CD5B1B50", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationPlan" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationPlan" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationPlan" } } } } } } }, "/api/FinanceFixedAssetDepreciationPlan/UpsertGraph": { "put": { "tags": [ "FinanceFixedAssetDepreciationPlan" ], "summary": "FinanceFixedAssetDepreciationPlan: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDepreciationPlan-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDepreciationPlan_UpsertGraph_0B5C4E3D145B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDepreciationPlan" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDepreciationPlan" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDepreciationPlan" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationPlan" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationPlan" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationPlan" } } } } } } }, "/api/FinanceFixedAssetDepreciationPlan/UpsertGraphWithExtraFields": { "put": { "tags": [ "FinanceFixedAssetDepreciationPlan" ], "summary": "FinanceFixedAssetDepreciationPlan: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDepreciationPlan-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDepreciationPlan_UpsertGraphWithExtraFields_C13578D8022A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationPlan" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationPlan" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationPlan" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationPlan" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationPlan" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationPlan" } } } } } } }, "/api/FinanceFixedAssetDepreciationType": { "get": { "tags": [ "FinanceFixedAssetDepreciationType" ], "summary": "FinanceFixedAssetDepreciationType: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDepreciationType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDepreciationType_GetAll_D0C922C4CD35", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationType" } } } } } }, "post": { "tags": [ "FinanceFixedAssetDepreciationType" ], "summary": "FinanceFixedAssetDepreciationType: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDepreciationType-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDepreciationType_Post_6DC16AE1E1F6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDepreciationType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDepreciationType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDepreciationType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationType" } } } } } }, "put": { "tags": [ "FinanceFixedAssetDepreciationType" ], "summary": "FinanceFixedAssetDepreciationType: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDepreciationType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDepreciationType_Put_D0F1EE29C6F7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDepreciationType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDepreciationType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDepreciationType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationType" } } } } } } }, "/api/FinanceFixedAssetDepreciationType/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "FinanceFixedAssetDepreciationType" ], "summary": "FinanceFixedAssetDepreciationType: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDepreciationType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDepreciationType_GetPageByValue_69875A5A449E", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceFixedAssetDepreciationType/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "FinanceFixedAssetDepreciationType" ], "summary": "FinanceFixedAssetDepreciationType: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDepreciationType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDepreciationType_GetPageByValue2_D506BF5460E2", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceFixedAssetDepreciationType/DeleteByFilter": { "post": { "tags": [ "FinanceFixedAssetDepreciationType" ], "summary": "FinanceFixedAssetDepreciationType: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDepreciationType-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDepreciationType_DeleteByFilter_F4AC5785EDAF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/FinanceFixedAssetDepreciationType/GetAllByValue": { "post": { "tags": [ "FinanceFixedAssetDepreciationType" ], "summary": "FinanceFixedAssetDepreciationType: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDepreciationType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDepreciationType_GetAllByValue_F553A8AECF4E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationType" } } } } } } }, "/api/FinanceFixedAssetDepreciationType/GetAllGraphByValue": { "post": { "tags": [ "FinanceFixedAssetDepreciationType" ], "summary": "FinanceFixedAssetDepreciationType: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDepreciationType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDepreciationType_GetAllGraphByValue_A9A5942D9385", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationType" } } } } } } }, "/api/FinanceFixedAssetDepreciationType/GetByValue": { "post": { "tags": [ "FinanceFixedAssetDepreciationType" ], "summary": "FinanceFixedAssetDepreciationType: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDepreciationType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDepreciationType_GetByValue_A5AA78BEEBCE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationType" } } } } } } }, "/api/FinanceFixedAssetDepreciationType/GetLookup": { "post": { "tags": [ "FinanceFixedAssetDepreciationType" ], "summary": "FinanceFixedAssetDepreciationType: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDepreciationType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDepreciationType_GetLookup_8705624057F7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceFixedAssetDepreciationType/GetLookupByValue": { "post": { "tags": [ "FinanceFixedAssetDepreciationType" ], "summary": "FinanceFixedAssetDepreciationType: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDepreciationType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDepreciationType_GetLookupByValue_068C99B0D9E1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceFixedAssetDepreciationType/Page": { "get": { "tags": [ "FinanceFixedAssetDepreciationType" ], "summary": "FinanceFixedAssetDepreciationType: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDepreciationType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDepreciationType_GetPage_8B2B489703BC", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceFixedAssetDepreciationType/PageAsc": { "get": { "tags": [ "FinanceFixedAssetDepreciationType" ], "summary": "FinanceFixedAssetDepreciationType: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDepreciationType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDepreciationType_GetPageAsc_AE22F3097FB9", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceFixedAssetDepreciationType/SearchByValue": { "post": { "tags": [ "FinanceFixedAssetDepreciationType" ], "summary": "FinanceFixedAssetDepreciationType: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDepreciationType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDepreciationType_SearchByValue_BB12D5ED6625", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationType" } } } } } } }, "/api/FinanceFixedAssetDepreciationType/TryGetByValue": { "post": { "tags": [ "FinanceFixedAssetDepreciationType" ], "summary": "FinanceFixedAssetDepreciationType: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDepreciationType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDepreciationType_TryGetByValue_7B62C2FC96F7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationType" } } } } } } }, "/api/FinanceFixedAssetDepreciationType/UpsertGraph": { "put": { "tags": [ "FinanceFixedAssetDepreciationType" ], "summary": "FinanceFixedAssetDepreciationType: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDepreciationType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDepreciationType_UpsertGraph_A5C4B33476F2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDepreciationType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDepreciationType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDepreciationType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationType" } } } } } } }, "/api/FinanceFixedAssetDepreciationType/UpsertGraphWithExtraFields": { "put": { "tags": [ "FinanceFixedAssetDepreciationType" ], "summary": "FinanceFixedAssetDepreciationType: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDepreciationType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDepreciationType_UpsertGraphWithExtraFields_651C6E8D3CB1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationType" } } } } } } }, "/api/FinanceFixedAssetDepreciationTypeDetail": { "get": { "tags": [ "FinanceFixedAssetDepreciationTypeDetail" ], "summary": "FinanceFixedAssetDepreciationTypeDetail: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDepreciationTypeDetail-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDepreciationTypeDetail_GetAll_1292FE6FF265", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationTypeDetail" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationTypeDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationTypeDetail" } } } } } }, "post": { "tags": [ "FinanceFixedAssetDepreciationTypeDetail" ], "summary": "FinanceFixedAssetDepreciationTypeDetail: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDepreciationTypeDetail-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDepreciationTypeDetail_Post_3397F8C6D816", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDepreciationTypeDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDepreciationTypeDetail" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDepreciationTypeDetail" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationTypeDetail" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationTypeDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationTypeDetail" } } } } } }, "put": { "tags": [ "FinanceFixedAssetDepreciationTypeDetail" ], "summary": "FinanceFixedAssetDepreciationTypeDetail: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDepreciationTypeDetail-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDepreciationTypeDetail_Put_A53FA5C60CF9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDepreciationTypeDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDepreciationTypeDetail" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDepreciationTypeDetail" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationTypeDetail" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationTypeDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationTypeDetail" } } } } } } }, "/api/FinanceFixedAssetDepreciationTypeDetail/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "FinanceFixedAssetDepreciationTypeDetail" ], "summary": "FinanceFixedAssetDepreciationTypeDetail: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDepreciationTypeDetail-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDepreciationTypeDetail_GetPageByValue_949654CE3D27", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceFixedAssetDepreciationTypeDetail/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "FinanceFixedAssetDepreciationTypeDetail" ], "summary": "FinanceFixedAssetDepreciationTypeDetail: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDepreciationTypeDetail-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDepreciationTypeDetail_GetPageByValue2_5C32B129B861", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceFixedAssetDepreciationTypeDetail/DeleteByFilter": { "post": { "tags": [ "FinanceFixedAssetDepreciationTypeDetail" ], "summary": "FinanceFixedAssetDepreciationTypeDetail: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDepreciationTypeDetail-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDepreciationTypeDetail_DeleteByFilter_523348EBF8AE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/FinanceFixedAssetDepreciationTypeDetail/GetAllByValue": { "post": { "tags": [ "FinanceFixedAssetDepreciationTypeDetail" ], "summary": "FinanceFixedAssetDepreciationTypeDetail: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDepreciationTypeDetail-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDepreciationTypeDetail_GetAllByValue_5B5B4962B3AE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationTypeDetail" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationTypeDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationTypeDetail" } } } } } } }, "/api/FinanceFixedAssetDepreciationTypeDetail/GetAllGraphByValue": { "post": { "tags": [ "FinanceFixedAssetDepreciationTypeDetail" ], "summary": "FinanceFixedAssetDepreciationTypeDetail: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDepreciationTypeDetail-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDepreciationTypeDetail_GetAllGraphByValue_1E7CBF55F918", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationTypeDetail" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationTypeDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationTypeDetail" } } } } } } }, "/api/FinanceFixedAssetDepreciationTypeDetail/GetByValue": { "post": { "tags": [ "FinanceFixedAssetDepreciationTypeDetail" ], "summary": "FinanceFixedAssetDepreciationTypeDetail: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDepreciationTypeDetail-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDepreciationTypeDetail_GetByValue_675B91863541", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationTypeDetail" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationTypeDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationTypeDetail" } } } } } } }, "/api/FinanceFixedAssetDepreciationTypeDetail/GetLookup": { "post": { "tags": [ "FinanceFixedAssetDepreciationTypeDetail" ], "summary": "FinanceFixedAssetDepreciationTypeDetail: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDepreciationTypeDetail-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDepreciationTypeDetail_GetLookup_F0A99F84EF2B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceFixedAssetDepreciationTypeDetail/GetLookupByValue": { "post": { "tags": [ "FinanceFixedAssetDepreciationTypeDetail" ], "summary": "FinanceFixedAssetDepreciationTypeDetail: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDepreciationTypeDetail-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDepreciationTypeDetail_GetLookupByValue_21EA5D9BB42A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceFixedAssetDepreciationTypeDetail/Page": { "get": { "tags": [ "FinanceFixedAssetDepreciationTypeDetail" ], "summary": "FinanceFixedAssetDepreciationTypeDetail: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDepreciationTypeDetail-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDepreciationTypeDetail_GetPage_55ED66F6344B", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceFixedAssetDepreciationTypeDetail/PageAsc": { "get": { "tags": [ "FinanceFixedAssetDepreciationTypeDetail" ], "summary": "FinanceFixedAssetDepreciationTypeDetail: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDepreciationTypeDetail-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDepreciationTypeDetail_GetPageAsc_C0BA244DBE87", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceFixedAssetDepreciationTypeDetail/SearchByValue": { "post": { "tags": [ "FinanceFixedAssetDepreciationTypeDetail" ], "summary": "FinanceFixedAssetDepreciationTypeDetail: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDepreciationTypeDetail-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDepreciationTypeDetail_SearchByValue_D4C965C8DA73", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationTypeDetail" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationTypeDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationTypeDetail" } } } } } } }, "/api/FinanceFixedAssetDepreciationTypeDetail/TryGetByValue": { "post": { "tags": [ "FinanceFixedAssetDepreciationTypeDetail" ], "summary": "FinanceFixedAssetDepreciationTypeDetail: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDepreciationTypeDetail-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDepreciationTypeDetail_TryGetByValue_954B7B2E5A85", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationTypeDetail" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationTypeDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationTypeDetail" } } } } } } }, "/api/FinanceFixedAssetDepreciationTypeDetail/UpsertGraph": { "put": { "tags": [ "FinanceFixedAssetDepreciationTypeDetail" ], "summary": "FinanceFixedAssetDepreciationTypeDetail: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDepreciationTypeDetail-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDepreciationTypeDetail_UpsertGraph_61D5FB6146A8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDepreciationTypeDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDepreciationTypeDetail" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDepreciationTypeDetail" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationTypeDetail" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationTypeDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationTypeDetail" } } } } } } }, "/api/FinanceFixedAssetDepreciationTypeDetail/UpsertGraphWithExtraFields": { "put": { "tags": [ "FinanceFixedAssetDepreciationTypeDetail" ], "summary": "FinanceFixedAssetDepreciationTypeDetail: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDepreciationTypeDetail-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDepreciationTypeDetail_UpsertGraphWithExtraFields_3A9E3AFDC31B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationTypeDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationTypeDetail" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationTypeDetail" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationTypeDetail" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationTypeDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationTypeDetail" } } } } } } }, "/api/FinanceFixedAssetDetail": { "get": { "tags": [ "FinanceFixedAssetDetail" ], "summary": "FinanceFixedAssetDetail: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDetail-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDetail_GetAll_EDAC1BDF01C0", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetDetail" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetDetail" } } } } } }, "post": { "tags": [ "FinanceFixedAssetDetail" ], "summary": "FinanceFixedAssetDetail: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDetail-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDetail_Post_441C9165B665", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDetail" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDetail" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDetail" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDetail" } } } } } }, "put": { "tags": [ "FinanceFixedAssetDetail" ], "summary": "FinanceFixedAssetDetail: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDetail-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDetail_Put_39CF4112D187", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDetail" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDetail" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDetail" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDetail" } } } } } } }, "/api/FinanceFixedAssetDetail/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "FinanceFixedAssetDetail" ], "summary": "FinanceFixedAssetDetail: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDetail-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDetail_GetPageByValue_7108CA5B99A6", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceFixedAssetDetail/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "FinanceFixedAssetDetail" ], "summary": "FinanceFixedAssetDetail: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDetail-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDetail_GetPageByValue2_168661B013BA", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceFixedAssetDetail/DeleteByFilter": { "post": { "tags": [ "FinanceFixedAssetDetail" ], "summary": "FinanceFixedAssetDetail: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDetail-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDetail_DeleteByFilter_282A035CC4DB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/FinanceFixedAssetDetail/GetAllByValue": { "post": { "tags": [ "FinanceFixedAssetDetail" ], "summary": "FinanceFixedAssetDetail: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDetail-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDetail_GetAllByValue_7BA9397E7D18", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetDetail" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetDetail" } } } } } } }, "/api/FinanceFixedAssetDetail/GetAllGraphByValue": { "post": { "tags": [ "FinanceFixedAssetDetail" ], "summary": "FinanceFixedAssetDetail: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDetail-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDetail_GetAllGraphByValue_136740804B00", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetDetail" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetDetail" } } } } } } }, "/api/FinanceFixedAssetDetail/GetByValue": { "post": { "tags": [ "FinanceFixedAssetDetail" ], "summary": "FinanceFixedAssetDetail: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDetail-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDetail_GetByValue_0DC1D59526CD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDetail" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDetail" } } } } } } }, "/api/FinanceFixedAssetDetail/GetLookup": { "post": { "tags": [ "FinanceFixedAssetDetail" ], "summary": "FinanceFixedAssetDetail: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDetail-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDetail_GetLookup_F643136CC22A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceFixedAssetDetail/GetLookupByValue": { "post": { "tags": [ "FinanceFixedAssetDetail" ], "summary": "FinanceFixedAssetDetail: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDetail-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDetail_GetLookupByValue_8C78461032F6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceFixedAssetDetail/Page": { "get": { "tags": [ "FinanceFixedAssetDetail" ], "summary": "FinanceFixedAssetDetail: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDetail-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDetail_GetPage_DB1A240A2A12", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceFixedAssetDetail/PageAsc": { "get": { "tags": [ "FinanceFixedAssetDetail" ], "summary": "FinanceFixedAssetDetail: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDetail-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDetail_GetPageAsc_7D5D9A5688D1", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceFixedAssetDetail/SearchByValue": { "post": { "tags": [ "FinanceFixedAssetDetail" ], "summary": "FinanceFixedAssetDetail: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDetail-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDetail_SearchByValue_B8EB7B5A0377", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceFixedAssetDetail" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceFixedAssetDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceFixedAssetDetail" } } } } } } }, "/api/FinanceFixedAssetDetail/TryGetByValue": { "post": { "tags": [ "FinanceFixedAssetDetail" ], "summary": "FinanceFixedAssetDetail: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDetail-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDetail_TryGetByValue_0C5F4BF73211", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDetail" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDetail" } } } } } } }, "/api/FinanceFixedAssetDetail/UpsertGraph": { "put": { "tags": [ "FinanceFixedAssetDetail" ], "summary": "FinanceFixedAssetDetail: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDetail-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDetail_UpsertGraph_5FD6AA054F03", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDetail" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDetail" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDetail" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDetail" } } } } } } }, "/api/FinanceFixedAssetDetail/UpsertGraphWithExtraFields": { "put": { "tags": [ "FinanceFixedAssetDetail" ], "summary": "FinanceFixedAssetDetail: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetDetail-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetDetail_UpsertGraphWithExtraFields_BB3CF1A8EE9C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAssetDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAssetDetail" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAssetDetail" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAssetDetail" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAssetDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAssetDetail" } } } } } } }, "/api/FinanceFixedAssetGroup": { "get": { "tags": [ "FinanceFixedAssetGroup" ], "summary": "FinanceFixedAssetGroup: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetGroup_GetAll_FBE83C6EB2BB", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetGroup" } } } } } }, "post": { "tags": [ "FinanceFixedAssetGroup" ], "summary": "FinanceFixedAssetGroup: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetGroup-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetGroup_Post_8EEE295B572E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetGroup" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetGroup" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetGroup" } } } } } }, "put": { "tags": [ "FinanceFixedAssetGroup" ], "summary": "FinanceFixedAssetGroup: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetGroup-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetGroup_Put_88CDA5A05F25", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetGroup" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetGroup" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetGroup" } } } } } } }, "/api/FinanceFixedAssetGroup/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "FinanceFixedAssetGroup" ], "summary": "FinanceFixedAssetGroup: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetGroup_GetPageByValue_6F4993315F8F", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceFixedAssetGroup/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "FinanceFixedAssetGroup" ], "summary": "FinanceFixedAssetGroup: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetGroup_GetPageByValue2_F0A203579FFD", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceFixedAssetGroup/DeleteByFilter": { "post": { "tags": [ "FinanceFixedAssetGroup" ], "summary": "FinanceFixedAssetGroup: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetGroup-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetGroup_DeleteByFilter_7F0841D2B558", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/FinanceFixedAssetGroup/GetAllByValue": { "post": { "tags": [ "FinanceFixedAssetGroup" ], "summary": "FinanceFixedAssetGroup: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetGroup_GetAllByValue_A8891D9E21D0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetGroup" } } } } } } }, "/api/FinanceFixedAssetGroup/GetAllGraphByValue": { "post": { "tags": [ "FinanceFixedAssetGroup" ], "summary": "FinanceFixedAssetGroup: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetGroup_GetAllGraphByValue_54CF027696D0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetGroup" } } } } } } }, "/api/FinanceFixedAssetGroup/GetByValue": { "post": { "tags": [ "FinanceFixedAssetGroup" ], "summary": "FinanceFixedAssetGroup: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetGroup_GetByValue_5E2BAA4CB1A0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetGroup" } } } } } } }, "/api/FinanceFixedAssetGroup/GetLookup": { "post": { "tags": [ "FinanceFixedAssetGroup" ], "summary": "FinanceFixedAssetGroup: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetGroup_GetLookup_B3F734E2A931", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceFixedAssetGroup/GetLookupByValue": { "post": { "tags": [ "FinanceFixedAssetGroup" ], "summary": "FinanceFixedAssetGroup: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetGroup_GetLookupByValue_8538BC900A9B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceFixedAssetGroup/Page": { "get": { "tags": [ "FinanceFixedAssetGroup" ], "summary": "FinanceFixedAssetGroup: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetGroup_GetPage_6645202132E9", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceFixedAssetGroup/PageAsc": { "get": { "tags": [ "FinanceFixedAssetGroup" ], "summary": "FinanceFixedAssetGroup: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetGroup_GetPageAsc_8F09CE4B11D8", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceFixedAssetGroup/PageFinanceFixedAssetGroupsByParent/{ParentId}/{IncludeSubNodes}/{TopParentsOnly}": { "get": { "tags": [ "FinanceFixedAssetGroup" ], "summary": "FinanceFixedAssetGroup: GetPageFinanceFixedAssetGroupsByParent", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetGroup-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetGroup_GetPageFinanceFixedAssetGroupsByParent_CA9E5B672CD9", "parameters": [ { "name": "ParentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "IncludeSubNodes", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "TopParentsOnly", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceFixedAssetGroup/SearchByValue": { "post": { "tags": [ "FinanceFixedAssetGroup" ], "summary": "FinanceFixedAssetGroup: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetGroup_SearchByValue_66BE29AE48BE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceFixedAssetGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceFixedAssetGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceFixedAssetGroup" } } } } } } }, "/api/FinanceFixedAssetGroup/TryGetByValue": { "post": { "tags": [ "FinanceFixedAssetGroup" ], "summary": "FinanceFixedAssetGroup: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetGroup_TryGetByValue_3A225A2DA4EE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetGroup" } } } } } } }, "/api/FinanceFixedAssetGroup/UpsertGraph": { "put": { "tags": [ "FinanceFixedAssetGroup" ], "summary": "FinanceFixedAssetGroup: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetGroup-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetGroup_UpsertGraph_9FCDDE86C459", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetGroup" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetGroup" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetGroup" } } } } } } }, "/api/FinanceFixedAssetGroup/UpsertGraphWithExtraFields": { "put": { "tags": [ "FinanceFixedAssetGroup" ], "summary": "FinanceFixedAssetGroup: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetGroup-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetGroup_UpsertGraphWithExtraFields_EF1506E0F3D7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAssetGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAssetGroup" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAssetGroup" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAssetGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAssetGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAssetGroup" } } } } } } }, "/api/FinanceFixedAssetStatus": { "get": { "tags": [ "FinanceFixedAssetStatus" ], "summary": "FinanceFixedAssetStatus: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetStatus_GetAll_60486BFE3865", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetStatus" } } } } } }, "post": { "tags": [ "FinanceFixedAssetStatus" ], "summary": "FinanceFixedAssetStatus: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetStatus-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetStatus_Post_45A779606779", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetStatus" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetStatus" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetStatus" } } } } } }, "put": { "tags": [ "FinanceFixedAssetStatus" ], "summary": "FinanceFixedAssetStatus: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetStatus-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetStatus_Put_A4549DFC2BAD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetStatus" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetStatus" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetStatus" } } } } } } }, "/api/FinanceFixedAssetStatus/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "FinanceFixedAssetStatus" ], "summary": "FinanceFixedAssetStatus: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetStatus_GetPageByValue_55CDBAE4969C", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceFixedAssetStatus/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "FinanceFixedAssetStatus" ], "summary": "FinanceFixedAssetStatus: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetStatus_GetPageByValue2_823056092BD4", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceFixedAssetStatus/DeleteByFilter": { "post": { "tags": [ "FinanceFixedAssetStatus" ], "summary": "FinanceFixedAssetStatus: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetStatus-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetStatus_DeleteByFilter_CB8F1A5D8C12", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/FinanceFixedAssetStatus/GetAllByValue": { "post": { "tags": [ "FinanceFixedAssetStatus" ], "summary": "FinanceFixedAssetStatus: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetStatus_GetAllByValue_B04682A5D29E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetStatus" } } } } } } }, "/api/FinanceFixedAssetStatus/GetAllGraphByValue": { "post": { "tags": [ "FinanceFixedAssetStatus" ], "summary": "FinanceFixedAssetStatus: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetStatus_GetAllGraphByValue_11D0935EA4A8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetStatus" } } } } } } }, "/api/FinanceFixedAssetStatus/GetByValue": { "post": { "tags": [ "FinanceFixedAssetStatus" ], "summary": "FinanceFixedAssetStatus: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetStatus_GetByValue_0E44B94BC2A1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetStatus" } } } } } } }, "/api/FinanceFixedAssetStatus/GetLookup": { "post": { "tags": [ "FinanceFixedAssetStatus" ], "summary": "FinanceFixedAssetStatus: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetStatus_GetLookup_844FB9FC34A3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceFixedAssetStatus/GetLookupByValue": { "post": { "tags": [ "FinanceFixedAssetStatus" ], "summary": "FinanceFixedAssetStatus: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetStatus_GetLookupByValue_DC4B30BF1193", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceFixedAssetStatus/Page": { "get": { "tags": [ "FinanceFixedAssetStatus" ], "summary": "FinanceFixedAssetStatus: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetStatus_GetPage_966CB811CC5F", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceFixedAssetStatus/PageAsc": { "get": { "tags": [ "FinanceFixedAssetStatus" ], "summary": "FinanceFixedAssetStatus: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetStatus_GetPageAsc_18EE4D93FFA1", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceFixedAssetStatus/SearchByValue": { "post": { "tags": [ "FinanceFixedAssetStatus" ], "summary": "FinanceFixedAssetStatus: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetStatus_SearchByValue_1DDBA3033064", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceFixedAssetStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceFixedAssetStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceFixedAssetStatus" } } } } } } }, "/api/FinanceFixedAssetStatus/TryGetByValue": { "post": { "tags": [ "FinanceFixedAssetStatus" ], "summary": "FinanceFixedAssetStatus: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetStatus_TryGetByValue_13DD5528FF0B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetStatus" } } } } } } }, "/api/FinanceFixedAssetStatus/UpsertGraph": { "put": { "tags": [ "FinanceFixedAssetStatus" ], "summary": "FinanceFixedAssetStatus: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetStatus-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetStatus_UpsertGraph_80B455E2749C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetStatus" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetStatus" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetStatus" } } } } } } }, "/api/FinanceFixedAssetStatus/UpsertGraphWithExtraFields": { "put": { "tags": [ "FinanceFixedAssetStatus" ], "summary": "FinanceFixedAssetStatus: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceFixedAssetStatus-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceFixedAssetStatus_UpsertGraphWithExtraFields_A288D347CC2F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAssetStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAssetStatus" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAssetStatus" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAssetStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAssetStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAssetStatus" } } } } } } }, "/api/FinanceGroupArticle": { "get": { "tags": [ "FinanceGroupArticle" ], "summary": "FinanceGroupArticle: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceGroupArticle-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceGroupArticle_GetAll_794E108D4C2C", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceGroupArticle" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceGroupArticle" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceGroupArticle" } } } } } }, "post": { "tags": [ "FinanceGroupArticle" ], "summary": "FinanceGroupArticle: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceGroupArticle-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceGroupArticle_Post_8B344309C5EA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceGroupArticle" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceGroupArticle" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceGroupArticle" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceGroupArticle" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceGroupArticle" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceGroupArticle" } } } } } }, "put": { "tags": [ "FinanceGroupArticle" ], "summary": "FinanceGroupArticle: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceGroupArticle-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceGroupArticle_Put_890D0E60D481", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceGroupArticle" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceGroupArticle" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceGroupArticle" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceGroupArticle" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceGroupArticle" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceGroupArticle" } } } } } } }, "/api/FinanceGroupArticle/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "FinanceGroupArticle" ], "summary": "FinanceGroupArticle: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceGroupArticle-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceGroupArticle_GetPageByValue_CD5127F038D3", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceGroupArticle/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "FinanceGroupArticle" ], "summary": "FinanceGroupArticle: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceGroupArticle-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceGroupArticle_GetPageByValue2_E1B8B9442E9B", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceGroupArticle/DeleteByFilter": { "post": { "tags": [ "FinanceGroupArticle" ], "summary": "FinanceGroupArticle: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceGroupArticle-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceGroupArticle_DeleteByFilter_B4AEF84BEC09", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/FinanceGroupArticle/GetAllByValue": { "post": { "tags": [ "FinanceGroupArticle" ], "summary": "FinanceGroupArticle: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceGroupArticle-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceGroupArticle_GetAllByValue_21585DA4F279", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceGroupArticle" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceGroupArticle" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceGroupArticle" } } } } } } }, "/api/FinanceGroupArticle/GetAllGraphByValue": { "post": { "tags": [ "FinanceGroupArticle" ], "summary": "FinanceGroupArticle: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceGroupArticle-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceGroupArticle_GetAllGraphByValue_7E639E5E7A83", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceGroupArticle" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceGroupArticle" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceGroupArticle" } } } } } } }, "/api/FinanceGroupArticle/GetByValue": { "post": { "tags": [ "FinanceGroupArticle" ], "summary": "FinanceGroupArticle: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceGroupArticle-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceGroupArticle_GetByValue_4825271E3597", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceGroupArticle" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceGroupArticle" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceGroupArticle" } } } } } } }, "/api/FinanceGroupArticle/GetLookup": { "post": { "tags": [ "FinanceGroupArticle" ], "summary": "FinanceGroupArticle: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceGroupArticle-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceGroupArticle_GetLookup_64AE49739B97", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceGroupArticle/GetLookupByValue": { "post": { "tags": [ "FinanceGroupArticle" ], "summary": "FinanceGroupArticle: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceGroupArticle-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceGroupArticle_GetLookupByValue_CB3F79D54001", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceGroupArticle/Page": { "get": { "tags": [ "FinanceGroupArticle" ], "summary": "FinanceGroupArticle: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceGroupArticle-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceGroupArticle_GetPage_7242F4FB997D", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceGroupArticle/PageAsc": { "get": { "tags": [ "FinanceGroupArticle" ], "summary": "FinanceGroupArticle: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceGroupArticle-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceGroupArticle_GetPageAsc_DF7882E6A374", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceGroupArticle/SearchByValue": { "post": { "tags": [ "FinanceGroupArticle" ], "summary": "FinanceGroupArticle: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceGroupArticle-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceGroupArticle_SearchByValue_5D1A7609687A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceGroupArticle" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceGroupArticle" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceGroupArticle" } } } } } } }, "/api/FinanceGroupArticle/TryGetByValue": { "post": { "tags": [ "FinanceGroupArticle" ], "summary": "FinanceGroupArticle: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceGroupArticle-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceGroupArticle_TryGetByValue_86E930271B7D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceGroupArticle" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceGroupArticle" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceGroupArticle" } } } } } } }, "/api/FinanceGroupArticle/UpsertGraph": { "put": { "tags": [ "FinanceGroupArticle" ], "summary": "FinanceGroupArticle: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceGroupArticle-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceGroupArticle_UpsertGraph_5FE37DC2EFD5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceGroupArticle" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceGroupArticle" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceGroupArticle" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceGroupArticle" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceGroupArticle" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceGroupArticle" } } } } } } }, "/api/FinanceGroupArticle/UpsertGraphWithExtraFields": { "put": { "tags": [ "FinanceGroupArticle" ], "summary": "FinanceGroupArticle: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceGroupArticle-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceGroupArticle_UpsertGraphWithExtraFields_B58FFDCE425F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceGroupArticle" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceGroupArticle" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceGroupArticle" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceGroupArticle" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceGroupArticle" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceGroupArticle" } } } } } } }, "/api/FinanceGroupArticleDetail": { "get": { "tags": [ "FinanceGroupArticleDetail" ], "summary": "FinanceGroupArticleDetail: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceGroupArticleDetail-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceGroupArticleDetail_GetAll_959A6F3F0B35", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceGroupArticleDetail" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceGroupArticleDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceGroupArticleDetail" } } } } } }, "post": { "tags": [ "FinanceGroupArticleDetail" ], "summary": "FinanceGroupArticleDetail: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceGroupArticleDetail-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceGroupArticleDetail_Post_326B47932916", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceGroupArticleDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceGroupArticleDetail" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceGroupArticleDetail" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceGroupArticleDetail" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceGroupArticleDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceGroupArticleDetail" } } } } } }, "put": { "tags": [ "FinanceGroupArticleDetail" ], "summary": "FinanceGroupArticleDetail: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceGroupArticleDetail-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceGroupArticleDetail_Put_96953C3C7CF9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceGroupArticleDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceGroupArticleDetail" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceGroupArticleDetail" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceGroupArticleDetail" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceGroupArticleDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceGroupArticleDetail" } } } } } } }, "/api/FinanceGroupArticleDetail/{FinanceGroupArticleId}/PageFromViewByFinanceGroupArticleId": { "get": { "tags": [ "FinanceGroupArticleDetail" ], "summary": "FinanceGroupArticleDetail: GetPageFromViewByArticleId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceGroupArticleDetail-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceGroupArticleDetail_GetPageFromViewByArticleId_3F66774D3AF4", "parameters": [ { "name": "FinanceGroupArticleId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceGroupArticleDetail/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "FinanceGroupArticleDetail" ], "summary": "FinanceGroupArticleDetail: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceGroupArticleDetail-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceGroupArticleDetail_GetPageByValue_FAF71CB86994", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceGroupArticleDetail/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "FinanceGroupArticleDetail" ], "summary": "FinanceGroupArticleDetail: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceGroupArticleDetail-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceGroupArticleDetail_GetPageByValue2_D13D9C08E5B9", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceGroupArticleDetail/DeleteByFilter": { "post": { "tags": [ "FinanceGroupArticleDetail" ], "summary": "FinanceGroupArticleDetail: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceGroupArticleDetail-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceGroupArticleDetail_DeleteByFilter_D9372E2D971B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/FinanceGroupArticleDetail/GetAllByValue": { "post": { "tags": [ "FinanceGroupArticleDetail" ], "summary": "FinanceGroupArticleDetail: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceGroupArticleDetail-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceGroupArticleDetail_GetAllByValue_C9AA9C00FDF4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceGroupArticleDetail" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceGroupArticleDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceGroupArticleDetail" } } } } } } }, "/api/FinanceGroupArticleDetail/GetAllGraphByValue": { "post": { "tags": [ "FinanceGroupArticleDetail" ], "summary": "FinanceGroupArticleDetail: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceGroupArticleDetail-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceGroupArticleDetail_GetAllGraphByValue_3BEC012DF7D6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceGroupArticleDetail" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceGroupArticleDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceGroupArticleDetail" } } } } } } }, "/api/FinanceGroupArticleDetail/GetByValue": { "post": { "tags": [ "FinanceGroupArticleDetail" ], "summary": "FinanceGroupArticleDetail: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceGroupArticleDetail-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceGroupArticleDetail_GetByValue_6E988AFF7E90", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceGroupArticleDetail" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceGroupArticleDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceGroupArticleDetail" } } } } } } }, "/api/FinanceGroupArticleDetail/GetLookup": { "post": { "tags": [ "FinanceGroupArticleDetail" ], "summary": "FinanceGroupArticleDetail: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceGroupArticleDetail-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceGroupArticleDetail_GetLookup_D0BB917D2702", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceGroupArticleDetail/GetLookupByValue": { "post": { "tags": [ "FinanceGroupArticleDetail" ], "summary": "FinanceGroupArticleDetail: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceGroupArticleDetail-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceGroupArticleDetail_GetLookupByValue_B106DCB92956", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceGroupArticleDetail/Page": { "get": { "tags": [ "FinanceGroupArticleDetail" ], "summary": "FinanceGroupArticleDetail: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceGroupArticleDetail-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceGroupArticleDetail_GetPage_92C1DC2A2C5A", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceGroupArticleDetail/PageAsc": { "get": { "tags": [ "FinanceGroupArticleDetail" ], "summary": "FinanceGroupArticleDetail: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceGroupArticleDetail-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceGroupArticleDetail_GetPageAsc_92D101369ED0", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceGroupArticleDetail/SearchByValue": { "post": { "tags": [ "FinanceGroupArticleDetail" ], "summary": "FinanceGroupArticleDetail: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceGroupArticleDetail-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceGroupArticleDetail_SearchByValue_27EDAFE81CE3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceGroupArticleDetail" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceGroupArticleDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceGroupArticleDetail" } } } } } } }, "/api/FinanceGroupArticleDetail/TryGetByValue": { "post": { "tags": [ "FinanceGroupArticleDetail" ], "summary": "FinanceGroupArticleDetail: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceGroupArticleDetail-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceGroupArticleDetail_TryGetByValue_EA9A836F04C9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceGroupArticleDetail" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceGroupArticleDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceGroupArticleDetail" } } } } } } }, "/api/FinanceGroupArticleDetail/UpsertGraph": { "put": { "tags": [ "FinanceGroupArticleDetail" ], "summary": "FinanceGroupArticleDetail: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceGroupArticleDetail-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceGroupArticleDetail_UpsertGraph_0E8BD5C922C6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceGroupArticleDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceGroupArticleDetail" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceGroupArticleDetail" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceGroupArticleDetail" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceGroupArticleDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceGroupArticleDetail" } } } } } } }, "/api/FinanceGroupArticleDetail/UpsertGraphWithExtraFields": { "put": { "tags": [ "FinanceGroupArticleDetail" ], "summary": "FinanceGroupArticleDetail: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceGroupArticleDetail-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceGroupArticleDetail_UpsertGraphWithExtraFields_718844BE84FF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceGroupArticleDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceGroupArticleDetail" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceGroupArticleDetail" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceGroupArticleDetail" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceGroupArticleDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceGroupArticleDetail" } } } } } } }, "/api/FinanceGroupPartner": { "get": { "tags": [ "FinanceGroupPartner" ], "summary": "FinanceGroupPartner: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceGroupPartner-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceGroupPartner_GetAll_6085C1AC6EDF", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceGroupPartner" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceGroupPartner" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceGroupPartner" } } } } } }, "post": { "tags": [ "FinanceGroupPartner" ], "summary": "FinanceGroupPartner: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceGroupPartner-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceGroupPartner_Post_84708BB934C8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceGroupPartner" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceGroupPartner" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceGroupPartner" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceGroupPartner" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceGroupPartner" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceGroupPartner" } } } } } }, "put": { "tags": [ "FinanceGroupPartner" ], "summary": "FinanceGroupPartner: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceGroupPartner-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceGroupPartner_Put_DCE000FA0223", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceGroupPartner" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceGroupPartner" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceGroupPartner" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceGroupPartner" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceGroupPartner" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceGroupPartner" } } } } } } }, "/api/FinanceGroupPartner/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "FinanceGroupPartner" ], "summary": "FinanceGroupPartner: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceGroupPartner-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceGroupPartner_GetPageByValue_E9E2636340F2", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceGroupPartner/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "FinanceGroupPartner" ], "summary": "FinanceGroupPartner: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceGroupPartner-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceGroupPartner_GetPageByValue2_AF05B694CC01", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceGroupPartner/DeleteByFilter": { "post": { "tags": [ "FinanceGroupPartner" ], "summary": "FinanceGroupPartner: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceGroupPartner-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceGroupPartner_DeleteByFilter_59ABA783497E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/FinanceGroupPartner/GetAllByValue": { "post": { "tags": [ "FinanceGroupPartner" ], "summary": "FinanceGroupPartner: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceGroupPartner-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceGroupPartner_GetAllByValue_47280183BC4E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceGroupPartner" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceGroupPartner" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceGroupPartner" } } } } } } }, "/api/FinanceGroupPartner/GetAllGraphByValue": { "post": { "tags": [ "FinanceGroupPartner" ], "summary": "FinanceGroupPartner: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceGroupPartner-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceGroupPartner_GetAllGraphByValue_9F2B0633AE5A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceGroupPartner" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceGroupPartner" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceGroupPartner" } } } } } } }, "/api/FinanceGroupPartner/GetByValue": { "post": { "tags": [ "FinanceGroupPartner" ], "summary": "FinanceGroupPartner: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceGroupPartner-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceGroupPartner_GetByValue_EBC929469695", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceGroupPartner" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceGroupPartner" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceGroupPartner" } } } } } } }, "/api/FinanceGroupPartner/GetLookup": { "post": { "tags": [ "FinanceGroupPartner" ], "summary": "FinanceGroupPartner: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceGroupPartner-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceGroupPartner_GetLookup_3D02EA929830", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceGroupPartner/GetLookupByValue": { "post": { "tags": [ "FinanceGroupPartner" ], "summary": "FinanceGroupPartner: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceGroupPartner-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceGroupPartner_GetLookupByValue_40CF16233E6B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceGroupPartner/Page": { "get": { "tags": [ "FinanceGroupPartner" ], "summary": "FinanceGroupPartner: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceGroupPartner-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceGroupPartner_GetPage_EE27053A7FA7", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceGroupPartner/PageAsc": { "get": { "tags": [ "FinanceGroupPartner" ], "summary": "FinanceGroupPartner: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceGroupPartner-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceGroupPartner_GetPageAsc_1401871D4AF0", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceGroupPartner/SearchByValue": { "post": { "tags": [ "FinanceGroupPartner" ], "summary": "FinanceGroupPartner: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceGroupPartner-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceGroupPartner_SearchByValue_D81506D5F1EE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceGroupPartner" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceGroupPartner" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceGroupPartner" } } } } } } }, "/api/FinanceGroupPartner/TryGetByValue": { "post": { "tags": [ "FinanceGroupPartner" ], "summary": "FinanceGroupPartner: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceGroupPartner-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceGroupPartner_TryGetByValue_F3044C0E6B52", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceGroupPartner" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceGroupPartner" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceGroupPartner" } } } } } } }, "/api/FinanceGroupPartner/UpsertGraph": { "put": { "tags": [ "FinanceGroupPartner" ], "summary": "FinanceGroupPartner: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceGroupPartner-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceGroupPartner_UpsertGraph_6746AAA1BFD3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceGroupPartner" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceGroupPartner" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceGroupPartner" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceGroupPartner" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceGroupPartner" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceGroupPartner" } } } } } } }, "/api/FinanceGroupPartner/UpsertGraphWithExtraFields": { "put": { "tags": [ "FinanceGroupPartner" ], "summary": "FinanceGroupPartner: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceGroupPartner-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceGroupPartner_UpsertGraphWithExtraFields_48E6E7BCD13C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceGroupPartner" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceGroupPartner" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceGroupPartner" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceGroupPartner" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceGroupPartner" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceGroupPartner" } } } } } } }, "/api/FinanceOpeningBalance": { "get": { "tags": [ "FinanceOpeningBalance" ], "summary": "FinanceOpeningBalance: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpeningBalance-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpeningBalance_GetAll_47F8903F7D73", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceOpeningBalance" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceOpeningBalance" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceOpeningBalance" } } } } } }, "post": { "tags": [ "FinanceOpeningBalance" ], "summary": "FinanceOpeningBalance: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpeningBalance-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpeningBalance_Post_23F3DA8740A2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpeningBalance" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpeningBalance" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpeningBalance" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpeningBalance" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpeningBalance" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpeningBalance" } } } } } }, "put": { "tags": [ "FinanceOpeningBalance" ], "summary": "FinanceOpeningBalance: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpeningBalance-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpeningBalance_Put_4BCE82D95CB2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpeningBalance" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpeningBalance" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpeningBalance" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpeningBalance" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpeningBalance" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpeningBalance" } } } } } } }, "/api/FinanceOpeningBalance/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "FinanceOpeningBalance" ], "summary": "FinanceOpeningBalance: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpeningBalance-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpeningBalance_GetPageByValue_0C51E0472E1F", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceOpeningBalance/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "FinanceOpeningBalance" ], "summary": "FinanceOpeningBalance: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpeningBalance-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpeningBalance_GetPageByValue2_FF8712DEA4AB", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceOpeningBalance/CreateNewFinanceOpeningBalance": { "post": { "tags": [ "FinanceOpeningBalance" ], "summary": "FinanceOpeningBalance: CreateNewFinanceOpeningBalance", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpeningBalance-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpeningBalance_CreateNewFinanceOpeningBalance_D0BA2E7E2E0C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpeningBalance_CreateNewRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpeningBalance_CreateNewRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpeningBalance_CreateNewRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpeningBalance" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpeningBalance" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpeningBalance" } } } } } } }, "/api/FinanceOpeningBalance/DeleteByFilter": { "post": { "tags": [ "FinanceOpeningBalance" ], "summary": "FinanceOpeningBalance: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpeningBalance-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpeningBalance_DeleteByFilter_7762F4F66066", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/FinanceOpeningBalance/DeleteFinanceOpeningBalance": { "post": { "tags": [ "FinanceOpeningBalance" ], "summary": "FinanceOpeningBalance: DeleteFinanceOpeningBalance", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpeningBalance-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpeningBalance_DeleteFinanceOpeningBalance_E94A675FA8F4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpeningBalance_DeleteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpeningBalance_DeleteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpeningBalance_DeleteRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/FinanceOpeningBalance/GetAllByValue": { "post": { "tags": [ "FinanceOpeningBalance" ], "summary": "FinanceOpeningBalance: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpeningBalance-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpeningBalance_GetAllByValue_89B625A7ADF6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceOpeningBalance" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceOpeningBalance" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceOpeningBalance" } } } } } } }, "/api/FinanceOpeningBalance/GetAllGraphByValue": { "post": { "tags": [ "FinanceOpeningBalance" ], "summary": "FinanceOpeningBalance: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpeningBalance-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpeningBalance_GetAllGraphByValue_D812919147C7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceOpeningBalance" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceOpeningBalance" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceOpeningBalance" } } } } } } }, "/api/FinanceOpeningBalance/GetByValue": { "post": { "tags": [ "FinanceOpeningBalance" ], "summary": "FinanceOpeningBalance: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpeningBalance-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpeningBalance_GetByValue_C3B27F28D393", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpeningBalance" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpeningBalance" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpeningBalance" } } } } } } }, "/api/FinanceOpeningBalance/GetLookup": { "post": { "tags": [ "FinanceOpeningBalance" ], "summary": "FinanceOpeningBalance: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpeningBalance-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpeningBalance_GetLookup_FF388ED3AD68", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceOpeningBalance/GetLookupByValue": { "post": { "tags": [ "FinanceOpeningBalance" ], "summary": "FinanceOpeningBalance: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpeningBalance-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpeningBalance_GetLookupByValue_8AE746456D71", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceOpeningBalance/Page": { "get": { "tags": [ "FinanceOpeningBalance" ], "summary": "FinanceOpeningBalance: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpeningBalance-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpeningBalance_GetPage_744D223C6B8D", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceOpeningBalance/PageAsc": { "get": { "tags": [ "FinanceOpeningBalance" ], "summary": "FinanceOpeningBalance: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpeningBalance-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpeningBalance_GetPageAsc_A71FFF49B645", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceOpeningBalance/SearchByValue": { "post": { "tags": [ "FinanceOpeningBalance" ], "summary": "FinanceOpeningBalance: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpeningBalance-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpeningBalance_SearchByValue_2A2E303C1D2F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceOpeningBalance" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceOpeningBalance" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceOpeningBalance" } } } } } } }, "/api/FinanceOpeningBalance/TryGetByValue": { "post": { "tags": [ "FinanceOpeningBalance" ], "summary": "FinanceOpeningBalance: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpeningBalance-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpeningBalance_TryGetByValue_5C2120B18E5B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpeningBalance" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpeningBalance" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpeningBalance" } } } } } } }, "/api/FinanceOpeningBalance/UpdateOpeningBalance_Info": { "post": { "tags": [ "FinanceOpeningBalance" ], "summary": "FinanceOpeningBalance: UpdateOpeningBalance_Info", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpeningBalance-Read.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpeningBalance_UpdateOpeningBalance_Info_EEF9FA6A3D40", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpeningBalance_UpdateInfoRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpeningBalance_UpdateInfoRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpeningBalance_UpdateInfoRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/FinanceOpeningBalance/UpdateOpeningBalance_PostingPeriodId": { "post": { "tags": [ "FinanceOpeningBalance" ], "summary": "FinanceOpeningBalance: UpdateOpeningBalance_PostingPeriodId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpeningBalance-Read.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpeningBalance_UpdateOpeningBalance_PostingPeriodId_453930AA3DED", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpeningBalance_UpdatePostingPeriodIdRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpeningBalance_UpdatePostingPeriodIdRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpeningBalance_UpdatePostingPeriodIdRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/FinanceOpeningBalance/UpdateOpeningBalance_ReceiptDate": { "post": { "tags": [ "FinanceOpeningBalance" ], "summary": "FinanceOpeningBalance: UpdateOpeningBalance_ReceiptDate", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpeningBalance-Read.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpeningBalance_UpdateOpeningBalance_ReceiptDate_6D6EF25D25F5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpeningBalance_UpdateReceiptDateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpeningBalance_UpdateReceiptDateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpeningBalance_UpdateReceiptDateRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/FinanceOpeningBalance/UpdateOpeningBalance_ReceiptNumber": { "post": { "tags": [ "FinanceOpeningBalance" ], "summary": "FinanceOpeningBalance: UpdateOpeningBalance_ReceiptNumber", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpeningBalance-Read.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpeningBalance_UpdateOpeningBalance_ReceiptNumber_18950388C0CA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpeningBalance_UpdateReceiptNumberRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpeningBalance_UpdateReceiptNumberRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpeningBalance_UpdateReceiptNumberRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/FinanceOpeningBalance/UpsertGraph": { "put": { "tags": [ "FinanceOpeningBalance" ], "summary": "FinanceOpeningBalance: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpeningBalance-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpeningBalance_UpsertGraph_2B4D684E5DE4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpeningBalance" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpeningBalance" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpeningBalance" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpeningBalance" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpeningBalance" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpeningBalance" } } } } } } }, "/api/FinanceOpeningBalance/UpsertGraphWithExtraFields": { "put": { "tags": [ "FinanceOpeningBalance" ], "summary": "FinanceOpeningBalance: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpeningBalance-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpeningBalance_UpsertGraphWithExtraFields_F2D48E1ECDC4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceOpeningBalance" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceOpeningBalance" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceOpeningBalance" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceOpeningBalance" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceOpeningBalance" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceOpeningBalance" } } } } } } }, "/api/FinanceOpeningBalancePosition": { "get": { "tags": [ "FinanceOpeningBalancePosition" ], "summary": "FinanceOpeningBalancePosition: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpeningBalancePosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpeningBalancePosition_GetAll_492DE8FDF935", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceOpeningBalancePosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceOpeningBalancePosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceOpeningBalancePosition" } } } } } }, "post": { "tags": [ "FinanceOpeningBalancePosition" ], "summary": "FinanceOpeningBalancePosition: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpeningBalancePosition-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpeningBalancePosition_Post_817F131D384B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpeningBalancePosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpeningBalancePosition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpeningBalancePosition" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpeningBalancePosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpeningBalancePosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpeningBalancePosition" } } } } } }, "put": { "tags": [ "FinanceOpeningBalancePosition" ], "summary": "FinanceOpeningBalancePosition: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpeningBalancePosition-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpeningBalancePosition_Put_BA44D5C7780B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpeningBalancePosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpeningBalancePosition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpeningBalancePosition" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpeningBalancePosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpeningBalancePosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpeningBalancePosition" } } } } } } }, "/api/FinanceOpeningBalancePosition/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "FinanceOpeningBalancePosition" ], "summary": "FinanceOpeningBalancePosition: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpeningBalancePosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpeningBalancePosition_GetPageByValue_9C9A79049E67", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceOpeningBalancePosition/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "FinanceOpeningBalancePosition" ], "summary": "FinanceOpeningBalancePosition: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpeningBalancePosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpeningBalancePosition_GetPageByValue2_AB1185237E58", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceOpeningBalancePosition/DeleteByFilter": { "post": { "tags": [ "FinanceOpeningBalancePosition" ], "summary": "FinanceOpeningBalancePosition: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpeningBalancePosition-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpeningBalancePosition_DeleteByFilter_616EF37C61D7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/FinanceOpeningBalancePosition/DeleteFinanceOpeningBalancePosition": { "post": { "tags": [ "FinanceOpeningBalancePosition" ], "summary": "FinanceOpeningBalancePosition: DeleteFinanceOpeningBalancePosition", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpeningBalancePosition-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpeningBalancePosition_DeleteFinanceOpeningBalancePosition_733EBEE1BE04", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpeningBalancePosition_DeleteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpeningBalancePosition_DeleteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpeningBalancePosition_DeleteRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/FinanceOpeningBalancePosition/GetAllByValue": { "post": { "tags": [ "FinanceOpeningBalancePosition" ], "summary": "FinanceOpeningBalancePosition: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpeningBalancePosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpeningBalancePosition_GetAllByValue_E5DDCE95B763", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceOpeningBalancePosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceOpeningBalancePosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceOpeningBalancePosition" } } } } } } }, "/api/FinanceOpeningBalancePosition/GetAllFromViewByValue": { "post": { "tags": [ "FinanceOpeningBalancePosition" ], "summary": "FinanceOpeningBalancePosition: GetAllFromViewByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpeningBalancePosition-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpeningBalancePosition_GetAllFromViewByValue_C3E786C2FF8A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpeningBalancePosition_GetAllFromViewByValueRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpeningBalancePosition_GetAllFromViewByValueRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpeningBalancePosition_GetAllFromViewByValueRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW635_FinanceOpeningBalancePosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW635_FinanceOpeningBalancePosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW635_FinanceOpeningBalancePosition" } } } } } } }, "/api/FinanceOpeningBalancePosition/GetAllGraphByValue": { "post": { "tags": [ "FinanceOpeningBalancePosition" ], "summary": "FinanceOpeningBalancePosition: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpeningBalancePosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpeningBalancePosition_GetAllGraphByValue_EAE137228E28", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceOpeningBalancePosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceOpeningBalancePosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceOpeningBalancePosition" } } } } } } }, "/api/FinanceOpeningBalancePosition/GetByValue": { "post": { "tags": [ "FinanceOpeningBalancePosition" ], "summary": "FinanceOpeningBalancePosition: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpeningBalancePosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpeningBalancePosition_GetByValue_D9F3FD5E0ABC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpeningBalancePosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpeningBalancePosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpeningBalancePosition" } } } } } } }, "/api/FinanceOpeningBalancePosition/GetLookup": { "post": { "tags": [ "FinanceOpeningBalancePosition" ], "summary": "FinanceOpeningBalancePosition: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpeningBalancePosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpeningBalancePosition_GetLookup_3EBA88D247A6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceOpeningBalancePosition/GetLookupByValue": { "post": { "tags": [ "FinanceOpeningBalancePosition" ], "summary": "FinanceOpeningBalancePosition: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpeningBalancePosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpeningBalancePosition_GetLookupByValue_4178D06F8C45", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceOpeningBalancePosition/InsertAll": { "post": { "tags": [ "FinanceOpeningBalancePosition" ], "summary": "FinanceOpeningBalancePosition: InsertAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpeningBalancePosition-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpeningBalancePosition_InsertAll_21A26359E4D5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpeningBalancePosition_InsertAllRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpeningBalancePosition_InsertAllRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpeningBalancePosition_InsertAllRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/FinanceOpeningBalancePosition/InsertFinanceOpeningBalancePosition": { "post": { "tags": [ "FinanceOpeningBalancePosition" ], "summary": "FinanceOpeningBalancePosition: InsertFinanceOpeningBalancePosition", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpeningBalancePosition-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpeningBalancePosition_InsertFinanceOpeningBalancePosition_B89E34DE31EF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpeningBalancePosition_InsertRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpeningBalancePosition_InsertRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpeningBalancePosition_InsertRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xPROC635I_FinanceOpeningBalancePosition_SingleResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xPROC635I_FinanceOpeningBalancePosition_SingleResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xPROC635I_FinanceOpeningBalancePosition_SingleResult" } } } } } } }, "/api/FinanceOpeningBalancePosition/Page": { "get": { "tags": [ "FinanceOpeningBalancePosition" ], "summary": "FinanceOpeningBalancePosition: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpeningBalancePosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpeningBalancePosition_GetPage_8CA40B540EA8", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceOpeningBalancePosition/PageAsc": { "get": { "tags": [ "FinanceOpeningBalancePosition" ], "summary": "FinanceOpeningBalancePosition: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpeningBalancePosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpeningBalancePosition_GetPageAsc_BD7A04A31BB8", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceOpeningBalancePosition/SaveFinanceOpeningBalanceDraft": { "post": { "tags": [ "FinanceOpeningBalancePosition" ], "summary": "FinanceOpeningBalancePosition: SaveFinanceOpeningBalanceDraft", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpeningBalancePosition-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpeningBalancePosition_SaveFinanceOpeningBalanceDraft_17FA75758B3C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpeningBalancePosition_SaveDraftRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpeningBalancePosition_SaveDraftRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpeningBalancePosition_SaveDraftRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PostFinanceOpeningBalanceResult" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PostFinanceOpeningBalanceResult" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PostFinanceOpeningBalanceResult" } } } } } } } }, "/api/FinanceOpeningBalancePosition/SearchByValue": { "post": { "tags": [ "FinanceOpeningBalancePosition" ], "summary": "FinanceOpeningBalancePosition: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpeningBalancePosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpeningBalancePosition_SearchByValue_06C956D6B89D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceOpeningBalancePosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceOpeningBalancePosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceOpeningBalancePosition" } } } } } } }, "/api/FinanceOpeningBalancePosition/TryGetByValue": { "post": { "tags": [ "FinanceOpeningBalancePosition" ], "summary": "FinanceOpeningBalancePosition: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpeningBalancePosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpeningBalancePosition_TryGetByValue_BCA95AE92C2D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpeningBalancePosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpeningBalancePosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpeningBalancePosition" } } } } } } }, "/api/FinanceOpeningBalancePosition/UpdateFinanceOpeningBalancePosition_Amount": { "post": { "tags": [ "FinanceOpeningBalancePosition" ], "summary": "FinanceOpeningBalancePosition: UpdateFinanceOpeningBalancePosition_Amount", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpeningBalancePosition-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpeningBalancePosition_UpdateFinanceOpeningBalancePosition_Amount_7F53D886443B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpeningBalancePosition_UpdateAmountRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpeningBalancePosition_UpdateAmountRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpeningBalancePosition_UpdateAmountRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/FinanceOpeningBalancePosition/UpsertGraph": { "put": { "tags": [ "FinanceOpeningBalancePosition" ], "summary": "FinanceOpeningBalancePosition: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpeningBalancePosition-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpeningBalancePosition_UpsertGraph_630465E933AD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpeningBalancePosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpeningBalancePosition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpeningBalancePosition" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpeningBalancePosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpeningBalancePosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpeningBalancePosition" } } } } } } }, "/api/FinanceOpeningBalancePosition/UpsertGraphWithExtraFields": { "put": { "tags": [ "FinanceOpeningBalancePosition" ], "summary": "FinanceOpeningBalancePosition: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpeningBalancePosition-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpeningBalancePosition_UpsertGraphWithExtraFields_28EE29C6AC43", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceOpeningBalancePosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceOpeningBalancePosition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceOpeningBalancePosition" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceOpeningBalancePosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceOpeningBalancePosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceOpeningBalancePosition" } } } } } } }, "/api/FinanceOpenItem": { "get": { "tags": [ "FinanceOpenItem" ], "summary": "FinanceOpenItem: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItem-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItem_GetAll_976DAED1E89D", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceOpenItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceOpenItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceOpenItem" } } } } } }, "post": { "tags": [ "FinanceOpenItem" ], "summary": "FinanceOpenItem: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItem-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItem_Post_0D5C5AC1F155", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItem" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItem" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItem" } } } } } }, "put": { "tags": [ "FinanceOpenItem" ], "summary": "FinanceOpenItem: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItem-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItem_Put_9E2E701A4888", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItem" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItem" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItem" } } } } } } }, "/api/FinanceOpenItem/{PartnerTypeId}/{OpenItemsOnly}/{StatusId}/{PartnerDetailId}/PageFromView": { "get": { "tags": [ "FinanceOpenItem" ], "summary": "FinanceOpenItem: GetPageFromView", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItem-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItem_GetPageFromView_B60D077AE0CF", "parameters": [ { "name": "PartnerTypeId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "OpenItemsOnly", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "StatusId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PartnerDetailId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceOpenItem/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "FinanceOpenItem" ], "summary": "FinanceOpenItem: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItem-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItem_GetPageByValue_08555D92EC7C", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceOpenItem/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "FinanceOpenItem" ], "summary": "FinanceOpenItem: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItem-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItem_GetPageByValue2_4267B7B5866A", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceOpenItem/DeleteByFilter": { "post": { "tags": [ "FinanceOpenItem" ], "summary": "FinanceOpenItem: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItem-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItem_DeleteByFilter_0D0EE8B0B18F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/FinanceOpenItem/GetAllByValue": { "post": { "tags": [ "FinanceOpenItem" ], "summary": "FinanceOpenItem: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItem-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItem_GetAllByValue_2B3FDAA398D4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceOpenItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceOpenItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceOpenItem" } } } } } } }, "/api/FinanceOpenItem/GetAllGraphByValue": { "post": { "tags": [ "FinanceOpenItem" ], "summary": "FinanceOpenItem: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItem-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItem_GetAllGraphByValue_BB47D3905A49", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceOpenItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceOpenItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceOpenItem" } } } } } } }, "/api/FinanceOpenItem/GetByValue": { "post": { "tags": [ "FinanceOpenItem" ], "summary": "FinanceOpenItem: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItem-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItem_GetByValue_3C9ED884A5DC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItem" } } } } } } }, "/api/FinanceOpenItem/GetLookup": { "post": { "tags": [ "FinanceOpenItem" ], "summary": "FinanceOpenItem: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItem-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItem_GetLookup_EB5B08EBB75A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceOpenItem/GetLookupByValue": { "post": { "tags": [ "FinanceOpenItem" ], "summary": "FinanceOpenItem: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItem-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItem_GetLookupByValue_61394332D5A9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceOpenItem/Page": { "get": { "tags": [ "FinanceOpenItem" ], "summary": "FinanceOpenItem: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItem-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItem_GetPage_3AD60990CD6B", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceOpenItem/PageAsc": { "get": { "tags": [ "FinanceOpenItem" ], "summary": "FinanceOpenItem: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItem-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItem_GetPageAsc_151F8DCEA321", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceOpenItem/SearchByValue": { "post": { "tags": [ "FinanceOpenItem" ], "summary": "FinanceOpenItem: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItem-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItem_SearchByValue_85616E964F6B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceOpenItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceOpenItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceOpenItem" } } } } } } }, "/api/FinanceOpenItem/TryGetByValue": { "post": { "tags": [ "FinanceOpenItem" ], "summary": "FinanceOpenItem: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItem-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItem_TryGetByValue_5B5E0ED65510", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItem" } } } } } } }, "/api/FinanceOpenItem/UpsertGraph": { "put": { "tags": [ "FinanceOpenItem" ], "summary": "FinanceOpenItem: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItem-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItem_UpsertGraph_4B39F2B6628E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItem" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItem" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItem" } } } } } } }, "/api/FinanceOpenItem/UpsertGraphWithExtraFields": { "put": { "tags": [ "FinanceOpenItem" ], "summary": "FinanceOpenItem: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItem-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItem_UpsertGraphWithExtraFields_864F8ABF0E73", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceOpenItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceOpenItem" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceOpenItem" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceOpenItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceOpenItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceOpenItem" } } } } } } }, "/api/FinanceOpenItemInternalReconciliation": { "get": { "tags": [ "FinanceOpenItemInternalReconciliation" ], "summary": "FinanceOpenItemInternalReconciliation: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemInternalReconciliation-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemInternalReconciliation_GetAll_516ED6DDC8CF", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceOpenItemInternalReconciliation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceOpenItemInternalReconciliation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceOpenItemInternalReconciliation" } } } } } }, "post": { "tags": [ "FinanceOpenItemInternalReconciliation" ], "summary": "FinanceOpenItemInternalReconciliation: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemInternalReconciliation-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemInternalReconciliation_Post_C30E885A0191", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItemInternalReconciliation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItemInternalReconciliation" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItemInternalReconciliation" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItemInternalReconciliation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItemInternalReconciliation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItemInternalReconciliation" } } } } } }, "put": { "tags": [ "FinanceOpenItemInternalReconciliation" ], "summary": "FinanceOpenItemInternalReconciliation: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemInternalReconciliation-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemInternalReconciliation_Put_9A7E5AD0DFF7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItemInternalReconciliation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItemInternalReconciliation" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItemInternalReconciliation" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItemInternalReconciliation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItemInternalReconciliation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItemInternalReconciliation" } } } } } } }, "/api/FinanceOpenItemInternalReconciliation/{PartnerTypeId}/PageFromView": { "get": { "tags": [ "FinanceOpenItemInternalReconciliation" ], "summary": "FinanceOpenItemInternalReconciliation: GetPageFromView", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemInternalReconciliation-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemInternalReconciliation_GetPageFromView_E94349D6572E", "parameters": [ { "name": "PartnerTypeId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceOpenItemInternalReconciliation/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "FinanceOpenItemInternalReconciliation" ], "summary": "FinanceOpenItemInternalReconciliation: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemInternalReconciliation-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemInternalReconciliation_GetPageByValue_79CCE8F10379", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceOpenItemInternalReconciliation/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "FinanceOpenItemInternalReconciliation" ], "summary": "FinanceOpenItemInternalReconciliation: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemInternalReconciliation-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemInternalReconciliation_GetPageByValue2_ADAC442B3D73", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceOpenItemInternalReconciliation/DeleteByFilter": { "post": { "tags": [ "FinanceOpenItemInternalReconciliation" ], "summary": "FinanceOpenItemInternalReconciliation: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemInternalReconciliation-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemInternalReconciliation_DeleteByFilter_54E81638C5CF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/FinanceOpenItemInternalReconciliation/GetAllByValue": { "post": { "tags": [ "FinanceOpenItemInternalReconciliation" ], "summary": "FinanceOpenItemInternalReconciliation: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemInternalReconciliation-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemInternalReconciliation_GetAllByValue_A8147BF9322E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceOpenItemInternalReconciliation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceOpenItemInternalReconciliation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceOpenItemInternalReconciliation" } } } } } } }, "/api/FinanceOpenItemInternalReconciliation/GetAllGraphByValue": { "post": { "tags": [ "FinanceOpenItemInternalReconciliation" ], "summary": "FinanceOpenItemInternalReconciliation: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemInternalReconciliation-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemInternalReconciliation_GetAllGraphByValue_A0E121F61396", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceOpenItemInternalReconciliation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceOpenItemInternalReconciliation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceOpenItemInternalReconciliation" } } } } } } }, "/api/FinanceOpenItemInternalReconciliation/GetAttachmentCount": { "post": { "tags": [ "FinanceOpenItemInternalReconciliation" ], "summary": "FinanceOpenItemInternalReconciliation: GetAttachmentCount", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemInternalReconciliation-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemInternalReconciliation_GetAttachmentCount_77F98CFF2217", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItemInternalReconciliation_GetAttachmentCountRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItemInternalReconciliation_GetAttachmentCountRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItemInternalReconciliation_GetAttachmentCountRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/FinanceOpenItemInternalReconciliation/GetByValue": { "post": { "tags": [ "FinanceOpenItemInternalReconciliation" ], "summary": "FinanceOpenItemInternalReconciliation: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemInternalReconciliation-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemInternalReconciliation_GetByValue_B261191D6BD4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItemInternalReconciliation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItemInternalReconciliation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItemInternalReconciliation" } } } } } } }, "/api/FinanceOpenItemInternalReconciliation/GetLookup": { "post": { "tags": [ "FinanceOpenItemInternalReconciliation" ], "summary": "FinanceOpenItemInternalReconciliation: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemInternalReconciliation-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemInternalReconciliation_GetLookup_B9CA41068A34", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceOpenItemInternalReconciliation/GetLookupByValue": { "post": { "tags": [ "FinanceOpenItemInternalReconciliation" ], "summary": "FinanceOpenItemInternalReconciliation: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemInternalReconciliation-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemInternalReconciliation_GetLookupByValue_98380AA7BE85", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceOpenItemInternalReconciliation/Page": { "get": { "tags": [ "FinanceOpenItemInternalReconciliation" ], "summary": "FinanceOpenItemInternalReconciliation: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemInternalReconciliation-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemInternalReconciliation_GetPage_FD9714BB6221", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceOpenItemInternalReconciliation/PageAsc": { "get": { "tags": [ "FinanceOpenItemInternalReconciliation" ], "summary": "FinanceOpenItemInternalReconciliation: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemInternalReconciliation-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemInternalReconciliation_GetPageAsc_ECFC92D1D0E3", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceOpenItemInternalReconciliation/ReconciliationCancellation": { "post": { "tags": [ "FinanceOpenItemInternalReconciliation" ], "summary": "FinanceOpenItemInternalReconciliation: ReconciliationCancellation", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemInternalReconciliation-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemInternalReconciliation_ReconciliationCancellation_0C7B2A8431F6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItemInternalReconciliation_ReconciliationCancellationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItemInternalReconciliation_ReconciliationCancellationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItemInternalReconciliation_ReconciliationCancellationRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/FinanceOpenItemInternalReconciliation/SaveAndPostInternalReconciliation": { "post": { "tags": [ "FinanceOpenItemInternalReconciliation" ], "summary": "FinanceOpenItemInternalReconciliation: SaveAndPostInternalReconciliation", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemInternalReconciliation-Create.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemInternalReconciliation_SaveAndPostInternalReconciliation_2A167D03110A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.InternalReconciliationPostingDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.InternalReconciliationPostingDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.InternalReconciliationPostingDto" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/FinanceOpenItemInternalReconciliation/SearchByValue": { "post": { "tags": [ "FinanceOpenItemInternalReconciliation" ], "summary": "FinanceOpenItemInternalReconciliation: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemInternalReconciliation-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemInternalReconciliation_SearchByValue_1B79065EA2DA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceOpenItemInternalReconciliation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceOpenItemInternalReconciliation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceOpenItemInternalReconciliation" } } } } } } }, "/api/FinanceOpenItemInternalReconciliation/TryGetByValue": { "post": { "tags": [ "FinanceOpenItemInternalReconciliation" ], "summary": "FinanceOpenItemInternalReconciliation: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemInternalReconciliation-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemInternalReconciliation_TryGetByValue_1D31676FBFDD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItemInternalReconciliation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItemInternalReconciliation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItemInternalReconciliation" } } } } } } }, "/api/FinanceOpenItemInternalReconciliation/UpsertGraph": { "put": { "tags": [ "FinanceOpenItemInternalReconciliation" ], "summary": "FinanceOpenItemInternalReconciliation: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemInternalReconciliation-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemInternalReconciliation_UpsertGraph_76AE62501830", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItemInternalReconciliation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItemInternalReconciliation" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItemInternalReconciliation" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItemInternalReconciliation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItemInternalReconciliation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItemInternalReconciliation" } } } } } } }, "/api/FinanceOpenItemInternalReconciliation/UpsertGraphWithExtraFields": { "put": { "tags": [ "FinanceOpenItemInternalReconciliation" ], "summary": "FinanceOpenItemInternalReconciliation: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemInternalReconciliation-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemInternalReconciliation_UpsertGraphWithExtraFields_1396257AC0DE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceOpenItemInternalReconciliation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceOpenItemInternalReconciliation" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceOpenItemInternalReconciliation" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceOpenItemInternalReconciliation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceOpenItemInternalReconciliation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceOpenItemInternalReconciliation" } } } } } } }, "/api/FinanceOpenItemInternalReconciliationPosition": { "get": { "tags": [ "FinanceOpenItemInternalReconciliationPosition" ], "summary": "FinanceOpenItemInternalReconciliationPosition: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemInternalReconciliationPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemInternalReconciliationPosition_GetAll_75B8B18911A0", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceOpenItemInternalReconciliationPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceOpenItemInternalReconciliationPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceOpenItemInternalReconciliationPosition" } } } } } }, "post": { "tags": [ "FinanceOpenItemInternalReconciliationPosition" ], "summary": "FinanceOpenItemInternalReconciliationPosition: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemInternalReconciliationPosition-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemInternalReconciliationPosition_Post_473FC082343B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItemInternalReconciliationPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItemInternalReconciliationPosition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItemInternalReconciliationPosition" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItemInternalReconciliationPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItemInternalReconciliationPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItemInternalReconciliationPosition" } } } } } }, "put": { "tags": [ "FinanceOpenItemInternalReconciliationPosition" ], "summary": "FinanceOpenItemInternalReconciliationPosition: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemInternalReconciliationPosition-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemInternalReconciliationPosition_Put_1C5927A1818C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItemInternalReconciliationPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItemInternalReconciliationPosition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItemInternalReconciliationPosition" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItemInternalReconciliationPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItemInternalReconciliationPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItemInternalReconciliationPosition" } } } } } } }, "/api/FinanceOpenItemInternalReconciliationPosition/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "FinanceOpenItemInternalReconciliationPosition" ], "summary": "FinanceOpenItemInternalReconciliationPosition: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemInternalReconciliationPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemInternalReconciliationPosition_GetPageByValue_7ED57E91C597", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceOpenItemInternalReconciliationPosition/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "FinanceOpenItemInternalReconciliationPosition" ], "summary": "FinanceOpenItemInternalReconciliationPosition: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemInternalReconciliationPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemInternalReconciliationPosition_GetPageByValue2_DCF8306E8C27", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceOpenItemInternalReconciliationPosition/DeleteByFilter": { "post": { "tags": [ "FinanceOpenItemInternalReconciliationPosition" ], "summary": "FinanceOpenItemInternalReconciliationPosition: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemInternalReconciliationPosition-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemInternalReconciliationPosition_DeleteByFilter_9D2A5F68200B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/FinanceOpenItemInternalReconciliationPosition/GetAllByValue": { "post": { "tags": [ "FinanceOpenItemInternalReconciliationPosition" ], "summary": "FinanceOpenItemInternalReconciliationPosition: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemInternalReconciliationPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemInternalReconciliationPosition_GetAllByValue_6BD9B371DA34", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceOpenItemInternalReconciliationPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceOpenItemInternalReconciliationPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceOpenItemInternalReconciliationPosition" } } } } } } }, "/api/FinanceOpenItemInternalReconciliationPosition/GetAllGraphByValue": { "post": { "tags": [ "FinanceOpenItemInternalReconciliationPosition" ], "summary": "FinanceOpenItemInternalReconciliationPosition: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemInternalReconciliationPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemInternalReconciliationPosition_GetAllGraphByValue_704C0A79CDC0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceOpenItemInternalReconciliationPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceOpenItemInternalReconciliationPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceOpenItemInternalReconciliationPosition" } } } } } } }, "/api/FinanceOpenItemInternalReconciliationPosition/GetByValue": { "post": { "tags": [ "FinanceOpenItemInternalReconciliationPosition" ], "summary": "FinanceOpenItemInternalReconciliationPosition: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemInternalReconciliationPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemInternalReconciliationPosition_GetByValue_328CAB238AA9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItemInternalReconciliationPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItemInternalReconciliationPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItemInternalReconciliationPosition" } } } } } } }, "/api/FinanceOpenItemInternalReconciliationPosition/GetFromViewReconciliationPositions": { "post": { "tags": [ "FinanceOpenItemInternalReconciliationPosition" ], "summary": "FinanceOpenItemInternalReconciliationPosition: GetFromViewReconciliationPositions", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemInternalReconciliationPosition-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemInternalReconciliationPosition_GetFromViewReconciliationPositions_45BA441195CF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItemInternalReconciliationPosition_GetReconciliationPositionsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItemInternalReconciliationPosition_GetReconciliationPositionsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItemInternalReconciliationPosition_GetReconciliationPositionsRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW603_FinanceOpenItemReconciliationPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW603_FinanceOpenItemReconciliationPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW603_FinanceOpenItemReconciliationPosition" } } } } } } }, "/api/FinanceOpenItemInternalReconciliationPosition/GetLookup": { "post": { "tags": [ "FinanceOpenItemInternalReconciliationPosition" ], "summary": "FinanceOpenItemInternalReconciliationPosition: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemInternalReconciliationPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemInternalReconciliationPosition_GetLookup_51D19C797B57", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceOpenItemInternalReconciliationPosition/GetLookupByValue": { "post": { "tags": [ "FinanceOpenItemInternalReconciliationPosition" ], "summary": "FinanceOpenItemInternalReconciliationPosition: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemInternalReconciliationPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemInternalReconciliationPosition_GetLookupByValue_C4484444155A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceOpenItemInternalReconciliationPosition/Page": { "get": { "tags": [ "FinanceOpenItemInternalReconciliationPosition" ], "summary": "FinanceOpenItemInternalReconciliationPosition: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemInternalReconciliationPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemInternalReconciliationPosition_GetPage_0E009A49BD80", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceOpenItemInternalReconciliationPosition/PageAsc": { "get": { "tags": [ "FinanceOpenItemInternalReconciliationPosition" ], "summary": "FinanceOpenItemInternalReconciliationPosition: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemInternalReconciliationPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemInternalReconciliationPosition_GetPageAsc_36423E5C61D2", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceOpenItemInternalReconciliationPosition/SearchByValue": { "post": { "tags": [ "FinanceOpenItemInternalReconciliationPosition" ], "summary": "FinanceOpenItemInternalReconciliationPosition: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemInternalReconciliationPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemInternalReconciliationPosition_SearchByValue_57BFA69A84A9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceOpenItemInternalReconciliationPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceOpenItemInternalReconciliationPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceOpenItemInternalReconciliationPosition" } } } } } } }, "/api/FinanceOpenItemInternalReconciliationPosition/TryGetByValue": { "post": { "tags": [ "FinanceOpenItemInternalReconciliationPosition" ], "summary": "FinanceOpenItemInternalReconciliationPosition: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemInternalReconciliationPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemInternalReconciliationPosition_TryGetByValue_8CA2F4449304", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItemInternalReconciliationPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItemInternalReconciliationPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItemInternalReconciliationPosition" } } } } } } }, "/api/FinanceOpenItemInternalReconciliationPosition/UpsertGraph": { "put": { "tags": [ "FinanceOpenItemInternalReconciliationPosition" ], "summary": "FinanceOpenItemInternalReconciliationPosition: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemInternalReconciliationPosition-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemInternalReconciliationPosition_UpsertGraph_8C5159715FC4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItemInternalReconciliationPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItemInternalReconciliationPosition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItemInternalReconciliationPosition" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItemInternalReconciliationPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItemInternalReconciliationPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItemInternalReconciliationPosition" } } } } } } }, "/api/FinanceOpenItemInternalReconciliationPosition/UpsertGraphWithExtraFields": { "put": { "tags": [ "FinanceOpenItemInternalReconciliationPosition" ], "summary": "FinanceOpenItemInternalReconciliationPosition: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemInternalReconciliationPosition-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemInternalReconciliationPosition_UpsertGraphWithExtraFields_98B6D80B347C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceOpenItemInternalReconciliationPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceOpenItemInternalReconciliationPosition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceOpenItemInternalReconciliationPosition" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceOpenItemInternalReconciliationPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceOpenItemInternalReconciliationPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceOpenItemInternalReconciliationPosition" } } } } } } }, "/api/FinanceOpenItemOrigin": { "get": { "tags": [ "FinanceOpenItemOrigin" ], "summary": "FinanceOpenItemOrigin: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemOrigin-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemOrigin_GetAll_43EC89A2DBF8", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceOpenItemOrigin" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceOpenItemOrigin" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceOpenItemOrigin" } } } } } }, "post": { "tags": [ "FinanceOpenItemOrigin" ], "summary": "FinanceOpenItemOrigin: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemOrigin-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemOrigin_Post_9A9BB9A8979B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItemOrigin" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItemOrigin" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItemOrigin" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItemOrigin" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItemOrigin" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItemOrigin" } } } } } }, "put": { "tags": [ "FinanceOpenItemOrigin" ], "summary": "FinanceOpenItemOrigin: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemOrigin-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemOrigin_Put_2F852149FC67", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItemOrigin" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItemOrigin" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItemOrigin" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItemOrigin" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItemOrigin" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItemOrigin" } } } } } } }, "/api/FinanceOpenItemOrigin/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "FinanceOpenItemOrigin" ], "summary": "FinanceOpenItemOrigin: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemOrigin-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemOrigin_GetPageByValue_AFA9E40276BD", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceOpenItemOrigin/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "FinanceOpenItemOrigin" ], "summary": "FinanceOpenItemOrigin: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemOrigin-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemOrigin_GetPageByValue2_9DC03AFDE44D", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceOpenItemOrigin/DeleteByFilter": { "post": { "tags": [ "FinanceOpenItemOrigin" ], "summary": "FinanceOpenItemOrigin: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemOrigin-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemOrigin_DeleteByFilter_2F4BC3327433", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/FinanceOpenItemOrigin/GetAllByValue": { "post": { "tags": [ "FinanceOpenItemOrigin" ], "summary": "FinanceOpenItemOrigin: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemOrigin-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemOrigin_GetAllByValue_1177D4D15786", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceOpenItemOrigin" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceOpenItemOrigin" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceOpenItemOrigin" } } } } } } }, "/api/FinanceOpenItemOrigin/GetAllGraphByValue": { "post": { "tags": [ "FinanceOpenItemOrigin" ], "summary": "FinanceOpenItemOrigin: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemOrigin-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemOrigin_GetAllGraphByValue_7727061FDDA9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceOpenItemOrigin" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceOpenItemOrigin" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceOpenItemOrigin" } } } } } } }, "/api/FinanceOpenItemOrigin/GetByValue": { "post": { "tags": [ "FinanceOpenItemOrigin" ], "summary": "FinanceOpenItemOrigin: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemOrigin-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemOrigin_GetByValue_AF44448E1826", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItemOrigin" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItemOrigin" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItemOrigin" } } } } } } }, "/api/FinanceOpenItemOrigin/GetLookup": { "post": { "tags": [ "FinanceOpenItemOrigin" ], "summary": "FinanceOpenItemOrigin: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemOrigin-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemOrigin_GetLookup_083340F3DF87", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceOpenItemOrigin/GetLookupByValue": { "post": { "tags": [ "FinanceOpenItemOrigin" ], "summary": "FinanceOpenItemOrigin: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemOrigin-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemOrigin_GetLookupByValue_4DED12EA4524", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceOpenItemOrigin/Page": { "get": { "tags": [ "FinanceOpenItemOrigin" ], "summary": "FinanceOpenItemOrigin: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemOrigin-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemOrigin_GetPage_DD0A844A7AC2", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceOpenItemOrigin/PageAsc": { "get": { "tags": [ "FinanceOpenItemOrigin" ], "summary": "FinanceOpenItemOrigin: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemOrigin-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemOrigin_GetPageAsc_92D57080AE79", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceOpenItemOrigin/SearchByValue": { "post": { "tags": [ "FinanceOpenItemOrigin" ], "summary": "FinanceOpenItemOrigin: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemOrigin-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemOrigin_SearchByValue_FA34F70A6F74", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceOpenItemOrigin" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceOpenItemOrigin" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceOpenItemOrigin" } } } } } } }, "/api/FinanceOpenItemOrigin/TryGetByValue": { "post": { "tags": [ "FinanceOpenItemOrigin" ], "summary": "FinanceOpenItemOrigin: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemOrigin-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemOrigin_TryGetByValue_1D02724023D7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItemOrigin" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItemOrigin" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItemOrigin" } } } } } } }, "/api/FinanceOpenItemOrigin/UpsertGraph": { "put": { "tags": [ "FinanceOpenItemOrigin" ], "summary": "FinanceOpenItemOrigin: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemOrigin-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemOrigin_UpsertGraph_C854371104BF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItemOrigin" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItemOrigin" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItemOrigin" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItemOrigin" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItemOrigin" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItemOrigin" } } } } } } }, "/api/FinanceOpenItemOrigin/UpsertGraphWithExtraFields": { "put": { "tags": [ "FinanceOpenItemOrigin" ], "summary": "FinanceOpenItemOrigin: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemOrigin-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemOrigin_UpsertGraphWithExtraFields_9C6DD8AA1182", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceOpenItemOrigin" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceOpenItemOrigin" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceOpenItemOrigin" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceOpenItemOrigin" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceOpenItemOrigin" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceOpenItemOrigin" } } } } } } }, "/api/FinanceOpenItemStatus": { "get": { "tags": [ "FinanceOpenItemStatus" ], "summary": "FinanceOpenItemStatus: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemStatus_GetAll_7E9793D042B3", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceOpenItemStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceOpenItemStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceOpenItemStatus" } } } } } }, "post": { "tags": [ "FinanceOpenItemStatus" ], "summary": "FinanceOpenItemStatus: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemStatus-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemStatus_Post_9FE7934F68A8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItemStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItemStatus" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItemStatus" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItemStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItemStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItemStatus" } } } } } }, "put": { "tags": [ "FinanceOpenItemStatus" ], "summary": "FinanceOpenItemStatus: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemStatus-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemStatus_Put_D4D19AA819CE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItemStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItemStatus" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItemStatus" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItemStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItemStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItemStatus" } } } } } } }, "/api/FinanceOpenItemStatus/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "FinanceOpenItemStatus" ], "summary": "FinanceOpenItemStatus: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemStatus_GetPageByValue_9A79CDF206B4", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceOpenItemStatus/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "FinanceOpenItemStatus" ], "summary": "FinanceOpenItemStatus: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemStatus_GetPageByValue2_7D1D9BB1D7B1", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceOpenItemStatus/DeleteByFilter": { "post": { "tags": [ "FinanceOpenItemStatus" ], "summary": "FinanceOpenItemStatus: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemStatus-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemStatus_DeleteByFilter_FED4B688EBC5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/FinanceOpenItemStatus/GetAllByValue": { "post": { "tags": [ "FinanceOpenItemStatus" ], "summary": "FinanceOpenItemStatus: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemStatus_GetAllByValue_D62C3329ED9A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceOpenItemStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceOpenItemStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceOpenItemStatus" } } } } } } }, "/api/FinanceOpenItemStatus/GetAllGraphByValue": { "post": { "tags": [ "FinanceOpenItemStatus" ], "summary": "FinanceOpenItemStatus: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemStatus_GetAllGraphByValue_8CE26026474A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceOpenItemStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceOpenItemStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceOpenItemStatus" } } } } } } }, "/api/FinanceOpenItemStatus/GetByValue": { "post": { "tags": [ "FinanceOpenItemStatus" ], "summary": "FinanceOpenItemStatus: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemStatus_GetByValue_CBE2DA0FE6C3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItemStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItemStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItemStatus" } } } } } } }, "/api/FinanceOpenItemStatus/GetLookup": { "post": { "tags": [ "FinanceOpenItemStatus" ], "summary": "FinanceOpenItemStatus: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemStatus_GetLookup_4878C7586DA9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceOpenItemStatus/GetLookupByValue": { "post": { "tags": [ "FinanceOpenItemStatus" ], "summary": "FinanceOpenItemStatus: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemStatus_GetLookupByValue_0B1BD8EFD715", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceOpenItemStatus/Page": { "get": { "tags": [ "FinanceOpenItemStatus" ], "summary": "FinanceOpenItemStatus: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemStatus_GetPage_0D4701457AD2", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceOpenItemStatus/PageAsc": { "get": { "tags": [ "FinanceOpenItemStatus" ], "summary": "FinanceOpenItemStatus: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemStatus_GetPageAsc_38750E7EAFA3", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceOpenItemStatus/SearchByValue": { "post": { "tags": [ "FinanceOpenItemStatus" ], "summary": "FinanceOpenItemStatus: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemStatus_SearchByValue_CA161F36C09F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceOpenItemStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceOpenItemStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceOpenItemStatus" } } } } } } }, "/api/FinanceOpenItemStatus/TryGetByValue": { "post": { "tags": [ "FinanceOpenItemStatus" ], "summary": "FinanceOpenItemStatus: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemStatus_TryGetByValue_DE891BD5579B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItemStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItemStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItemStatus" } } } } } } }, "/api/FinanceOpenItemStatus/UpsertGraph": { "put": { "tags": [ "FinanceOpenItemStatus" ], "summary": "FinanceOpenItemStatus: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemStatus-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemStatus_UpsertGraph_4C415F8031AF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItemStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItemStatus" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItemStatus" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItemStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItemStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItemStatus" } } } } } } }, "/api/FinanceOpenItemStatus/UpsertGraphWithExtraFields": { "put": { "tags": [ "FinanceOpenItemStatus" ], "summary": "FinanceOpenItemStatus: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemStatus-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemStatus_UpsertGraphWithExtraFields_1E48BEA55C55", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceOpenItemStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceOpenItemStatus" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceOpenItemStatus" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceOpenItemStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceOpenItemStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceOpenItemStatus" } } } } } } }, "/api/FinanceOpenItemType": { "get": { "tags": [ "FinanceOpenItemType" ], "summary": "FinanceOpenItemType: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemType_GetAll_9B1DA27BCFEB", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceOpenItemType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceOpenItemType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceOpenItemType" } } } } } }, "post": { "tags": [ "FinanceOpenItemType" ], "summary": "FinanceOpenItemType: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemType-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemType_Post_A46D5F7B3DDA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItemType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItemType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItemType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItemType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItemType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItemType" } } } } } }, "put": { "tags": [ "FinanceOpenItemType" ], "summary": "FinanceOpenItemType: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemType_Put_80B8FCDE1A39", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItemType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItemType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItemType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItemType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItemType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItemType" } } } } } } }, "/api/FinanceOpenItemType/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "FinanceOpenItemType" ], "summary": "FinanceOpenItemType: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemType_GetPageByValue_118C8D6F5090", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceOpenItemType/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "FinanceOpenItemType" ], "summary": "FinanceOpenItemType: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemType_GetPageByValue2_769150478B51", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceOpenItemType/DeleteByFilter": { "post": { "tags": [ "FinanceOpenItemType" ], "summary": "FinanceOpenItemType: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemType-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemType_DeleteByFilter_042356D3E02A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/FinanceOpenItemType/GetAllByValue": { "post": { "tags": [ "FinanceOpenItemType" ], "summary": "FinanceOpenItemType: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemType_GetAllByValue_79CD97BC4721", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceOpenItemType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceOpenItemType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceOpenItemType" } } } } } } }, "/api/FinanceOpenItemType/GetAllGraphByValue": { "post": { "tags": [ "FinanceOpenItemType" ], "summary": "FinanceOpenItemType: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemType_GetAllGraphByValue_9A0E41A3AE48", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceOpenItemType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceOpenItemType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceOpenItemType" } } } } } } }, "/api/FinanceOpenItemType/GetByValue": { "post": { "tags": [ "FinanceOpenItemType" ], "summary": "FinanceOpenItemType: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemType_GetByValue_686151E28244", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItemType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItemType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItemType" } } } } } } }, "/api/FinanceOpenItemType/GetLookup": { "post": { "tags": [ "FinanceOpenItemType" ], "summary": "FinanceOpenItemType: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemType_GetLookup_03833A39C7C6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceOpenItemType/GetLookupByValue": { "post": { "tags": [ "FinanceOpenItemType" ], "summary": "FinanceOpenItemType: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemType_GetLookupByValue_5D74D1DB1DCD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceOpenItemType/Page": { "get": { "tags": [ "FinanceOpenItemType" ], "summary": "FinanceOpenItemType: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemType_GetPage_4427F89E1B31", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceOpenItemType/PageAsc": { "get": { "tags": [ "FinanceOpenItemType" ], "summary": "FinanceOpenItemType: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemType_GetPageAsc_E853B9FF706B", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceOpenItemType/SearchByValue": { "post": { "tags": [ "FinanceOpenItemType" ], "summary": "FinanceOpenItemType: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemType_SearchByValue_3B5101FA7955", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceOpenItemType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceOpenItemType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceOpenItemType" } } } } } } }, "/api/FinanceOpenItemType/TryGetByValue": { "post": { "tags": [ "FinanceOpenItemType" ], "summary": "FinanceOpenItemType: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemType_TryGetByValue_2F91DC8E9379", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItemType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItemType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItemType" } } } } } } }, "/api/FinanceOpenItemType/UpsertGraph": { "put": { "tags": [ "FinanceOpenItemType" ], "summary": "FinanceOpenItemType: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemType_UpsertGraph_FF4B4D60D15F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItemType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItemType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItemType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItemType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItemType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItemType" } } } } } } }, "/api/FinanceOpenItemType/UpsertGraphWithExtraFields": { "put": { "tags": [ "FinanceOpenItemType" ], "summary": "FinanceOpenItemType: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceOpenItemType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceOpenItemType_UpsertGraphWithExtraFields_3C85CE7006D5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceOpenItemType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceOpenItemType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceOpenItemType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceOpenItemType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceOpenItemType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceOpenItemType" } } } } } } }, "/api/FinancePayment": { "get": { "tags": [ "FinancePayment" ], "summary": "FinancePayment: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePayment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePayment_GetAll_7ED1013BDD23", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePayment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePayment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePayment" } } } } } }, "post": { "tags": [ "FinancePayment" ], "summary": "FinancePayment: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePayment-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePayment_Post_4EB5794DACDA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePayment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePayment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePayment" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePayment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePayment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePayment" } } } } } }, "put": { "tags": [ "FinancePayment" ], "summary": "FinancePayment: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePayment-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePayment_Put_18685323ECBD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePayment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePayment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePayment" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePayment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePayment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePayment" } } } } } } }, "/api/FinancePayment/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "FinancePayment" ], "summary": "FinancePayment: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePayment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePayment_GetPageByValue_40A4A1AB926D", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinancePayment/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "FinancePayment" ], "summary": "FinancePayment: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePayment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePayment_GetPageByValue2_1B6039AAC825", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinancePayment/DeleteByFilter": { "post": { "tags": [ "FinancePayment" ], "summary": "FinancePayment: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePayment-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePayment_DeleteByFilter_ECD6C7E456DE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/FinancePayment/GetAllByValue": { "post": { "tags": [ "FinancePayment" ], "summary": "FinancePayment: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePayment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePayment_GetAllByValue_DCAD99C83751", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePayment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePayment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePayment" } } } } } } }, "/api/FinancePayment/GetAllGraphByValue": { "post": { "tags": [ "FinancePayment" ], "summary": "FinancePayment: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePayment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePayment_GetAllGraphByValue_FEAE90F2F5BB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePayment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePayment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePayment" } } } } } } }, "/api/FinancePayment/GetByValue": { "post": { "tags": [ "FinancePayment" ], "summary": "FinancePayment: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePayment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePayment_GetByValue_DB406ED029B0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePayment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePayment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePayment" } } } } } } }, "/api/FinancePayment/GetLookup": { "post": { "tags": [ "FinancePayment" ], "summary": "FinancePayment: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePayment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePayment_GetLookup_BCA39E836B37", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinancePayment/GetLookupByValue": { "post": { "tags": [ "FinancePayment" ], "summary": "FinancePayment: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePayment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePayment_GetLookupByValue_7F9E871343D4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinancePayment/Page": { "get": { "tags": [ "FinancePayment" ], "summary": "FinancePayment: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePayment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePayment_GetPage_E77C8A004BFA", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinancePayment/PageAsc": { "get": { "tags": [ "FinancePayment" ], "summary": "FinancePayment: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePayment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePayment_GetPageAsc_DBC0B220BC2F", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinancePayment/SearchByValue": { "post": { "tags": [ "FinancePayment" ], "summary": "FinancePayment: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePayment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePayment_SearchByValue_5D2B63218F96", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinancePayment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinancePayment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinancePayment" } } } } } } }, "/api/FinancePayment/TryGetByValue": { "post": { "tags": [ "FinancePayment" ], "summary": "FinancePayment: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePayment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePayment_TryGetByValue_8AE0906F18CA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePayment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePayment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePayment" } } } } } } }, "/api/FinancePayment/UpsertGraph": { "put": { "tags": [ "FinancePayment" ], "summary": "FinancePayment: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePayment-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePayment_UpsertGraph_88F7F4C120F3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePayment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePayment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePayment" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePayment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePayment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePayment" } } } } } } }, "/api/FinancePayment/UpsertGraphWithExtraFields": { "put": { "tags": [ "FinancePayment" ], "summary": "FinancePayment: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePayment-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePayment_UpsertGraphWithExtraFields_6A147266FBF0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePayment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePayment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePayment" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePayment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePayment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePayment" } } } } } } }, "/api/FinancePaymentPosition": { "get": { "tags": [ "FinancePaymentPosition" ], "summary": "FinancePaymentPosition: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePaymentPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePaymentPosition_GetAll_C01EEA0F4C91", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePaymentPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePaymentPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePaymentPosition" } } } } } }, "post": { "tags": [ "FinancePaymentPosition" ], "summary": "FinancePaymentPosition: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePaymentPosition-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePaymentPosition_Post_E38EBCEF1A36", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePaymentPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePaymentPosition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePaymentPosition" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePaymentPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePaymentPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePaymentPosition" } } } } } }, "put": { "tags": [ "FinancePaymentPosition" ], "summary": "FinancePaymentPosition: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePaymentPosition-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePaymentPosition_Put_B52FB78F82A8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePaymentPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePaymentPosition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePaymentPosition" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePaymentPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePaymentPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePaymentPosition" } } } } } } }, "/api/FinancePaymentPosition/{id}/ExportToCsv": { "get": { "tags": [ "FinancePaymentPosition" ], "summary": "FinancePaymentPosition: ExportToCsv", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePaymentPosition-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePaymentPosition_ExportToCsv_F83B48E416C9", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/FinancePaymentPosition/{id}/ExportToXml": { "get": { "tags": [ "FinancePaymentPosition" ], "summary": "FinancePaymentPosition: ExportToXml", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePaymentPosition-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePaymentPosition_ExportToXml_1A3F96DDA9E4", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/FinancePaymentPosition/{id}/GetFinancePaymentPositionForCSV": { "get": { "tags": [ "FinancePaymentPosition" ], "summary": "FinancePaymentPosition: GetFinancePaymentPositionForCSV", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePaymentPosition-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePaymentPosition_GetFinancePaymentPositionForCSV_F2024B0AFE28", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW640_FinancePaymentPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW640_FinancePaymentPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW640_FinancePaymentPosition" } } } } } } }, "/api/FinancePaymentPosition/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "FinancePaymentPosition" ], "summary": "FinancePaymentPosition: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePaymentPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePaymentPosition_GetPageByValue_510446288C86", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinancePaymentPosition/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "FinancePaymentPosition" ], "summary": "FinancePaymentPosition: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePaymentPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePaymentPosition_GetPageByValue2_33E3A292FD03", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinancePaymentPosition/{Unmatched}/{PaymentId}/PageFromView": { "get": { "tags": [ "FinancePaymentPosition" ], "summary": "FinancePaymentPosition: GetPageFromView", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePaymentPosition-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePaymentPosition_GetPageFromView_057127BF33B0", "parameters": [ { "name": "Unmatched", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "PaymentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinancePaymentPosition/ClearFinancePaymentPosition": { "get": { "tags": [ "FinancePaymentPosition" ], "summary": "FinancePaymentPosition: ClearFinancePaymentPosition", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePaymentPosition-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePaymentPosition_ClearFinancePaymentPosition_D5A9CFCC9843", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/FinancePaymentPosition/CreatePayment": { "post": { "tags": [ "FinancePaymentPosition" ], "summary": "FinancePaymentPosition: CreatePayment", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePaymentPosition-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePaymentPosition_CreatePayment_30438DDA5812", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePaymentPosition_CreatePaymentRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePaymentPosition_CreatePaymentRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePaymentPosition_CreatePaymentRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocPostingErrorMessage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocPostingErrorMessage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocPostingErrorMessage" } } } } } } }, "/api/FinancePaymentPosition/DeleteByFilter": { "post": { "tags": [ "FinancePaymentPosition" ], "summary": "FinancePaymentPosition: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePaymentPosition-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePaymentPosition_DeleteByFilter_C6D2F33E19DA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/FinancePaymentPosition/GetAllByValue": { "post": { "tags": [ "FinancePaymentPosition" ], "summary": "FinancePaymentPosition: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePaymentPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePaymentPosition_GetAllByValue_3B60BDCB50D9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePaymentPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePaymentPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePaymentPosition" } } } } } } }, "/api/FinancePaymentPosition/GetAllGraphByValue": { "post": { "tags": [ "FinancePaymentPosition" ], "summary": "FinancePaymentPosition: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePaymentPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePaymentPosition_GetAllGraphByValue_FA492E662462", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePaymentPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePaymentPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePaymentPosition" } } } } } } }, "/api/FinancePaymentPosition/GetByValue": { "post": { "tags": [ "FinancePaymentPosition" ], "summary": "FinancePaymentPosition: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePaymentPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePaymentPosition_GetByValue_392538783D33", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePaymentPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePaymentPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePaymentPosition" } } } } } } }, "/api/FinancePaymentPosition/GetLookup": { "post": { "tags": [ "FinancePaymentPosition" ], "summary": "FinancePaymentPosition: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePaymentPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePaymentPosition_GetLookup_B6EED09EA0C8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinancePaymentPosition/GetLookupByValue": { "post": { "tags": [ "FinancePaymentPosition" ], "summary": "FinancePaymentPosition: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePaymentPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePaymentPosition_GetLookupByValue_16CB8F511E73", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinancePaymentPosition/Page": { "get": { "tags": [ "FinancePaymentPosition" ], "summary": "FinancePaymentPosition: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePaymentPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePaymentPosition_GetPage_AFA974659237", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinancePaymentPosition/PageAsc": { "get": { "tags": [ "FinancePaymentPosition" ], "summary": "FinancePaymentPosition: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePaymentPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePaymentPosition_GetPageAsc_557E498C1FB8", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinancePaymentPosition/RunWizard": { "post": { "tags": [ "FinancePaymentPosition" ], "summary": "FinancePaymentPosition: RunWizard", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePaymentPosition-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePaymentPosition_RunWizard_DEA595A5C71F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePaymentPosition_RunWizardRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePaymentPosition_RunWizardRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePaymentPosition_RunWizardRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/FinancePaymentPosition/SearchByValue": { "post": { "tags": [ "FinancePaymentPosition" ], "summary": "FinancePaymentPosition: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePaymentPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePaymentPosition_SearchByValue_08B66F596D16", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinancePaymentPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinancePaymentPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinancePaymentPosition" } } } } } } }, "/api/FinancePaymentPosition/Sproc_UpdateField": { "put": { "tags": [ "FinancePaymentPosition" ], "summary": "FinancePaymentPosition: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePaymentPosition-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePaymentPosition_Put_83F4047E859F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePaymentPosition_Sproc_UpdateField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePaymentPosition_Sproc_UpdateField" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePaymentPosition_Sproc_UpdateField" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePaymentPosition_Sproc_UpdateField" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePaymentPosition_Sproc_UpdateField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePaymentPosition_Sproc_UpdateField" } } } } } } }, "/api/FinancePaymentPosition/TryGetByValue": { "post": { "tags": [ "FinancePaymentPosition" ], "summary": "FinancePaymentPosition: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePaymentPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePaymentPosition_TryGetByValue_EDF29A28EA9A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePaymentPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePaymentPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePaymentPosition" } } } } } } }, "/api/FinancePaymentPosition/UpsertGraph": { "put": { "tags": [ "FinancePaymentPosition" ], "summary": "FinancePaymentPosition: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePaymentPosition-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePaymentPosition_UpsertGraph_625C48716458", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePaymentPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePaymentPosition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePaymentPosition" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePaymentPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePaymentPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePaymentPosition" } } } } } } }, "/api/FinancePaymentPosition/UpsertGraphWithExtraFields": { "put": { "tags": [ "FinancePaymentPosition" ], "summary": "FinancePaymentPosition: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePaymentPosition-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePaymentPosition_UpsertGraphWithExtraFields_39201DFB685E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePaymentPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePaymentPosition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePaymentPosition" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePaymentPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePaymentPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePaymentPosition" } } } } } } }, "/api/FinancePosting": { "get": { "tags": [ "FinancePosting" ], "summary": "FinancePosting: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePosting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePosting_GetAll_3A4F07024258", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePosting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePosting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePosting" } } } } } }, "post": { "tags": [ "FinancePosting" ], "summary": "FinancePosting: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePosting-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePosting_Post_2B91F91898B9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePosting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePosting" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePosting" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePosting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePosting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePosting" } } } } } }, "put": { "tags": [ "FinancePosting" ], "summary": "FinancePosting: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePosting-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePosting_Put_8AD911F51278", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePosting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePosting" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePosting" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePosting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePosting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePosting" } } } } } } }, "/api/FinancePosting/{AccountId}/PageFromViewByAccountId": { "get": { "tags": [ "FinancePosting" ], "summary": "FinancePosting: GetPageFromViewByAccountId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePosting-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePosting_GetPageFromViewByAccountId_7D1BD8EA4286", "parameters": [ { "name": "AccountId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinancePosting/{AccountId}/PageFromViewUnassignedByAccountId": { "get": { "tags": [ "FinancePosting" ], "summary": "FinancePosting: GetPageFromViewUnassignedByAccountId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePosting-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePosting_GetPageFromViewUnassignedByAccountId_3E9F5867D1E5", "parameters": [ { "name": "AccountId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinancePosting/{CostBearerId}/PageFromViewByCostBearerId": { "get": { "tags": [ "FinancePosting" ], "summary": "FinancePosting: GetPageFromViewByCostBearerId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePosting-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePosting_GetPageFromViewByCostBearerId_AE52E33A1F5E", "parameters": [ { "name": "CostBearerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinancePosting/{CostCenterId}/PageFromViewByCostCenterId": { "get": { "tags": [ "FinancePosting" ], "summary": "FinancePosting: GetPageFromViewByCostCenterId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePosting-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePosting_GetPageFromViewByCostCenterId_4D8939E9B5C3", "parameters": [ { "name": "CostCenterId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinancePosting/{CostTypeId}/PageFromViewByCostTypeId": { "get": { "tags": [ "FinancePosting" ], "summary": "FinancePosting: GetPageFromViewByCostTypeId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePosting-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePosting_GetPageFromViewByCostTypeId_CD85F80A9173", "parameters": [ { "name": "CostTypeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinancePosting/{FixedAssetId}/PageFromViewByFixedAssetId": { "get": { "tags": [ "FinancePosting" ], "summary": "FinancePosting: GetPageFromViewByFixedAssetId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePosting-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePosting_GetPageFromViewByFixedAssetId_42D0D6E2E97D", "parameters": [ { "name": "FixedAssetId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinancePosting/{PartnerId}/{PartnerTypeId}/PageFromViewByPartnerId": { "get": { "tags": [ "FinancePosting" ], "summary": "FinancePosting: GetPageFromViewByPartnerId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePosting-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePosting_GetPageFromViewByPartnerId_09B91E43B578", "parameters": [ { "name": "PartnerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PartnerTypeId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinancePosting/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "FinancePosting" ], "summary": "FinancePosting: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePosting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePosting_GetPageByValue_5D1F508E9AAE", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinancePosting/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "FinancePosting" ], "summary": "FinancePosting: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePosting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePosting_GetPageByValue2_2B8BAE7F8E72", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinancePosting/DeleteByFilter": { "post": { "tags": [ "FinancePosting" ], "summary": "FinancePosting: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePosting-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePosting_DeleteByFilter_D38898433F45", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/FinancePosting/GetAllByValue": { "post": { "tags": [ "FinancePosting" ], "summary": "FinancePosting: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePosting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePosting_GetAllByValue_F7BF95976CBC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePosting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePosting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePosting" } } } } } } }, "/api/FinancePosting/GetAllGraphByValue": { "post": { "tags": [ "FinancePosting" ], "summary": "FinancePosting: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePosting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePosting_GetAllGraphByValue_C4FD8E1334DE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePosting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePosting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePosting" } } } } } } }, "/api/FinancePosting/GetAttachmentCount": { "post": { "tags": [ "FinancePosting" ], "summary": "FinancePosting: GetAttachmentCount", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePosting-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePosting_GetAttachmentCount_D92A4AA8DFF5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePosting_GetAttachmentCountRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePosting_GetAttachmentCountRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePosting_GetAttachmentCountRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/FinancePosting/GetByValue": { "post": { "tags": [ "FinancePosting" ], "summary": "FinancePosting: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePosting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePosting_GetByValue_D98ACF78E030", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePosting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePosting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePosting" } } } } } } }, "/api/FinancePosting/GetLookup": { "post": { "tags": [ "FinancePosting" ], "summary": "FinancePosting: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePosting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePosting_GetLookup_8024C2972250", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinancePosting/GetLookupByValue": { "post": { "tags": [ "FinancePosting" ], "summary": "FinancePosting: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePosting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePosting_GetLookupByValue_D022FFCA75ED", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinancePosting/Page": { "get": { "tags": [ "FinancePosting" ], "summary": "FinancePosting: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePosting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePosting_GetPage_A954FA2EDE46", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinancePosting/PageAsc": { "get": { "tags": [ "FinancePosting" ], "summary": "FinancePosting: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePosting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePosting_GetPageAsc_109F2DDF5671", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinancePosting/PageFromView": { "get": { "tags": [ "FinancePosting" ], "summary": "FinancePosting: GetPageFromView", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePosting-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePosting_GetPageFromView_62E9F851553F", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinancePosting/PostingReversal": { "post": { "tags": [ "FinancePosting" ], "summary": "FinancePosting: PostingReversal", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePosting-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePosting_PostingReversal_A6486364EBB2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePosting_PostingReversalRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePosting_PostingReversalRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePosting_PostingReversalRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PostingReversalResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PostingReversalResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PostingReversalResult" } } } } } } }, "/api/FinancePosting/SearchByValue": { "post": { "tags": [ "FinancePosting" ], "summary": "FinancePosting: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePosting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePosting_SearchByValue_606C8B32A79B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinancePosting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinancePosting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinancePosting" } } } } } } }, "/api/FinancePosting/TryGetByValue": { "post": { "tags": [ "FinancePosting" ], "summary": "FinancePosting: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePosting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePosting_TryGetByValue_9E6AAED93BEF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePosting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePosting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePosting" } } } } } } }, "/api/FinancePosting/UpsertGraph": { "put": { "tags": [ "FinancePosting" ], "summary": "FinancePosting: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePosting-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePosting_UpsertGraph_0F6892DA162C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePosting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePosting" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePosting" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePosting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePosting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePosting" } } } } } } }, "/api/FinancePosting/UpsertGraphWithExtraFields": { "put": { "tags": [ "FinancePosting" ], "summary": "FinancePosting: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePosting-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePosting_UpsertGraphWithExtraFields_56F6AA87FA8C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePosting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePosting" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePosting" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePosting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePosting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePosting" } } } } } } }, "/api/FinancePostingDraft": { "get": { "tags": [ "FinancePostingDraft" ], "summary": "FinancePostingDraft: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingDraft-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingDraft_GetAll_33EE2D685246", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingDraft" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingDraft" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingDraft" } } } } } }, "post": { "tags": [ "FinancePostingDraft" ], "summary": "FinancePostingDraft: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingDraft-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingDraft_Post_5D1625573A74", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingDraft" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingDraft" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingDraft" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingDraft" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingDraft" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingDraft" } } } } } }, "put": { "tags": [ "FinancePostingDraft" ], "summary": "FinancePostingDraft: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingDraft-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingDraft_Put_6638F7D2B6E0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingDraft" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingDraft" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingDraft" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingDraft" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingDraft" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingDraft" } } } } } } }, "/api/FinancePostingDraft/{AccountId}/PageFromViewByAccountId": { "get": { "tags": [ "FinancePostingDraft" ], "summary": "FinancePostingDraft: GetPageFromViewByAccountId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingDraft-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingDraft_GetPageFromViewByAccountId_33E2F8E98FA8", "parameters": [ { "name": "AccountId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinancePostingDraft/{CostBearerId}/PageFromViewByCostBearerId": { "get": { "tags": [ "FinancePostingDraft" ], "summary": "FinancePostingDraft: GetPageFromViewByCostBearerId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingDraft-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingDraft_GetPageFromViewByCostBearerId_FFD89B7C1494", "parameters": [ { "name": "CostBearerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinancePostingDraft/{CostCenterId}/PageFromViewByCostCenterId": { "get": { "tags": [ "FinancePostingDraft" ], "summary": "FinancePostingDraft: GetPageFromViewByCostCenterId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingDraft-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingDraft_GetPageFromViewByCostCenterId_2C083186D9CB", "parameters": [ { "name": "CostCenterId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinancePostingDraft/{CostTypeId}/PageFromViewByCostTypeId": { "get": { "tags": [ "FinancePostingDraft" ], "summary": "FinancePostingDraft: GetPageFromViewByCostTypeId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingDraft-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingDraft_GetPageFromViewByCostTypeId_6F18BF085975", "parameters": [ { "name": "CostTypeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinancePostingDraft/{PartnerId}/{PartnerTypeId}/PageFromViewByPartnerId": { "get": { "tags": [ "FinancePostingDraft" ], "summary": "FinancePostingDraft: GetPageFromViewByPartnerId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingDraft-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingDraft_GetPageFromViewByPartnerId_A7D38E314EFA", "parameters": [ { "name": "PartnerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PartnerTypeId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinancePostingDraft/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "FinancePostingDraft" ], "summary": "FinancePostingDraft: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingDraft-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingDraft_GetPageByValue_BDCE50065256", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinancePostingDraft/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "FinancePostingDraft" ], "summary": "FinancePostingDraft: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingDraft-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingDraft_GetPageByValue2_4E5F11DDAAD1", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinancePostingDraft/CheckNegativeBalance": { "post": { "tags": [ "FinancePostingDraft" ], "summary": "FinancePostingDraft: CheckNegativeBalance", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingDraft-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingDraft_CheckNegativeBalance_608052F98A36", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingDraft_CheckNegativeBalanceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingDraft_CheckNegativeBalanceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingDraft_CheckNegativeBalanceRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingDraft_CheckNegativeBalanceResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingDraft_CheckNegativeBalanceResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingDraft_CheckNegativeBalanceResult" } } } } } } }, "/api/FinancePostingDraft/DeleteByFilter": { "post": { "tags": [ "FinancePostingDraft" ], "summary": "FinancePostingDraft: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingDraft-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingDraft_DeleteByFilter_D0AEDCB5FA3E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/FinancePostingDraft/GetAllByValue": { "post": { "tags": [ "FinancePostingDraft" ], "summary": "FinancePostingDraft: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingDraft-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingDraft_GetAllByValue_178BC5CFB470", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingDraft" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingDraft" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingDraft" } } } } } } }, "/api/FinancePostingDraft/GetAllGraphByValue": { "post": { "tags": [ "FinancePostingDraft" ], "summary": "FinancePostingDraft: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingDraft-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingDraft_GetAllGraphByValue_69C66D2CDCB9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingDraft" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingDraft" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingDraft" } } } } } } }, "/api/FinancePostingDraft/GetAttachmentCount": { "post": { "tags": [ "FinancePostingDraft" ], "summary": "FinancePostingDraft: GetAttachmentCount", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingDraft-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingDraft_GetAttachmentCount_E5F45A78DCC1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingDraft_GetAttachmentCountRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingDraft_GetAttachmentCountRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingDraft_GetAttachmentCountRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/FinancePostingDraft/GetByValue": { "post": { "tags": [ "FinancePostingDraft" ], "summary": "FinancePostingDraft: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingDraft-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingDraft_GetByValue_1D0F1032DDF4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingDraft" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingDraft" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingDraft" } } } } } } }, "/api/FinancePostingDraft/GetLookup": { "post": { "tags": [ "FinancePostingDraft" ], "summary": "FinancePostingDraft: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingDraft-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingDraft_GetLookup_1013952FE0C2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinancePostingDraft/GetLookupByValue": { "post": { "tags": [ "FinancePostingDraft" ], "summary": "FinancePostingDraft: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingDraft-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingDraft_GetLookupByValue_77EAACCE81BC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinancePostingDraft/Page": { "get": { "tags": [ "FinancePostingDraft" ], "summary": "FinancePostingDraft: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingDraft-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingDraft_GetPage_292C60AAD204", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinancePostingDraft/PageAsc": { "get": { "tags": [ "FinancePostingDraft" ], "summary": "FinancePostingDraft: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingDraft-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingDraft_GetPageAsc_7C8971717F90", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinancePostingDraft/PageFromView": { "get": { "tags": [ "FinancePostingDraft" ], "summary": "FinancePostingDraft: GetPageFromView", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingDraft-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingDraft_GetPageFromView_8A01747AE4E9", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinancePostingDraft/PostFinancePostingDraft": { "post": { "tags": [ "FinancePostingDraft" ], "summary": "FinancePostingDraft: PostFinancePostingDraft", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingDraft-Create.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingDraft_PostFinancePostingDraft_35476C26971E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingDraft_PostRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingDraft_PostRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingDraft_PostRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/FinancePostingDraft/PostingReversal": { "post": { "tags": [ "FinancePostingDraft" ], "summary": "FinancePostingDraft: PostingReversal", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingDraft-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingDraft_PostingReversal_8DAD022BDB5A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingDraft_PostingReversalRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingDraft_PostingReversalRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingDraft_PostingReversalRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PostingReversalResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PostingReversalResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PostingReversalResult" } } } } } } }, "/api/FinancePostingDraft/SearchByValue": { "post": { "tags": [ "FinancePostingDraft" ], "summary": "FinancePostingDraft: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingDraft-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingDraft_SearchByValue_BCF984F3EF4F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinancePostingDraft" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinancePostingDraft" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinancePostingDraft" } } } } } } }, "/api/FinancePostingDraft/SwapDebitCredit": { "post": { "tags": [ "FinancePostingDraft" ], "summary": "FinancePostingDraft: SwapDebitCredit", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingDraft-Read.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingDraft_SwapDebitCredit_2F9310A8A78E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingDraft_SwapDebitCreditRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingDraft_SwapDebitCreditRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingDraft_SwapDebitCreditRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/FinancePostingDraft/TryGetByValue": { "post": { "tags": [ "FinancePostingDraft" ], "summary": "FinancePostingDraft: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingDraft-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingDraft_TryGetByValue_4E7D64B32144", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingDraft" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingDraft" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingDraft" } } } } } } }, "/api/FinancePostingDraft/UpdatePostingDraft_DocNumber": { "post": { "tags": [ "FinancePostingDraft" ], "summary": "FinancePostingDraft: UpdatePostingDraft_DocNumber", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingDraft-Read.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingDraft_UpdatePostingDraft_DocNumber_D487EAED49FB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingDraft_UpdateDocNumberRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingDraft_UpdateDocNumberRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingDraft_UpdateDocNumberRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/FinancePostingDraft/UpdatePostingDraft_ForeignCurrencyId": { "post": { "tags": [ "FinancePostingDraft" ], "summary": "FinancePostingDraft: UpdatePostingDraft_ForeignCurrencyId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingDraft-Read.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingDraft_UpdatePostingDraft_ForeignCurrencyId_E7D9D90036CC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingDraft_UpdateForeignCurrencyIdRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingDraft_UpdateForeignCurrencyIdRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingDraft_UpdateForeignCurrencyIdRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/FinancePostingDraft/UpdatePostingDraft_Name": { "post": { "tags": [ "FinancePostingDraft" ], "summary": "FinancePostingDraft: UpdatePostingDraft_Name", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingDraft-Read.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingDraft_UpdatePostingDraft_Name_817D284B75FD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingDraft_UpdateNameRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingDraft_UpdateNameRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingDraft_UpdateNameRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/FinancePostingDraft/UpdatePostingDraft_PostingPeriodId": { "post": { "tags": [ "FinancePostingDraft" ], "summary": "FinancePostingDraft: UpdatePostingDraft_PostingPeriodId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingDraft-Read.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingDraft_UpdatePostingDraft_PostingPeriodId_4C94F6AFBF0F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingDraft_UpdatePostingPeriodIdRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingDraft_UpdatePostingPeriodIdRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingDraft_UpdatePostingPeriodIdRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/FinancePostingDraft/UpdatePostingDraft_Rate": { "post": { "tags": [ "FinancePostingDraft" ], "summary": "FinancePostingDraft: UpdatePostingDraft_Rate", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingDraft-Read.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingDraft_UpdatePostingDraft_Rate_EB5100365523", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingDraft_UpdateRateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingDraft_UpdateRateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingDraft_UpdateRateRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/FinancePostingDraft/UpdatePostingDraft_ReceiptDate": { "post": { "tags": [ "FinancePostingDraft" ], "summary": "FinancePostingDraft: UpdatePostingDraft_ReceiptDate", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingDraft-Read.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingDraft_UpdatePostingDraft_ReceiptDate_F99856E76BC1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingDraft_UpdateReceiptDateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingDraft_UpdateReceiptDateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingDraft_UpdateReceiptDateRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/FinancePostingDraft/UpdatePostingDraft_ReceiptNumber": { "post": { "tags": [ "FinancePostingDraft" ], "summary": "FinancePostingDraft: UpdatePostingDraft_ReceiptNumber", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingDraft-Read.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingDraft_UpdatePostingDraft_ReceiptNumber_8C7073E88873", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingDraft_UpdateReceiptNumberRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingDraft_UpdateReceiptNumberRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingDraft_UpdateReceiptNumberRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/FinancePostingDraft/UpdatePostingDraft_Subject": { "post": { "tags": [ "FinancePostingDraft" ], "summary": "FinancePostingDraft: UpdatePostingDraft_Subject", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingDraft-Read.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingDraft_UpdatePostingDraft_Subject_CE51C139DF6E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingDraft_UpdateSubjectRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingDraft_UpdateSubjectRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingDraft_UpdateSubjectRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/FinancePostingDraft/UpsertGraph": { "put": { "tags": [ "FinancePostingDraft" ], "summary": "FinancePostingDraft: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingDraft-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingDraft_UpsertGraph_E17F18D02E7A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingDraft" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingDraft" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingDraft" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingDraft" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingDraft" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingDraft" } } } } } } }, "/api/FinancePostingDraft/UpsertGraphWithExtraFields": { "put": { "tags": [ "FinancePostingDraft" ], "summary": "FinancePostingDraft: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingDraft-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingDraft_UpsertGraphWithExtraFields_49A1F67DC434", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePostingDraft" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePostingDraft" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePostingDraft" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePostingDraft" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePostingDraft" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePostingDraft" } } } } } } }, "/api/FinancePostingPeriod": { "get": { "tags": [ "FinancePostingPeriod" ], "summary": "FinancePostingPeriod: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPeriod-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPeriod_GetAll_152F31792F25", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingPeriod" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingPeriod" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingPeriod" } } } } } }, "post": { "tags": [ "FinancePostingPeriod" ], "summary": "FinancePostingPeriod: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPeriod-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPeriod_Post_63A79BDCD8A4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPeriod" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPeriod" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPeriod" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingPeriod" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingPeriod" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingPeriod" } } } } } }, "put": { "tags": [ "FinancePostingPeriod" ], "summary": "FinancePostingPeriod: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPeriod-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPeriod_Put_3E517392BD8D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPeriod" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPeriod" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPeriod" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingPeriod" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingPeriod" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingPeriod" } } } } } } }, "/api/FinancePostingPeriod/{FiscalYearId}/{FiscalPeriodId}/{CalendarYearId}/{CalendarMonthId}/{NumberOfPeriods}/RunWizard": { "get": { "tags": [ "FinancePostingPeriod" ], "summary": "FinancePostingPeriod: RunWizard", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPeriod-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPeriod_RunWizard_8C639ABFC0BE", "parameters": [ { "name": "FiscalYearId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "FiscalPeriodId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "CalendarYearId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "CalendarMonthId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "NumberOfPeriods", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/FinancePostingPeriod/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "FinancePostingPeriod" ], "summary": "FinancePostingPeriod: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPeriod-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPeriod_GetPageByValue_93BF7BEA8CE3", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinancePostingPeriod/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "FinancePostingPeriod" ], "summary": "FinancePostingPeriod: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPeriod-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPeriod_GetPageByValue2_A01A14F41E64", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinancePostingPeriod/DeleteByFilter": { "post": { "tags": [ "FinancePostingPeriod" ], "summary": "FinancePostingPeriod: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPeriod-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPeriod_DeleteByFilter_BE1FF45C6AD7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/FinancePostingPeriod/GetAllByValue": { "post": { "tags": [ "FinancePostingPeriod" ], "summary": "FinancePostingPeriod: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPeriod-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPeriod_GetAllByValue_4612A878C876", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingPeriod" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingPeriod" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingPeriod" } } } } } } }, "/api/FinancePostingPeriod/GetAllGraphByValue": { "post": { "tags": [ "FinancePostingPeriod" ], "summary": "FinancePostingPeriod: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPeriod-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPeriod_GetAllGraphByValue_3D62A9D0A2A7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingPeriod" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingPeriod" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingPeriod" } } } } } } }, "/api/FinancePostingPeriod/GetByValue": { "post": { "tags": [ "FinancePostingPeriod" ], "summary": "FinancePostingPeriod: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPeriod-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPeriod_GetByValue_D3F3AE5D95E4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingPeriod" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingPeriod" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingPeriod" } } } } } } }, "/api/FinancePostingPeriod/GetFinancePostingPeriodForToday": { "get": { "tags": [ "FinancePostingPeriod" ], "summary": "FinancePostingPeriod: GetFinancePostingPeriodForToday", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPeriod-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPeriod_GetFinancePostingPeriodForToday_2F44C05A5F13", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingPeriod" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingPeriod" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingPeriod" } } } } } } }, "/api/FinancePostingPeriod/GetLookup": { "post": { "tags": [ "FinancePostingPeriod" ], "summary": "FinancePostingPeriod: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPeriod-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPeriod_GetLookup_EFA95F0AE541", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinancePostingPeriod/GetLookupByValue": { "post": { "tags": [ "FinancePostingPeriod" ], "summary": "FinancePostingPeriod: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPeriod-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPeriod_GetLookupByValue_D03E2A24F08C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinancePostingPeriod/Page": { "get": { "tags": [ "FinancePostingPeriod" ], "summary": "FinancePostingPeriod: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPeriod-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPeriod_GetPage_11ED37DFD712", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinancePostingPeriod/PageAsc": { "get": { "tags": [ "FinancePostingPeriod" ], "summary": "FinancePostingPeriod: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPeriod-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPeriod_GetPageAsc_DCCF24389398", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinancePostingPeriod/SearchByValue": { "post": { "tags": [ "FinancePostingPeriod" ], "summary": "FinancePostingPeriod: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPeriod-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPeriod_SearchByValue_DAC8171FAA02", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinancePostingPeriod" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinancePostingPeriod" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinancePostingPeriod" } } } } } } }, "/api/FinancePostingPeriod/TryGetByValue": { "post": { "tags": [ "FinancePostingPeriod" ], "summary": "FinancePostingPeriod: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPeriod-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPeriod_TryGetByValue_819874A7EF2B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingPeriod" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingPeriod" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingPeriod" } } } } } } }, "/api/FinancePostingPeriod/UpsertGraph": { "put": { "tags": [ "FinancePostingPeriod" ], "summary": "FinancePostingPeriod: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPeriod-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPeriod_UpsertGraph_AC4880E3A6E6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPeriod" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPeriod" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPeriod" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingPeriod" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingPeriod" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingPeriod" } } } } } } }, "/api/FinancePostingPeriod/UpsertGraphWithExtraFields": { "put": { "tags": [ "FinancePostingPeriod" ], "summary": "FinancePostingPeriod: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPeriod-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPeriod_UpsertGraphWithExtraFields_BC82054C0D8B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePostingPeriod" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePostingPeriod" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePostingPeriod" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePostingPeriod" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePostingPeriod" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePostingPeriod" } } } } } } }, "/api/FinancePostingPeriodStatus": { "get": { "tags": [ "FinancePostingPeriodStatus" ], "summary": "FinancePostingPeriodStatus: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPeriodStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPeriodStatus_GetAll_15F34F9C5632", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingPeriodStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingPeriodStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingPeriodStatus" } } } } } }, "post": { "tags": [ "FinancePostingPeriodStatus" ], "summary": "FinancePostingPeriodStatus: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPeriodStatus-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPeriodStatus_Post_DEFD7B2DF1E0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPeriodStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPeriodStatus" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPeriodStatus" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingPeriodStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingPeriodStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingPeriodStatus" } } } } } }, "put": { "tags": [ "FinancePostingPeriodStatus" ], "summary": "FinancePostingPeriodStatus: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPeriodStatus-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPeriodStatus_Put_3504B6D73D38", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPeriodStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPeriodStatus" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPeriodStatus" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingPeriodStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingPeriodStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingPeriodStatus" } } } } } } }, "/api/FinancePostingPeriodStatus/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "FinancePostingPeriodStatus" ], "summary": "FinancePostingPeriodStatus: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPeriodStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPeriodStatus_GetPageByValue_E5B73D903C43", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinancePostingPeriodStatus/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "FinancePostingPeriodStatus" ], "summary": "FinancePostingPeriodStatus: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPeriodStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPeriodStatus_GetPageByValue2_D338204337C3", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinancePostingPeriodStatus/DeleteByFilter": { "post": { "tags": [ "FinancePostingPeriodStatus" ], "summary": "FinancePostingPeriodStatus: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPeriodStatus-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPeriodStatus_DeleteByFilter_2B7B5FBE4E44", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/FinancePostingPeriodStatus/GetAllByValue": { "post": { "tags": [ "FinancePostingPeriodStatus" ], "summary": "FinancePostingPeriodStatus: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPeriodStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPeriodStatus_GetAllByValue_287F0282ADC4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingPeriodStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingPeriodStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingPeriodStatus" } } } } } } }, "/api/FinancePostingPeriodStatus/GetAllGraphByValue": { "post": { "tags": [ "FinancePostingPeriodStatus" ], "summary": "FinancePostingPeriodStatus: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPeriodStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPeriodStatus_GetAllGraphByValue_A5F66A741EBB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingPeriodStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingPeriodStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingPeriodStatus" } } } } } } }, "/api/FinancePostingPeriodStatus/GetByValue": { "post": { "tags": [ "FinancePostingPeriodStatus" ], "summary": "FinancePostingPeriodStatus: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPeriodStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPeriodStatus_GetByValue_650249999424", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingPeriodStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingPeriodStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingPeriodStatus" } } } } } } }, "/api/FinancePostingPeriodStatus/GetLookup": { "post": { "tags": [ "FinancePostingPeriodStatus" ], "summary": "FinancePostingPeriodStatus: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPeriodStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPeriodStatus_GetLookup_30DC16B82504", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinancePostingPeriodStatus/GetLookupByValue": { "post": { "tags": [ "FinancePostingPeriodStatus" ], "summary": "FinancePostingPeriodStatus: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPeriodStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPeriodStatus_GetLookupByValue_2B7E8BE6B5C8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinancePostingPeriodStatus/Page": { "get": { "tags": [ "FinancePostingPeriodStatus" ], "summary": "FinancePostingPeriodStatus: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPeriodStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPeriodStatus_GetPage_11A44108D574", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinancePostingPeriodStatus/PageAsc": { "get": { "tags": [ "FinancePostingPeriodStatus" ], "summary": "FinancePostingPeriodStatus: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPeriodStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPeriodStatus_GetPageAsc_EBC9B8F2D2CD", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinancePostingPeriodStatus/SearchByValue": { "post": { "tags": [ "FinancePostingPeriodStatus" ], "summary": "FinancePostingPeriodStatus: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPeriodStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPeriodStatus_SearchByValue_6EC2F717CF69", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinancePostingPeriodStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinancePostingPeriodStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinancePostingPeriodStatus" } } } } } } }, "/api/FinancePostingPeriodStatus/TryGetByValue": { "post": { "tags": [ "FinancePostingPeriodStatus" ], "summary": "FinancePostingPeriodStatus: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPeriodStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPeriodStatus_TryGetByValue_ECC4A34F6567", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingPeriodStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingPeriodStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingPeriodStatus" } } } } } } }, "/api/FinancePostingPeriodStatus/UpsertGraph": { "put": { "tags": [ "FinancePostingPeriodStatus" ], "summary": "FinancePostingPeriodStatus: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPeriodStatus-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPeriodStatus_UpsertGraph_331288711909", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPeriodStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPeriodStatus" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPeriodStatus" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingPeriodStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingPeriodStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingPeriodStatus" } } } } } } }, "/api/FinancePostingPeriodStatus/UpsertGraphWithExtraFields": { "put": { "tags": [ "FinancePostingPeriodStatus" ], "summary": "FinancePostingPeriodStatus: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPeriodStatus-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPeriodStatus_UpsertGraphWithExtraFields_2D48A2FBF111", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePostingPeriodStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePostingPeriodStatus" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePostingPeriodStatus" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePostingPeriodStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePostingPeriodStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePostingPeriodStatus" } } } } } } }, "/api/FinancePostingPosition": { "get": { "tags": [ "FinancePostingPosition" ], "summary": "FinancePostingPosition: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPosition_GetAll_5038163A24FB", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingPosition" } } } } } }, "post": { "tags": [ "FinancePostingPosition" ], "summary": "FinancePostingPosition: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPosition-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPosition_Post_5DE77908D410", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPosition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPosition" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingPosition" } } } } } }, "put": { "tags": [ "FinancePostingPosition" ], "summary": "FinancePostingPosition: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPosition-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPosition_Put_5BD422DB54D5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPosition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPosition" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingPosition" } } } } } } }, "/api/FinancePostingPosition/{AccountId}/{OpenAmountNotZero}/PageFromView": { "get": { "tags": [ "FinancePostingPosition" ], "summary": "FinancePostingPosition: GetPageFromView", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPosition-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPosition_GetPageFromView_F32390BD6646", "parameters": [ { "name": "AccountId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "OpenAmountNotZero", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinancePostingPosition/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "FinancePostingPosition" ], "summary": "FinancePostingPosition: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPosition_GetPageByValue_6ABB45EC2D1C", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinancePostingPosition/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "FinancePostingPosition" ], "summary": "FinancePostingPosition: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPosition_GetPageByValue2_9064CC77731B", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinancePostingPosition/DeleteByFilter": { "post": { "tags": [ "FinancePostingPosition" ], "summary": "FinancePostingPosition: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPosition-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPosition_DeleteByFilter_6F4F48942EB8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/FinancePostingPosition/GetAllByValue": { "post": { "tags": [ "FinancePostingPosition" ], "summary": "FinancePostingPosition: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPosition_GetAllByValue_E8BE4E808B86", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingPosition" } } } } } } }, "/api/FinancePostingPosition/GetAllGraphByValue": { "post": { "tags": [ "FinancePostingPosition" ], "summary": "FinancePostingPosition: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPosition_GetAllGraphByValue_8139AC692718", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingPosition" } } } } } } }, "/api/FinancePostingPosition/GetByValue": { "post": { "tags": [ "FinancePostingPosition" ], "summary": "FinancePostingPosition: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPosition_GetByValue_241389BC5C15", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingPosition" } } } } } } }, "/api/FinancePostingPosition/GetLookup": { "post": { "tags": [ "FinancePostingPosition" ], "summary": "FinancePostingPosition: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPosition_GetLookup_7159A688BD94", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinancePostingPosition/GetLookupByValue": { "post": { "tags": [ "FinancePostingPosition" ], "summary": "FinancePostingPosition: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPosition_GetLookupByValue_153F0527475A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinancePostingPosition/Page": { "get": { "tags": [ "FinancePostingPosition" ], "summary": "FinancePostingPosition: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPosition_GetPage_7EAA40086D86", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinancePostingPosition/PageAsc": { "get": { "tags": [ "FinancePostingPosition" ], "summary": "FinancePostingPosition: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPosition_GetPageAsc_14E7C001966D", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinancePostingPosition/SearchByValue": { "post": { "tags": [ "FinancePostingPosition" ], "summary": "FinancePostingPosition: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPosition_SearchByValue_D0CB32F42AC2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinancePostingPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinancePostingPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinancePostingPosition" } } } } } } }, "/api/FinancePostingPosition/TryGetByValue": { "post": { "tags": [ "FinancePostingPosition" ], "summary": "FinancePostingPosition: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPosition_TryGetByValue_C19FF984D65E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingPosition" } } } } } } }, "/api/FinancePostingPosition/UpsertGraph": { "put": { "tags": [ "FinancePostingPosition" ], "summary": "FinancePostingPosition: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPosition-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPosition_UpsertGraph_7E685869C87A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPosition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPosition" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingPosition" } } } } } } }, "/api/FinancePostingPosition/UpsertGraphWithExtraFields": { "put": { "tags": [ "FinancePostingPosition" ], "summary": "FinancePostingPosition: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPosition-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPosition_UpsertGraphWithExtraFields_1165B3733EB9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePostingPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePostingPosition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePostingPosition" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePostingPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePostingPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePostingPosition" } } } } } } }, "/api/FinancePostingPositionDraft": { "get": { "tags": [ "FinancePostingPositionDraft" ], "summary": "FinancePostingPositionDraft: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPositionDraft-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPositionDraft_GetAll_48CB489960C2", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingPositionDraft" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingPositionDraft" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingPositionDraft" } } } } } }, "post": { "tags": [ "FinancePostingPositionDraft" ], "summary": "FinancePostingPositionDraft: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPositionDraft-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPositionDraft_Post_A2AD0B7098A8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionDraft" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionDraft" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionDraft" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingPositionDraft" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingPositionDraft" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingPositionDraft" } } } } } }, "put": { "tags": [ "FinancePostingPositionDraft" ], "summary": "FinancePostingPositionDraft: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPositionDraft-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPositionDraft_Put_5233446E494A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionDraft" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionDraft" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionDraft" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingPositionDraft" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingPositionDraft" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingPositionDraft" } } } } } } }, "/api/FinancePostingPositionDraft/{AccountId}/{OpenAmountNotZero}/PageFromView": { "get": { "tags": [ "FinancePostingPositionDraft" ], "summary": "FinancePostingPositionDraft: GetPageFromView", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPositionDraft-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPositionDraft_GetPageFromView_53C792369DB5", "parameters": [ { "name": "AccountId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "OpenAmountNotZero", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinancePostingPositionDraft/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "FinancePostingPositionDraft" ], "summary": "FinancePostingPositionDraft: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPositionDraft-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPositionDraft_GetPageByValue_6B139841B9E9", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinancePostingPositionDraft/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "FinancePostingPositionDraft" ], "summary": "FinancePostingPositionDraft: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPositionDraft-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPositionDraft_GetPageByValue2_424196B3003E", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinancePostingPositionDraft/AddPositionDraft_GeneralLedgerAccount": { "post": { "tags": [ "FinancePostingPositionDraft" ], "summary": "FinancePostingPositionDraft: AddPositionDraft_GeneralLedgerAccount", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPositionDraft-Read.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPositionDraft_AddPositionDraft_GeneralLedgerAccount_82F447EDB088", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionDraft_AddGeneralLedgerAccountRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionDraft_AddGeneralLedgerAccountRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionDraft_AddGeneralLedgerAccountRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/FinancePostingPositionDraft/AddPositionDraft_PersonalAccount": { "post": { "tags": [ "FinancePostingPositionDraft" ], "summary": "FinancePostingPositionDraft: AddPositionDraft_PersonalAccount", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPositionDraft-Read.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPositionDraft_AddPositionDraft_PersonalAccount_05002AD14BE1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionDraft_AddPersonalAccountRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionDraft_AddPersonalAccountRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionDraft_AddPersonalAccountRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/FinancePostingPositionDraft/DeleteByFilter": { "post": { "tags": [ "FinancePostingPositionDraft" ], "summary": "FinancePostingPositionDraft: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPositionDraft-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPositionDraft_DeleteByFilter_20A64A0A7C3D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/FinancePostingPositionDraft/DeletePositionDraft": { "post": { "tags": [ "FinancePostingPositionDraft" ], "summary": "FinancePostingPositionDraft: DeletePositionDraft", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPositionDraft-Read.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPositionDraft_DeletePositionDraft_D5DE53BD688A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionDraft_DeleteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionDraft_DeleteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionDraft_DeleteRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/FinancePostingPositionDraft/GetAllByValue": { "post": { "tags": [ "FinancePostingPositionDraft" ], "summary": "FinancePostingPositionDraft: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPositionDraft-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPositionDraft_GetAllByValue_0EC7FD5A5CF8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingPositionDraft" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingPositionDraft" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingPositionDraft" } } } } } } }, "/api/FinancePostingPositionDraft/GetAllGraphByValue": { "post": { "tags": [ "FinancePostingPositionDraft" ], "summary": "FinancePostingPositionDraft: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPositionDraft-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPositionDraft_GetAllGraphByValue_AAF77DBBFF8A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingPositionDraft" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingPositionDraft" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingPositionDraft" } } } } } } }, "/api/FinancePostingPositionDraft/GetByValue": { "post": { "tags": [ "FinancePostingPositionDraft" ], "summary": "FinancePostingPositionDraft: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPositionDraft-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPositionDraft_GetByValue_A73DB91B31C0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingPositionDraft" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingPositionDraft" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingPositionDraft" } } } } } } }, "/api/FinancePostingPositionDraft/GetLookup": { "post": { "tags": [ "FinancePostingPositionDraft" ], "summary": "FinancePostingPositionDraft: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPositionDraft-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPositionDraft_GetLookup_02C8E3EFE5CA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinancePostingPositionDraft/GetLookupByValue": { "post": { "tags": [ "FinancePostingPositionDraft" ], "summary": "FinancePostingPositionDraft: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPositionDraft-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPositionDraft_GetLookupByValue_F57BC378781B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinancePostingPositionDraft/Page": { "get": { "tags": [ "FinancePostingPositionDraft" ], "summary": "FinancePostingPositionDraft: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPositionDraft-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPositionDraft_GetPage_229BB9457ABC", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinancePostingPositionDraft/PageAsc": { "get": { "tags": [ "FinancePostingPositionDraft" ], "summary": "FinancePostingPositionDraft: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPositionDraft-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPositionDraft_GetPageAsc_ADE9998CA69B", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinancePostingPositionDraft/SearchByValue": { "post": { "tags": [ "FinancePostingPositionDraft" ], "summary": "FinancePostingPositionDraft: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPositionDraft-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPositionDraft_SearchByValue_E1D4963C8AA3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinancePostingPositionDraft" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinancePostingPositionDraft" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinancePostingPositionDraft" } } } } } } }, "/api/FinancePostingPositionDraft/TryGetByValue": { "post": { "tags": [ "FinancePostingPositionDraft" ], "summary": "FinancePostingPositionDraft: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPositionDraft-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPositionDraft_TryGetByValue_90B17EC19262", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingPositionDraft" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingPositionDraft" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingPositionDraft" } } } } } } }, "/api/FinancePostingPositionDraft/UpdatePositionDraft_CostBearerId": { "post": { "tags": [ "FinancePostingPositionDraft" ], "summary": "FinancePostingPositionDraft: UpdatePositionDraft_CostBearerId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPositionDraft-Read.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPositionDraft_UpdatePositionDraft_CostBearerId_B2800F2F60DE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionDraft_UpdateCostBearerIdRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionDraft_UpdateCostBearerIdRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionDraft_UpdateCostBearerIdRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/FinancePostingPositionDraft/UpdatePositionDraft_CostCenterId": { "post": { "tags": [ "FinancePostingPositionDraft" ], "summary": "FinancePostingPositionDraft: UpdatePositionDraft_CostCenterId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPositionDraft-Read.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPositionDraft_UpdatePositionDraft_CostCenterId_25452864E450", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionDraft_UpdateCostCenterIdRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionDraft_UpdateCostCenterIdRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionDraft_UpdateCostCenterIdRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/FinancePostingPositionDraft/UpdatePositionDraft_Credit": { "post": { "tags": [ "FinancePostingPositionDraft" ], "summary": "FinancePostingPositionDraft: UpdatePositionDraft_Credit", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPositionDraft-Read.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPositionDraft_UpdatePositionDraft_Credit_0C8F3A0CDAA8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionDraft_UpdateCreditRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionDraft_UpdateCreditRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionDraft_UpdateCreditRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/FinancePostingPositionDraft/UpdatePositionDraft_Debit": { "post": { "tags": [ "FinancePostingPositionDraft" ], "summary": "FinancePostingPositionDraft: UpdatePositionDraft_Debit", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPositionDraft-Read.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPositionDraft_UpdatePositionDraft_Debit_19E614A3260A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionDraft_UpdateDebitRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionDraft_UpdateDebitRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionDraft_UpdateDebitRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/FinancePostingPositionDraft/UpdatePositionDraft_ForeignCurrencyCredit": { "post": { "tags": [ "FinancePostingPositionDraft" ], "summary": "FinancePostingPositionDraft: UpdatePositionDraft_ForeignCurrencyCredit", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPositionDraft-Read.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPositionDraft_UpdatePositionDraft_ForeignCurrencyCredit_AF290F504DD9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionDraft_UpdateForeignCurrencyCreditRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionDraft_UpdateForeignCurrencyCreditRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionDraft_UpdateForeignCurrencyCreditRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/FinancePostingPositionDraft/UpdatePositionDraft_ForeignCurrencyDebit": { "post": { "tags": [ "FinancePostingPositionDraft" ], "summary": "FinancePostingPositionDraft: UpdatePositionDraft_ForeignCurrencyDebit", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPositionDraft-Read.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPositionDraft_UpdatePositionDraft_ForeignCurrencyDebit_7D168884E27B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionDraft_UpdateForeignCurrencyDebitRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionDraft_UpdateForeignCurrencyDebitRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionDraft_UpdateForeignCurrencyDebitRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/FinancePostingPositionDraft/UpdatePositionDraft_ForeignCurrencyGrossValue": { "post": { "tags": [ "FinancePostingPositionDraft" ], "summary": "FinancePostingPositionDraft: UpdatePositionDraft_ForeignCurrencyGrossValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPositionDraft-Read.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPositionDraft_UpdatePositionDraft_ForeignCurrencyGrossValue_F1298B463F05", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionDraft_UpdateForeignCurrencyGrossValueRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionDraft_UpdateForeignCurrencyGrossValueRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionDraft_UpdateForeignCurrencyGrossValueRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/FinancePostingPositionDraft/UpdatePositionDraft_GrossValue": { "post": { "tags": [ "FinancePostingPositionDraft" ], "summary": "FinancePostingPositionDraft: UpdatePositionDraft_GrossValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPositionDraft-Read.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPositionDraft_UpdatePositionDraft_GrossValue_29A062A6647F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionDraft_UpdateGrossValueRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionDraft_UpdateGrossValueRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionDraft_UpdateGrossValueRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/FinancePostingPositionDraft/UpdatePositionDraft_ProjectId": { "post": { "tags": [ "FinancePostingPositionDraft" ], "summary": "FinancePostingPositionDraft: UpdatePositionDraft_ProjectId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPositionDraft-Read.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPositionDraft_UpdatePositionDraft_ProjectId_AA384EF378E6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionDraft_UpdateProjectIdRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionDraft_UpdateProjectIdRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionDraft_UpdateProjectIdRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/FinancePostingPositionDraft/UpdatePositionDraft_TaxKeyId": { "post": { "tags": [ "FinancePostingPositionDraft" ], "summary": "FinancePostingPositionDraft: UpdatePositionDraft_TaxKeyId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPositionDraft-Read.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPositionDraft_UpdatePositionDraft_TaxKeyId_8E14B8D1C259", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionDraft_UpdateTaxKeyIdRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionDraft_UpdateTaxKeyIdRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionDraft_UpdateTaxKeyIdRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/FinancePostingPositionDraft/UpdatePositionDraft_VatNumber": { "post": { "tags": [ "FinancePostingPositionDraft" ], "summary": "FinancePostingPositionDraft: UpdatePositionDraft_VatNumber", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPositionDraft-Read.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPositionDraft_UpdatePositionDraft_VatNumber_EE208691A5D9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionDraft_UpdateVatNumberRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionDraft_UpdateVatNumberRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionDraft_UpdateVatNumberRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/FinancePostingPositionDraft/UpsertGraph": { "put": { "tags": [ "FinancePostingPositionDraft" ], "summary": "FinancePostingPositionDraft: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPositionDraft-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPositionDraft_UpsertGraph_B0197770D366", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionDraft" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionDraft" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionDraft" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingPositionDraft" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingPositionDraft" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingPositionDraft" } } } } } } }, "/api/FinancePostingPositionDraft/UpsertGraphWithExtraFields": { "put": { "tags": [ "FinancePostingPositionDraft" ], "summary": "FinancePostingPositionDraft: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPositionDraft-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPositionDraft_UpsertGraphWithExtraFields_F058648066F8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePostingPositionDraft" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePostingPositionDraft" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePostingPositionDraft" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePostingPositionDraft" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePostingPositionDraft" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePostingPositionDraft" } } } } } } }, "/api/FinancePostingPositionTemplate": { "get": { "tags": [ "FinancePostingPositionTemplate" ], "summary": "FinancePostingPositionTemplate: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPositionTemplate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPositionTemplate_GetAll_319DA24275CD", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingPositionTemplate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingPositionTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingPositionTemplate" } } } } } }, "post": { "tags": [ "FinancePostingPositionTemplate" ], "summary": "FinancePostingPositionTemplate: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPositionTemplate-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPositionTemplate_Post_A0AE25B4A110", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionTemplate" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionTemplate" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingPositionTemplate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingPositionTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingPositionTemplate" } } } } } }, "put": { "tags": [ "FinancePostingPositionTemplate" ], "summary": "FinancePostingPositionTemplate: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPositionTemplate-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPositionTemplate_Put_EEEF36D64F44", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionTemplate" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionTemplate" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingPositionTemplate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingPositionTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingPositionTemplate" } } } } } } }, "/api/FinancePostingPositionTemplate/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "FinancePostingPositionTemplate" ], "summary": "FinancePostingPositionTemplate: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPositionTemplate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPositionTemplate_GetPageByValue_9D758692A2C1", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinancePostingPositionTemplate/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "FinancePostingPositionTemplate" ], "summary": "FinancePostingPositionTemplate: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPositionTemplate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPositionTemplate_GetPageByValue2_93099E090364", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinancePostingPositionTemplate/DeleteByFilter": { "post": { "tags": [ "FinancePostingPositionTemplate" ], "summary": "FinancePostingPositionTemplate: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPositionTemplate-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPositionTemplate_DeleteByFilter_6B0813C9E232", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/FinancePostingPositionTemplate/GetAllByValue": { "post": { "tags": [ "FinancePostingPositionTemplate" ], "summary": "FinancePostingPositionTemplate: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPositionTemplate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPositionTemplate_GetAllByValue_D5EABF7EE421", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingPositionTemplate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingPositionTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingPositionTemplate" } } } } } } }, "/api/FinancePostingPositionTemplate/GetAllGraphByValue": { "post": { "tags": [ "FinancePostingPositionTemplate" ], "summary": "FinancePostingPositionTemplate: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPositionTemplate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPositionTemplate_GetAllGraphByValue_00570227038C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingPositionTemplate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingPositionTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingPositionTemplate" } } } } } } }, "/api/FinancePostingPositionTemplate/GetByValue": { "post": { "tags": [ "FinancePostingPositionTemplate" ], "summary": "FinancePostingPositionTemplate: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPositionTemplate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPositionTemplate_GetByValue_C5A2813C9ECF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingPositionTemplate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingPositionTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingPositionTemplate" } } } } } } }, "/api/FinancePostingPositionTemplate/GetLookup": { "post": { "tags": [ "FinancePostingPositionTemplate" ], "summary": "FinancePostingPositionTemplate: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPositionTemplate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPositionTemplate_GetLookup_8DC6655D57A2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinancePostingPositionTemplate/GetLookupByValue": { "post": { "tags": [ "FinancePostingPositionTemplate" ], "summary": "FinancePostingPositionTemplate: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPositionTemplate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPositionTemplate_GetLookupByValue_C0EFDCA1F553", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinancePostingPositionTemplate/Page": { "get": { "tags": [ "FinancePostingPositionTemplate" ], "summary": "FinancePostingPositionTemplate: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPositionTemplate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPositionTemplate_GetPage_135875771EA2", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinancePostingPositionTemplate/PageAsc": { "get": { "tags": [ "FinancePostingPositionTemplate" ], "summary": "FinancePostingPositionTemplate: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPositionTemplate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPositionTemplate_GetPageAsc_EB6245FA0D1A", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinancePostingPositionTemplate/SearchByValue": { "post": { "tags": [ "FinancePostingPositionTemplate" ], "summary": "FinancePostingPositionTemplate: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPositionTemplate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPositionTemplate_SearchByValue_D2826DCD3870", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinancePostingPositionTemplate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinancePostingPositionTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinancePostingPositionTemplate" } } } } } } }, "/api/FinancePostingPositionTemplate/TryGetByValue": { "post": { "tags": [ "FinancePostingPositionTemplate" ], "summary": "FinancePostingPositionTemplate: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPositionTemplate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPositionTemplate_TryGetByValue_BF6305402AED", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingPositionTemplate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingPositionTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingPositionTemplate" } } } } } } }, "/api/FinancePostingPositionTemplate/UpsertGraph": { "put": { "tags": [ "FinancePostingPositionTemplate" ], "summary": "FinancePostingPositionTemplate: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPositionTemplate-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPositionTemplate_UpsertGraph_683A55FAEC11", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionTemplate" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionTemplate" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingPositionTemplate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingPositionTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingPositionTemplate" } } } } } } }, "/api/FinancePostingPositionTemplate/UpsertGraphWithExtraFields": { "put": { "tags": [ "FinancePostingPositionTemplate" ], "summary": "FinancePostingPositionTemplate: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingPositionTemplate-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingPositionTemplate_UpsertGraphWithExtraFields_65E0E781ADF6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePostingPositionTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePostingPositionTemplate" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePostingPositionTemplate" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePostingPositionTemplate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePostingPositionTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePostingPositionTemplate" } } } } } } }, "/api/FinancePostingSource": { "get": { "tags": [ "FinancePostingSource" ], "summary": "FinancePostingSource: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingSource-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingSource_GetAll_9897681F259B", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingSource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingSource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingSource" } } } } } }, "post": { "tags": [ "FinancePostingSource" ], "summary": "FinancePostingSource: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingSource-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingSource_Post_24A373509E87", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingSource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingSource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingSource" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingSource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingSource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingSource" } } } } } }, "put": { "tags": [ "FinancePostingSource" ], "summary": "FinancePostingSource: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingSource-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingSource_Put_C11A3752EDBF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingSource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingSource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingSource" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingSource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingSource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingSource" } } } } } } }, "/api/FinancePostingSource/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "FinancePostingSource" ], "summary": "FinancePostingSource: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingSource-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingSource_GetPageByValue_BCE9ADD668E3", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinancePostingSource/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "FinancePostingSource" ], "summary": "FinancePostingSource: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingSource-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingSource_GetPageByValue2_6A71EC47C59F", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinancePostingSource/DeleteByFilter": { "post": { "tags": [ "FinancePostingSource" ], "summary": "FinancePostingSource: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingSource-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingSource_DeleteByFilter_D2DA650A92AB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/FinancePostingSource/GetAllByValue": { "post": { "tags": [ "FinancePostingSource" ], "summary": "FinancePostingSource: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingSource-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingSource_GetAllByValue_713B0C3DACD8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingSource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingSource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingSource" } } } } } } }, "/api/FinancePostingSource/GetAllGraphByValue": { "post": { "tags": [ "FinancePostingSource" ], "summary": "FinancePostingSource: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingSource-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingSource_GetAllGraphByValue_6DC404056287", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingSource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingSource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingSource" } } } } } } }, "/api/FinancePostingSource/GetByValue": { "post": { "tags": [ "FinancePostingSource" ], "summary": "FinancePostingSource: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingSource-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingSource_GetByValue_FA255A0EC93A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingSource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingSource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingSource" } } } } } } }, "/api/FinancePostingSource/GetLookup": { "post": { "tags": [ "FinancePostingSource" ], "summary": "FinancePostingSource: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingSource-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingSource_GetLookup_C9290C1B8346", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinancePostingSource/GetLookupByValue": { "post": { "tags": [ "FinancePostingSource" ], "summary": "FinancePostingSource: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingSource-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingSource_GetLookupByValue_0348CEEF9B18", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinancePostingSource/Page": { "get": { "tags": [ "FinancePostingSource" ], "summary": "FinancePostingSource: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingSource-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingSource_GetPage_F841B7EEC793", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinancePostingSource/PageAsc": { "get": { "tags": [ "FinancePostingSource" ], "summary": "FinancePostingSource: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingSource-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingSource_GetPageAsc_3B6D23183789", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinancePostingSource/SearchByValue": { "post": { "tags": [ "FinancePostingSource" ], "summary": "FinancePostingSource: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingSource-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingSource_SearchByValue_0F9A8414429E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinancePostingSource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinancePostingSource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinancePostingSource" } } } } } } }, "/api/FinancePostingSource/TryGetByValue": { "post": { "tags": [ "FinancePostingSource" ], "summary": "FinancePostingSource: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingSource-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingSource_TryGetByValue_13CBF8D598BF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingSource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingSource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingSource" } } } } } } }, "/api/FinancePostingSource/UpsertGraph": { "put": { "tags": [ "FinancePostingSource" ], "summary": "FinancePostingSource: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingSource-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingSource_UpsertGraph_A247753B687F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingSource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingSource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingSource" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingSource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingSource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingSource" } } } } } } }, "/api/FinancePostingSource/UpsertGraphWithExtraFields": { "put": { "tags": [ "FinancePostingSource" ], "summary": "FinancePostingSource: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingSource-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingSource_UpsertGraphWithExtraFields_A1F100B6D410", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePostingSource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePostingSource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePostingSource" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePostingSource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePostingSource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePostingSource" } } } } } } }, "/api/FinancePostingStatus": { "get": { "tags": [ "FinancePostingStatus" ], "summary": "FinancePostingStatus: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingStatus_GetAll_83E6D1639DC5", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingStatus" } } } } } }, "post": { "tags": [ "FinancePostingStatus" ], "summary": "FinancePostingStatus: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingStatus-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingStatus_Post_9484C83749FE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingStatus" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingStatus" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingStatus" } } } } } }, "put": { "tags": [ "FinancePostingStatus" ], "summary": "FinancePostingStatus: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingStatus-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingStatus_Put_6DECD83F236F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingStatus" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingStatus" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingStatus" } } } } } } }, "/api/FinancePostingStatus/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "FinancePostingStatus" ], "summary": "FinancePostingStatus: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingStatus_GetPageByValue_ADB77BA69637", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinancePostingStatus/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "FinancePostingStatus" ], "summary": "FinancePostingStatus: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingStatus_GetPageByValue2_852ED3BE3904", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinancePostingStatus/DeleteByFilter": { "post": { "tags": [ "FinancePostingStatus" ], "summary": "FinancePostingStatus: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingStatus-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingStatus_DeleteByFilter_1CE3502C9FD9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/FinancePostingStatus/GetAllByValue": { "post": { "tags": [ "FinancePostingStatus" ], "summary": "FinancePostingStatus: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingStatus_GetAllByValue_457F7F45D494", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingStatus" } } } } } } }, "/api/FinancePostingStatus/GetAllGraphByValue": { "post": { "tags": [ "FinancePostingStatus" ], "summary": "FinancePostingStatus: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingStatus_GetAllGraphByValue_C6B5210ED2AB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingStatus" } } } } } } }, "/api/FinancePostingStatus/GetByValue": { "post": { "tags": [ "FinancePostingStatus" ], "summary": "FinancePostingStatus: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingStatus_GetByValue_8A4CD34C715C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingStatus" } } } } } } }, "/api/FinancePostingStatus/GetLookup": { "post": { "tags": [ "FinancePostingStatus" ], "summary": "FinancePostingStatus: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingStatus_GetLookup_3F5F9C880CF2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinancePostingStatus/GetLookupByValue": { "post": { "tags": [ "FinancePostingStatus" ], "summary": "FinancePostingStatus: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingStatus_GetLookupByValue_285F4842AF59", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinancePostingStatus/Page": { "get": { "tags": [ "FinancePostingStatus" ], "summary": "FinancePostingStatus: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingStatus_GetPage_9F76BF23C799", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinancePostingStatus/PageAsc": { "get": { "tags": [ "FinancePostingStatus" ], "summary": "FinancePostingStatus: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingStatus_GetPageAsc_8270C53BDC0E", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinancePostingStatus/SearchByValue": { "post": { "tags": [ "FinancePostingStatus" ], "summary": "FinancePostingStatus: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingStatus_SearchByValue_41C5E5692713", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinancePostingStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinancePostingStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinancePostingStatus" } } } } } } }, "/api/FinancePostingStatus/TryGetByValue": { "post": { "tags": [ "FinancePostingStatus" ], "summary": "FinancePostingStatus: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingStatus_TryGetByValue_154B965EA6C4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingStatus" } } } } } } }, "/api/FinancePostingStatus/UpsertGraph": { "put": { "tags": [ "FinancePostingStatus" ], "summary": "FinancePostingStatus: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingStatus-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingStatus_UpsertGraph_5F429F08392D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingStatus" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingStatus" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingStatus" } } } } } } }, "/api/FinancePostingStatus/UpsertGraphWithExtraFields": { "put": { "tags": [ "FinancePostingStatus" ], "summary": "FinancePostingStatus: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingStatus-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingStatus_UpsertGraphWithExtraFields_AE2D2C866C16", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePostingStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePostingStatus" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePostingStatus" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePostingStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePostingStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePostingStatus" } } } } } } }, "/api/FinancePostingTemplate": { "get": { "tags": [ "FinancePostingTemplate" ], "summary": "FinancePostingTemplate: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingTemplate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingTemplate_GetAll_341E30B83BAA", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingTemplate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingTemplate" } } } } } }, "post": { "tags": [ "FinancePostingTemplate" ], "summary": "FinancePostingTemplate: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingTemplate-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingTemplate_Post_4D7A6F684733", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingTemplate" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingTemplate" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingTemplate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingTemplate" } } } } } }, "put": { "tags": [ "FinancePostingTemplate" ], "summary": "FinancePostingTemplate: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingTemplate-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingTemplate_Put_693DACAB1AA1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingTemplate" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingTemplate" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingTemplate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingTemplate" } } } } } } }, "/api/FinancePostingTemplate/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "FinancePostingTemplate" ], "summary": "FinancePostingTemplate: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingTemplate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingTemplate_GetPageByValue_41EF2A18DA76", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinancePostingTemplate/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "FinancePostingTemplate" ], "summary": "FinancePostingTemplate: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingTemplate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingTemplate_GetPageByValue2_019E94E62260", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinancePostingTemplate/DeleteByFilter": { "post": { "tags": [ "FinancePostingTemplate" ], "summary": "FinancePostingTemplate: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingTemplate-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingTemplate_DeleteByFilter_29EFB0C02255", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/FinancePostingTemplate/GetAllByValue": { "post": { "tags": [ "FinancePostingTemplate" ], "summary": "FinancePostingTemplate: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingTemplate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingTemplate_GetAllByValue_C5F6FDB52F5A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingTemplate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingTemplate" } } } } } } }, "/api/FinancePostingTemplate/GetAllGraphByValue": { "post": { "tags": [ "FinancePostingTemplate" ], "summary": "FinancePostingTemplate: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingTemplate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingTemplate_GetAllGraphByValue_1A03B4E18C63", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingTemplate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingTemplate" } } } } } } }, "/api/FinancePostingTemplate/GetByValue": { "post": { "tags": [ "FinancePostingTemplate" ], "summary": "FinancePostingTemplate: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingTemplate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingTemplate_GetByValue_03E29B6AB1C0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingTemplate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingTemplate" } } } } } } }, "/api/FinancePostingTemplate/GetLookup": { "post": { "tags": [ "FinancePostingTemplate" ], "summary": "FinancePostingTemplate: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingTemplate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingTemplate_GetLookup_316D6A3D2FB9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinancePostingTemplate/GetLookupByValue": { "post": { "tags": [ "FinancePostingTemplate" ], "summary": "FinancePostingTemplate: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingTemplate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingTemplate_GetLookupByValue_30E5A823C76A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinancePostingTemplate/Page": { "get": { "tags": [ "FinancePostingTemplate" ], "summary": "FinancePostingTemplate: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingTemplate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingTemplate_GetPage_C988BAC19971", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinancePostingTemplate/PageAsc": { "get": { "tags": [ "FinancePostingTemplate" ], "summary": "FinancePostingTemplate: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingTemplate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingTemplate_GetPageAsc_757D6377B36E", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinancePostingTemplate/SearchByValue": { "post": { "tags": [ "FinancePostingTemplate" ], "summary": "FinancePostingTemplate: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingTemplate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingTemplate_SearchByValue_D9984EC94873", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinancePostingTemplate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinancePostingTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinancePostingTemplate" } } } } } } }, "/api/FinancePostingTemplate/TryGetByValue": { "post": { "tags": [ "FinancePostingTemplate" ], "summary": "FinancePostingTemplate: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingTemplate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingTemplate_TryGetByValue_CFF4CFE15D04", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingTemplate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingTemplate" } } } } } } }, "/api/FinancePostingTemplate/UpsertGraph": { "put": { "tags": [ "FinancePostingTemplate" ], "summary": "FinancePostingTemplate: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingTemplate-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingTemplate_UpsertGraph_FF4791A2C875", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingTemplate" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingTemplate" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingTemplate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingTemplate" } } } } } } }, "/api/FinancePostingTemplate/UpsertGraphWithExtraFields": { "put": { "tags": [ "FinancePostingTemplate" ], "summary": "FinancePostingTemplate: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinancePostingTemplate-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinancePostingTemplate_UpsertGraphWithExtraFields_E9FEB99EE08A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePostingTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePostingTemplate" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePostingTemplate" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePostingTemplate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePostingTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePostingTemplate" } } } } } } }, "/api/FinanceProfitLossGroup": { "get": { "tags": [ "FinanceProfitLossGroup" ], "summary": "FinanceProfitLossGroup: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceProfitLossGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceProfitLossGroup_GetAll_4AFF42D298FD", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceProfitLossGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceProfitLossGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceProfitLossGroup" } } } } } }, "post": { "tags": [ "FinanceProfitLossGroup" ], "summary": "FinanceProfitLossGroup: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceProfitLossGroup-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceProfitLossGroup_Post_61198376B246", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceProfitLossGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceProfitLossGroup" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceProfitLossGroup" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceProfitLossGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceProfitLossGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceProfitLossGroup" } } } } } }, "put": { "tags": [ "FinanceProfitLossGroup" ], "summary": "FinanceProfitLossGroup: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceProfitLossGroup-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceProfitLossGroup_Put_FC120C0CF062", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceProfitLossGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceProfitLossGroup" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceProfitLossGroup" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceProfitLossGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceProfitLossGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceProfitLossGroup" } } } } } } }, "/api/FinanceProfitLossGroup/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "FinanceProfitLossGroup" ], "summary": "FinanceProfitLossGroup: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceProfitLossGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceProfitLossGroup_GetPageByValue_611BBEA022D4", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceProfitLossGroup/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "FinanceProfitLossGroup" ], "summary": "FinanceProfitLossGroup: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceProfitLossGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceProfitLossGroup_GetPageByValue2_F3698DC5F928", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceProfitLossGroup/DeleteByFilter": { "post": { "tags": [ "FinanceProfitLossGroup" ], "summary": "FinanceProfitLossGroup: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceProfitLossGroup-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceProfitLossGroup_DeleteByFilter_F4433E2D1275", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/FinanceProfitLossGroup/GetAllByValue": { "post": { "tags": [ "FinanceProfitLossGroup" ], "summary": "FinanceProfitLossGroup: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceProfitLossGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceProfitLossGroup_GetAllByValue_7A3A7B411BE1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceProfitLossGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceProfitLossGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceProfitLossGroup" } } } } } } }, "/api/FinanceProfitLossGroup/GetAllGraphByValue": { "post": { "tags": [ "FinanceProfitLossGroup" ], "summary": "FinanceProfitLossGroup: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceProfitLossGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceProfitLossGroup_GetAllGraphByValue_B76EAA8243F1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceProfitLossGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceProfitLossGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceProfitLossGroup" } } } } } } }, "/api/FinanceProfitLossGroup/GetByValue": { "post": { "tags": [ "FinanceProfitLossGroup" ], "summary": "FinanceProfitLossGroup: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceProfitLossGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceProfitLossGroup_GetByValue_E240E86ADE4D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceProfitLossGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceProfitLossGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceProfitLossGroup" } } } } } } }, "/api/FinanceProfitLossGroup/GetLookup": { "post": { "tags": [ "FinanceProfitLossGroup" ], "summary": "FinanceProfitLossGroup: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceProfitLossGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceProfitLossGroup_GetLookup_7DE881A83126", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceProfitLossGroup/GetLookupByValue": { "post": { "tags": [ "FinanceProfitLossGroup" ], "summary": "FinanceProfitLossGroup: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceProfitLossGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceProfitLossGroup_GetLookupByValue_3508310C9924", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceProfitLossGroup/Page": { "get": { "tags": [ "FinanceProfitLossGroup" ], "summary": "FinanceProfitLossGroup: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceProfitLossGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceProfitLossGroup_GetPage_65E09151C712", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceProfitLossGroup/PageAsc": { "get": { "tags": [ "FinanceProfitLossGroup" ], "summary": "FinanceProfitLossGroup: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceProfitLossGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceProfitLossGroup_GetPageAsc_479B6176FDE1", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceProfitLossGroup/PageFinanceProfitLossGroupsByParent/{ParentId}/{IncludeSubNodes}/{TopParentsOnly}": { "get": { "tags": [ "FinanceProfitLossGroup" ], "summary": "FinanceProfitLossGroup: GetPageFinanceProfitLossGroupsByParent", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceProfitLossGroup-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceProfitLossGroup_GetPageFinanceProfitLossGroupsByParent_8B47009B2875", "parameters": [ { "name": "ParentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "IncludeSubNodes", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "TopParentsOnly", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceProfitLossGroup/SearchByValue": { "post": { "tags": [ "FinanceProfitLossGroup" ], "summary": "FinanceProfitLossGroup: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceProfitLossGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceProfitLossGroup_SearchByValue_0606D961E209", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceProfitLossGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceProfitLossGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceProfitLossGroup" } } } } } } }, "/api/FinanceProfitLossGroup/TryGetByValue": { "post": { "tags": [ "FinanceProfitLossGroup" ], "summary": "FinanceProfitLossGroup: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceProfitLossGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceProfitLossGroup_TryGetByValue_67F93BD80799", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceProfitLossGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceProfitLossGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceProfitLossGroup" } } } } } } }, "/api/FinanceProfitLossGroup/UpsertGraph": { "put": { "tags": [ "FinanceProfitLossGroup" ], "summary": "FinanceProfitLossGroup: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceProfitLossGroup-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceProfitLossGroup_UpsertGraph_973D3CC5C640", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceProfitLossGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceProfitLossGroup" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceProfitLossGroup" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceProfitLossGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceProfitLossGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceProfitLossGroup" } } } } } } }, "/api/FinanceProfitLossGroup/UpsertGraphWithExtraFields": { "put": { "tags": [ "FinanceProfitLossGroup" ], "summary": "FinanceProfitLossGroup: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceProfitLossGroup-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceProfitLossGroup_UpsertGraphWithExtraFields_0DF3DE0F6D8B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceProfitLossGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceProfitLossGroup" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceProfitLossGroup" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceProfitLossGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceProfitLossGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceProfitLossGroup" } } } } } } }, "/api/FinanceTaxKey": { "get": { "tags": [ "FinanceTaxKey" ], "summary": "FinanceTaxKey: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTaxKey-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTaxKey_GetAll_CF690094976C", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTaxKey" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTaxKey" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTaxKey" } } } } } }, "post": { "tags": [ "FinanceTaxKey" ], "summary": "FinanceTaxKey: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTaxKey-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTaxKey_Post_0562B5403929", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTaxKey" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTaxKey" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTaxKey" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTaxKey" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTaxKey" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTaxKey" } } } } } }, "put": { "tags": [ "FinanceTaxKey" ], "summary": "FinanceTaxKey: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTaxKey-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTaxKey_Put_9E26971DC72B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTaxKey" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTaxKey" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTaxKey" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTaxKey" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTaxKey" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTaxKey" } } } } } } }, "/api/FinanceTaxKey/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "FinanceTaxKey" ], "summary": "FinanceTaxKey: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTaxKey-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTaxKey_GetPageByValue_5E019A60EFFF", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceTaxKey/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "FinanceTaxKey" ], "summary": "FinanceTaxKey: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTaxKey-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTaxKey_GetPageByValue2_F5BABD5C4214", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceTaxKey/DeleteByFilter": { "post": { "tags": [ "FinanceTaxKey" ], "summary": "FinanceTaxKey: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTaxKey-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTaxKey_DeleteByFilter_AF61AAC1A446", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/FinanceTaxKey/GetAllByValue": { "post": { "tags": [ "FinanceTaxKey" ], "summary": "FinanceTaxKey: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTaxKey-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTaxKey_GetAllByValue_CB7E72617745", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTaxKey" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTaxKey" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTaxKey" } } } } } } }, "/api/FinanceTaxKey/GetAllGraphByValue": { "post": { "tags": [ "FinanceTaxKey" ], "summary": "FinanceTaxKey: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTaxKey-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTaxKey_GetAllGraphByValue_CED7B923156E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTaxKey" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTaxKey" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTaxKey" } } } } } } }, "/api/FinanceTaxKey/GetByValue": { "post": { "tags": [ "FinanceTaxKey" ], "summary": "FinanceTaxKey: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTaxKey-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTaxKey_GetByValue_573C429F463F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTaxKey" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTaxKey" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTaxKey" } } } } } } }, "/api/FinanceTaxKey/GetLookup": { "post": { "tags": [ "FinanceTaxKey" ], "summary": "FinanceTaxKey: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTaxKey-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTaxKey_GetLookup_F727C671A14E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceTaxKey/GetLookupByValue": { "post": { "tags": [ "FinanceTaxKey" ], "summary": "FinanceTaxKey: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTaxKey-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTaxKey_GetLookupByValue_5B04668BA5E5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceTaxKey/Page": { "get": { "tags": [ "FinanceTaxKey" ], "summary": "FinanceTaxKey: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTaxKey-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTaxKey_GetPage_26CE321304E4", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceTaxKey/PageAsc": { "get": { "tags": [ "FinanceTaxKey" ], "summary": "FinanceTaxKey: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTaxKey-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTaxKey_GetPageAsc_7F27114CF650", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceTaxKey/SearchByValue": { "post": { "tags": [ "FinanceTaxKey" ], "summary": "FinanceTaxKey: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTaxKey-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTaxKey_SearchByValue_A6B00566408E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceTaxKey" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceTaxKey" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceTaxKey" } } } } } } }, "/api/FinanceTaxKey/TryGetByValue": { "post": { "tags": [ "FinanceTaxKey" ], "summary": "FinanceTaxKey: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTaxKey-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTaxKey_TryGetByValue_59CBAEE0AC71", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTaxKey" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTaxKey" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTaxKey" } } } } } } }, "/api/FinanceTaxKey/UpsertGraph": { "put": { "tags": [ "FinanceTaxKey" ], "summary": "FinanceTaxKey: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTaxKey-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTaxKey_UpsertGraph_613C223EB10F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTaxKey" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTaxKey" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTaxKey" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTaxKey" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTaxKey" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTaxKey" } } } } } } }, "/api/FinanceTaxKey/UpsertGraphWithExtraFields": { "put": { "tags": [ "FinanceTaxKey" ], "summary": "FinanceTaxKey: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTaxKey-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTaxKey_UpsertGraphWithExtraFields_CC5096425801", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTaxKey" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTaxKey" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTaxKey" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTaxKey" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTaxKey" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTaxKey" } } } } } } }, "/api/FinanceTaxKeyDetail": { "get": { "tags": [ "FinanceTaxKeyDetail" ], "summary": "FinanceTaxKeyDetail: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTaxKeyDetail-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTaxKeyDetail_GetAll_2373A25451BC", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTaxKeyDetail" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTaxKeyDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTaxKeyDetail" } } } } } }, "post": { "tags": [ "FinanceTaxKeyDetail" ], "summary": "FinanceTaxKeyDetail: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTaxKeyDetail-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTaxKeyDetail_Post_92CF454C7349", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTaxKeyDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTaxKeyDetail" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTaxKeyDetail" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTaxKeyDetail" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTaxKeyDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTaxKeyDetail" } } } } } }, "put": { "tags": [ "FinanceTaxKeyDetail" ], "summary": "FinanceTaxKeyDetail: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTaxKeyDetail-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTaxKeyDetail_Put_DB37392E76DC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTaxKeyDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTaxKeyDetail" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTaxKeyDetail" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTaxKeyDetail" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTaxKeyDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTaxKeyDetail" } } } } } } }, "/api/FinanceTaxKeyDetail/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "FinanceTaxKeyDetail" ], "summary": "FinanceTaxKeyDetail: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTaxKeyDetail-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTaxKeyDetail_GetPageByValue_EDD452C4AECC", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceTaxKeyDetail/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "FinanceTaxKeyDetail" ], "summary": "FinanceTaxKeyDetail: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTaxKeyDetail-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTaxKeyDetail_GetPageByValue2_9C5C6EEE973E", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceTaxKeyDetail/{TaxKeyId}/PageFromViewByTaxKeyId": { "get": { "tags": [ "FinanceTaxKeyDetail" ], "summary": "FinanceTaxKeyDetail: GetPageFromViewByTaxKeyId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTaxKeyDetail-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTaxKeyDetail_GetPageFromViewByTaxKeyId_4749FAE18AC9", "parameters": [ { "name": "TaxKeyId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceTaxKeyDetail/DeleteByFilter": { "post": { "tags": [ "FinanceTaxKeyDetail" ], "summary": "FinanceTaxKeyDetail: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTaxKeyDetail-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTaxKeyDetail_DeleteByFilter_9BF44E97E15F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/FinanceTaxKeyDetail/GetAllByValue": { "post": { "tags": [ "FinanceTaxKeyDetail" ], "summary": "FinanceTaxKeyDetail: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTaxKeyDetail-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTaxKeyDetail_GetAllByValue_FE2AC890C29F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTaxKeyDetail" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTaxKeyDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTaxKeyDetail" } } } } } } }, "/api/FinanceTaxKeyDetail/GetAllGraphByValue": { "post": { "tags": [ "FinanceTaxKeyDetail" ], "summary": "FinanceTaxKeyDetail: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTaxKeyDetail-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTaxKeyDetail_GetAllGraphByValue_B7746AB6F36A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTaxKeyDetail" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTaxKeyDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTaxKeyDetail" } } } } } } }, "/api/FinanceTaxKeyDetail/GetByValue": { "post": { "tags": [ "FinanceTaxKeyDetail" ], "summary": "FinanceTaxKeyDetail: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTaxKeyDetail-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTaxKeyDetail_GetByValue_E5ECDD51FF60", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTaxKeyDetail" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTaxKeyDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTaxKeyDetail" } } } } } } }, "/api/FinanceTaxKeyDetail/GetLookup": { "post": { "tags": [ "FinanceTaxKeyDetail" ], "summary": "FinanceTaxKeyDetail: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTaxKeyDetail-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTaxKeyDetail_GetLookup_DE273E4456BC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceTaxKeyDetail/GetLookupByValue": { "post": { "tags": [ "FinanceTaxKeyDetail" ], "summary": "FinanceTaxKeyDetail: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTaxKeyDetail-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTaxKeyDetail_GetLookupByValue_C0655C32785A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceTaxKeyDetail/GetTaxRate": { "post": { "tags": [ "FinanceTaxKeyDetail" ], "summary": "FinanceTaxKeyDetail: GetTaxRate", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTaxKeyDetail-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTaxKeyDetail_GetTaxRate_2D2B503F02AE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTaxKeyDetail_GetTaxRateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTaxKeyDetail_GetTaxRateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTaxKeyDetail_GetTaxRateRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTaxKeyDetail" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTaxKeyDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTaxKeyDetail" } } } } } } }, "/api/FinanceTaxKeyDetail/Page": { "get": { "tags": [ "FinanceTaxKeyDetail" ], "summary": "FinanceTaxKeyDetail: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTaxKeyDetail-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTaxKeyDetail_GetPage_763EDCF83468", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceTaxKeyDetail/PageAsc": { "get": { "tags": [ "FinanceTaxKeyDetail" ], "summary": "FinanceTaxKeyDetail: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTaxKeyDetail-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTaxKeyDetail_GetPageAsc_9BC896E10F75", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceTaxKeyDetail/SearchByValue": { "post": { "tags": [ "FinanceTaxKeyDetail" ], "summary": "FinanceTaxKeyDetail: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTaxKeyDetail-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTaxKeyDetail_SearchByValue_E69E400B5FE5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceTaxKeyDetail" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceTaxKeyDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceTaxKeyDetail" } } } } } } }, "/api/FinanceTaxKeyDetail/TryGetByValue": { "post": { "tags": [ "FinanceTaxKeyDetail" ], "summary": "FinanceTaxKeyDetail: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTaxKeyDetail-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTaxKeyDetail_TryGetByValue_6F67114E5D9F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTaxKeyDetail" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTaxKeyDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTaxKeyDetail" } } } } } } }, "/api/FinanceTaxKeyDetail/UpsertGraph": { "put": { "tags": [ "FinanceTaxKeyDetail" ], "summary": "FinanceTaxKeyDetail: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTaxKeyDetail-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTaxKeyDetail_UpsertGraph_D508CC6BEC49", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTaxKeyDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTaxKeyDetail" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTaxKeyDetail" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTaxKeyDetail" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTaxKeyDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTaxKeyDetail" } } } } } } }, "/api/FinanceTaxKeyDetail/UpsertGraphWithExtraFields": { "put": { "tags": [ "FinanceTaxKeyDetail" ], "summary": "FinanceTaxKeyDetail: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTaxKeyDetail-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTaxKeyDetail_UpsertGraphWithExtraFields_261E5B1F02E2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTaxKeyDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTaxKeyDetail" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTaxKeyDetail" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTaxKeyDetail" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTaxKeyDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTaxKeyDetail" } } } } } } }, "/api/FinanceTaxKeyKind": { "get": { "tags": [ "FinanceTaxKeyKind" ], "summary": "FinanceTaxKeyKind: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTaxKeyKind-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTaxKeyKind_GetAll_2020A5ADC8AE", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTaxKeyKind" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTaxKeyKind" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTaxKeyKind" } } } } } }, "post": { "tags": [ "FinanceTaxKeyKind" ], "summary": "FinanceTaxKeyKind: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTaxKeyKind-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTaxKeyKind_Post_7EA1CE7C9BB8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTaxKeyKind" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTaxKeyKind" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTaxKeyKind" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTaxKeyKind" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTaxKeyKind" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTaxKeyKind" } } } } } }, "put": { "tags": [ "FinanceTaxKeyKind" ], "summary": "FinanceTaxKeyKind: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTaxKeyKind-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTaxKeyKind_Put_18BBEBCF8E3D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTaxKeyKind" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTaxKeyKind" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTaxKeyKind" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTaxKeyKind" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTaxKeyKind" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTaxKeyKind" } } } } } } }, "/api/FinanceTaxKeyKind/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "FinanceTaxKeyKind" ], "summary": "FinanceTaxKeyKind: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTaxKeyKind-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTaxKeyKind_GetPageByValue_223F82D7D8E0", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceTaxKeyKind/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "FinanceTaxKeyKind" ], "summary": "FinanceTaxKeyKind: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTaxKeyKind-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTaxKeyKind_GetPageByValue2_F52BA5C08C69", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceTaxKeyKind/DeleteByFilter": { "post": { "tags": [ "FinanceTaxKeyKind" ], "summary": "FinanceTaxKeyKind: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTaxKeyKind-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTaxKeyKind_DeleteByFilter_1DB0AC20442B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/FinanceTaxKeyKind/GetAllByValue": { "post": { "tags": [ "FinanceTaxKeyKind" ], "summary": "FinanceTaxKeyKind: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTaxKeyKind-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTaxKeyKind_GetAllByValue_E1C3FC54714C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTaxKeyKind" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTaxKeyKind" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTaxKeyKind" } } } } } } }, "/api/FinanceTaxKeyKind/GetAllGraphByValue": { "post": { "tags": [ "FinanceTaxKeyKind" ], "summary": "FinanceTaxKeyKind: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTaxKeyKind-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTaxKeyKind_GetAllGraphByValue_4D1F11C16B0B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTaxKeyKind" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTaxKeyKind" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTaxKeyKind" } } } } } } }, "/api/FinanceTaxKeyKind/GetByValue": { "post": { "tags": [ "FinanceTaxKeyKind" ], "summary": "FinanceTaxKeyKind: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTaxKeyKind-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTaxKeyKind_GetByValue_13EFC7F9595D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTaxKeyKind" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTaxKeyKind" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTaxKeyKind" } } } } } } }, "/api/FinanceTaxKeyKind/GetLookup": { "post": { "tags": [ "FinanceTaxKeyKind" ], "summary": "FinanceTaxKeyKind: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTaxKeyKind-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTaxKeyKind_GetLookup_14D9CF5D4ADA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceTaxKeyKind/GetLookupByValue": { "post": { "tags": [ "FinanceTaxKeyKind" ], "summary": "FinanceTaxKeyKind: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTaxKeyKind-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTaxKeyKind_GetLookupByValue_885199A89835", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceTaxKeyKind/Page": { "get": { "tags": [ "FinanceTaxKeyKind" ], "summary": "FinanceTaxKeyKind: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTaxKeyKind-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTaxKeyKind_GetPage_DF97A5389762", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceTaxKeyKind/PageAsc": { "get": { "tags": [ "FinanceTaxKeyKind" ], "summary": "FinanceTaxKeyKind: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTaxKeyKind-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTaxKeyKind_GetPageAsc_EC927AF11EAA", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceTaxKeyKind/SearchByValue": { "post": { "tags": [ "FinanceTaxKeyKind" ], "summary": "FinanceTaxKeyKind: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTaxKeyKind-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTaxKeyKind_SearchByValue_308433C3F91B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceTaxKeyKind" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceTaxKeyKind" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceTaxKeyKind" } } } } } } }, "/api/FinanceTaxKeyKind/TryGetByValue": { "post": { "tags": [ "FinanceTaxKeyKind" ], "summary": "FinanceTaxKeyKind: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTaxKeyKind-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTaxKeyKind_TryGetByValue_039F59CCAFF7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTaxKeyKind" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTaxKeyKind" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTaxKeyKind" } } } } } } }, "/api/FinanceTaxKeyKind/UpsertGraph": { "put": { "tags": [ "FinanceTaxKeyKind" ], "summary": "FinanceTaxKeyKind: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTaxKeyKind-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTaxKeyKind_UpsertGraph_DBF01B85A2AA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTaxKeyKind" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTaxKeyKind" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTaxKeyKind" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTaxKeyKind" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTaxKeyKind" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTaxKeyKind" } } } } } } }, "/api/FinanceTaxKeyKind/UpsertGraphWithExtraFields": { "put": { "tags": [ "FinanceTaxKeyKind" ], "summary": "FinanceTaxKeyKind: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTaxKeyKind-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTaxKeyKind_UpsertGraphWithExtraFields_199F3B724DA4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTaxKeyKind" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTaxKeyKind" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTaxKeyKind" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTaxKeyKind" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTaxKeyKind" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTaxKeyKind" } } } } } } }, "/api/FinanceTransfer": { "get": { "tags": [ "FinanceTransfer" ], "summary": "FinanceTransfer: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransfer-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransfer_GetAll_3F31B0F528F1", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransfer" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransfer" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransfer" } } } } } }, "post": { "tags": [ "FinanceTransfer" ], "summary": "FinanceTransfer: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransfer-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransfer_Post_5E3EADECB087", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransfer" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransfer" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransfer" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransfer" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransfer" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransfer" } } } } } }, "put": { "tags": [ "FinanceTransfer" ], "summary": "FinanceTransfer: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransfer-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransfer_Put_A24AD4A2E57F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransfer" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransfer" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransfer" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransfer" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransfer" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransfer" } } } } } } }, "/api/FinanceTransfer/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "FinanceTransfer" ], "summary": "FinanceTransfer: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransfer-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransfer_GetPageByValue_75E97A6C0558", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceTransfer/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "FinanceTransfer" ], "summary": "FinanceTransfer: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransfer-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransfer_GetPageByValue2_8C4052A18C71", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceTransfer/CheckNegativeBalance": { "post": { "tags": [ "FinanceTransfer" ], "summary": "FinanceTransfer: CheckNegativeBalance", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransfer-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransfer_CheckNegativeBalance_27C344B7A2C3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransfer_CheckNegativeBalanceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransfer_CheckNegativeBalanceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransfer_CheckNegativeBalanceRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransfer_CheckNegativeBalanceResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransfer_CheckNegativeBalanceResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransfer_CheckNegativeBalanceResult" } } } } } } }, "/api/FinanceTransfer/CreateNewFinanceTransfer": { "post": { "tags": [ "FinanceTransfer" ], "summary": "FinanceTransfer: CreateNewFinanceTransfer", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransfer-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransfer_CreateNewFinanceTransfer_3D7B7934A43E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransfer_CreateNewRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransfer_CreateNewRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransfer_CreateNewRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransfer" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransfer" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransfer" } } } } } } }, "/api/FinanceTransfer/DeleteByFilter": { "post": { "tags": [ "FinanceTransfer" ], "summary": "FinanceTransfer: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransfer-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransfer_DeleteByFilter_B95829ECDFCB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/FinanceTransfer/GetAllByValue": { "post": { "tags": [ "FinanceTransfer" ], "summary": "FinanceTransfer: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransfer-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransfer_GetAllByValue_BBAA692D4A4A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransfer" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransfer" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransfer" } } } } } } }, "/api/FinanceTransfer/GetAllGraphByValue": { "post": { "tags": [ "FinanceTransfer" ], "summary": "FinanceTransfer: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransfer-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransfer_GetAllGraphByValue_9AB5A2DF5D70", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransfer" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransfer" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransfer" } } } } } } }, "/api/FinanceTransfer/GetAttachmentCount": { "post": { "tags": [ "FinanceTransfer" ], "summary": "FinanceTransfer: GetAttachmentCount", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransfer-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransfer_GetAttachmentCount_D0A42659224A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransfer_GetAttachmentCountRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransfer_GetAttachmentCountRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransfer_GetAttachmentCountRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/FinanceTransfer/GetByValue": { "post": { "tags": [ "FinanceTransfer" ], "summary": "FinanceTransfer: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransfer-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransfer_GetByValue_38AD23DE2DBE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransfer" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransfer" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransfer" } } } } } } }, "/api/FinanceTransfer/GetLookup": { "post": { "tags": [ "FinanceTransfer" ], "summary": "FinanceTransfer: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransfer-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransfer_GetLookup_34E25D507B74", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceTransfer/GetLookupByValue": { "post": { "tags": [ "FinanceTransfer" ], "summary": "FinanceTransfer: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransfer-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransfer_GetLookupByValue_B29FFABCD088", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceTransfer/Page": { "get": { "tags": [ "FinanceTransfer" ], "summary": "FinanceTransfer: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransfer-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransfer_GetPage_6461EDC439FB", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceTransfer/PageAsc": { "get": { "tags": [ "FinanceTransfer" ], "summary": "FinanceTransfer: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransfer-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransfer_GetPageAsc_C404A8D2E910", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceTransfer/PostTransfer": { "post": { "tags": [ "FinanceTransfer" ], "summary": "FinanceTransfer: PostTransfer", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransfer-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransfer_PostTransfer_F74C53BC6403", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransfer_PostTransferRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransfer_PostTransferRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransfer_PostTransferRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xPROC609_FinanceTransfer_PostingResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xPROC609_FinanceTransfer_PostingResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xPROC609_FinanceTransfer_PostingResult" } } } } } } }, "/api/FinanceTransfer/SearchByValue": { "post": { "tags": [ "FinanceTransfer" ], "summary": "FinanceTransfer: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransfer-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransfer_SearchByValue_5FB997C347BB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceTransfer" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceTransfer" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceTransfer" } } } } } } }, "/api/FinanceTransfer/Suggest": { "post": { "tags": [ "FinanceTransfer" ], "summary": "FinanceTransfer: Suggest", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransfer-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransfer_Suggest_2FB2A5DC1846", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransfer_SuggestRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransfer_SuggestRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransfer_SuggestRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/FinanceTransfer/TryGetByValue": { "post": { "tags": [ "FinanceTransfer" ], "summary": "FinanceTransfer: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransfer-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransfer_TryGetByValue_36A078FA782C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransfer" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransfer" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransfer" } } } } } } }, "/api/FinanceTransfer/UploadAndImport/{FinanceTransferId}": { "post": { "tags": [ "FinanceTransfer" ], "summary": "FinanceTransfer: UploadAndImport", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransfer-Create.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransfer_UploadAndImport_D0F364BC767A", "parameters": [ { "name": "FinanceTransferId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "fileChunk": { "type": "string", "format": "binary" } } }, "encoding": { "fileChunk": { "style": "form" } } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/FinanceTransfer/UploadAndImportCSV/{FinanceTransferId}": { "post": { "tags": [ "FinanceTransfer" ], "summary": "FinanceTransfer: UploadAndImportCSV", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransfer-Create.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransfer_UploadAndImportCSV_F599DE8A4B50", "parameters": [ { "name": "FinanceTransferId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "fileChunk": { "type": "string", "format": "binary" } } }, "encoding": { "fileChunk": { "style": "form" } } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/FinanceTransfer/UpsertGraph": { "put": { "tags": [ "FinanceTransfer" ], "summary": "FinanceTransfer: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransfer-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransfer_UpsertGraph_6EB2C4D63A6B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransfer" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransfer" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransfer" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransfer" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransfer" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransfer" } } } } } } }, "/api/FinanceTransfer/UpsertGraphWithExtraFields": { "put": { "tags": [ "FinanceTransfer" ], "summary": "FinanceTransfer: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransfer-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransfer_UpsertGraphWithExtraFields_B55B4C28CA64", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransfer" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransfer" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransfer" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransfer" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransfer" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransfer" } } } } } } }, "/api/FinanceTransferBankStatement": { "get": { "tags": [ "FinanceTransferBankStatement" ], "summary": "FinanceTransferBankStatement: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferBankStatement-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferBankStatement_GetAll_7513CA282606", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferBankStatement" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferBankStatement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferBankStatement" } } } } } }, "post": { "tags": [ "FinanceTransferBankStatement" ], "summary": "FinanceTransferBankStatement: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferBankStatement-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferBankStatement_Post_7CE56D461BD9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferBankStatement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferBankStatement" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferBankStatement" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferBankStatement" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferBankStatement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferBankStatement" } } } } } }, "put": { "tags": [ "FinanceTransferBankStatement" ], "summary": "FinanceTransferBankStatement: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferBankStatement-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferBankStatement_Put_B19EF81C1E29", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferBankStatement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferBankStatement" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferBankStatement" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferBankStatement" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferBankStatement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferBankStatement" } } } } } } }, "/api/FinanceTransferBankStatement/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "FinanceTransferBankStatement" ], "summary": "FinanceTransferBankStatement: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferBankStatement-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferBankStatement_GetPageByValue_E6184CE614F6", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceTransferBankStatement/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "FinanceTransferBankStatement" ], "summary": "FinanceTransferBankStatement: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferBankStatement-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferBankStatement_GetPageByValue2_64E0CE3E7C3B", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceTransferBankStatement/DeleteByFilter": { "post": { "tags": [ "FinanceTransferBankStatement" ], "summary": "FinanceTransferBankStatement: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferBankStatement-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferBankStatement_DeleteByFilter_3E9EBC2B7EC7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/FinanceTransferBankStatement/GetAllByValue": { "post": { "tags": [ "FinanceTransferBankStatement" ], "summary": "FinanceTransferBankStatement: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferBankStatement-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferBankStatement_GetAllByValue_BE7C2548B0EB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferBankStatement" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferBankStatement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferBankStatement" } } } } } } }, "/api/FinanceTransferBankStatement/GetAllGraphByValue": { "post": { "tags": [ "FinanceTransferBankStatement" ], "summary": "FinanceTransferBankStatement: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferBankStatement-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferBankStatement_GetAllGraphByValue_2115AEA6BB4E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferBankStatement" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferBankStatement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferBankStatement" } } } } } } }, "/api/FinanceTransferBankStatement/GetByValue": { "post": { "tags": [ "FinanceTransferBankStatement" ], "summary": "FinanceTransferBankStatement: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferBankStatement-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferBankStatement_GetByValue_8D5E6B843337", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferBankStatement" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferBankStatement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferBankStatement" } } } } } } }, "/api/FinanceTransferBankStatement/GetLookup": { "post": { "tags": [ "FinanceTransferBankStatement" ], "summary": "FinanceTransferBankStatement: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferBankStatement-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferBankStatement_GetLookup_EA7094D5DA59", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceTransferBankStatement/GetLookupByValue": { "post": { "tags": [ "FinanceTransferBankStatement" ], "summary": "FinanceTransferBankStatement: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferBankStatement-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferBankStatement_GetLookupByValue_EA947F161001", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceTransferBankStatement/Page": { "get": { "tags": [ "FinanceTransferBankStatement" ], "summary": "FinanceTransferBankStatement: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferBankStatement-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferBankStatement_GetPage_3047F472AE4D", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceTransferBankStatement/PageAsc": { "get": { "tags": [ "FinanceTransferBankStatement" ], "summary": "FinanceTransferBankStatement: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferBankStatement-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferBankStatement_GetPageAsc_D71C4C58F15F", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceTransferBankStatement/SearchByValue": { "post": { "tags": [ "FinanceTransferBankStatement" ], "summary": "FinanceTransferBankStatement: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferBankStatement-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferBankStatement_SearchByValue_08F5DFE2E0EB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceTransferBankStatement" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceTransferBankStatement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceTransferBankStatement" } } } } } } }, "/api/FinanceTransferBankStatement/TryGetByValue": { "post": { "tags": [ "FinanceTransferBankStatement" ], "summary": "FinanceTransferBankStatement: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferBankStatement-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferBankStatement_TryGetByValue_173B8E7F6D24", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferBankStatement" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferBankStatement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferBankStatement" } } } } } } }, "/api/FinanceTransferBankStatement/UpsertGraph": { "put": { "tags": [ "FinanceTransferBankStatement" ], "summary": "FinanceTransferBankStatement: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferBankStatement-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferBankStatement_UpsertGraph_3F7ABFDD34A9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferBankStatement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferBankStatement" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferBankStatement" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferBankStatement" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferBankStatement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferBankStatement" } } } } } } }, "/api/FinanceTransferBankStatement/UpsertGraphWithExtraFields": { "put": { "tags": [ "FinanceTransferBankStatement" ], "summary": "FinanceTransferBankStatement: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferBankStatement-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferBankStatement_UpsertGraphWithExtraFields_6E74AD0850B7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransferBankStatement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransferBankStatement" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransferBankStatement" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransferBankStatement" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransferBankStatement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransferBankStatement" } } } } } } }, "/api/FinanceTransferCategory": { "get": { "tags": [ "FinanceTransferCategory" ], "summary": "FinanceTransferCategory: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferCategory_GetAll_E6ADA69BACC2", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferCategory" } } } } } }, "post": { "tags": [ "FinanceTransferCategory" ], "summary": "FinanceTransferCategory: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferCategory-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferCategory_Post_25F831C9040E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferCategory" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferCategory" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferCategory" } } } } } }, "put": { "tags": [ "FinanceTransferCategory" ], "summary": "FinanceTransferCategory: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferCategory-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferCategory_Put_0240F0593FA0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferCategory" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferCategory" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferCategory" } } } } } } }, "/api/FinanceTransferCategory/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "FinanceTransferCategory" ], "summary": "FinanceTransferCategory: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferCategory_GetPageByValue_F1B0C838515F", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceTransferCategory/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "FinanceTransferCategory" ], "summary": "FinanceTransferCategory: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferCategory_GetPageByValue2_5D760D6A7459", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceTransferCategory/DeleteByFilter": { "post": { "tags": [ "FinanceTransferCategory" ], "summary": "FinanceTransferCategory: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferCategory-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferCategory_DeleteByFilter_B88F22F8D861", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/FinanceTransferCategory/GetAllByValue": { "post": { "tags": [ "FinanceTransferCategory" ], "summary": "FinanceTransferCategory: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferCategory_GetAllByValue_ECCA538016EB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferCategory" } } } } } } }, "/api/FinanceTransferCategory/GetAllGraphByValue": { "post": { "tags": [ "FinanceTransferCategory" ], "summary": "FinanceTransferCategory: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferCategory_GetAllGraphByValue_2D39D571B1A4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferCategory" } } } } } } }, "/api/FinanceTransferCategory/GetByValue": { "post": { "tags": [ "FinanceTransferCategory" ], "summary": "FinanceTransferCategory: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferCategory_GetByValue_291B58E8B974", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferCategory" } } } } } } }, "/api/FinanceTransferCategory/GetLookup": { "post": { "tags": [ "FinanceTransferCategory" ], "summary": "FinanceTransferCategory: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferCategory_GetLookup_6B2A1CD0C7FD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceTransferCategory/GetLookupByValue": { "post": { "tags": [ "FinanceTransferCategory" ], "summary": "FinanceTransferCategory: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferCategory_GetLookupByValue_82D6F509C43E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceTransferCategory/Page": { "get": { "tags": [ "FinanceTransferCategory" ], "summary": "FinanceTransferCategory: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferCategory_GetPage_F170904A7BE8", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceTransferCategory/PageAsc": { "get": { "tags": [ "FinanceTransferCategory" ], "summary": "FinanceTransferCategory: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferCategory_GetPageAsc_F6DB767DE614", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceTransferCategory/SearchByValue": { "post": { "tags": [ "FinanceTransferCategory" ], "summary": "FinanceTransferCategory: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferCategory_SearchByValue_A61DC2D384C9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceTransferCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceTransferCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceTransferCategory" } } } } } } }, "/api/FinanceTransferCategory/TryGetByValue": { "post": { "tags": [ "FinanceTransferCategory" ], "summary": "FinanceTransferCategory: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferCategory_TryGetByValue_64073DB83A0C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferCategory" } } } } } } }, "/api/FinanceTransferCategory/UpsertGraph": { "put": { "tags": [ "FinanceTransferCategory" ], "summary": "FinanceTransferCategory: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferCategory-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferCategory_UpsertGraph_C566D4FC6C5F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferCategory" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferCategory" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferCategory" } } } } } } }, "/api/FinanceTransferCategory/UpsertGraphWithExtraFields": { "put": { "tags": [ "FinanceTransferCategory" ], "summary": "FinanceTransferCategory: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferCategory-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferCategory_UpsertGraphWithExtraFields_C0DD8FB2E08E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransferCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransferCategory" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransferCategory" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransferCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransferCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransferCategory" } } } } } } }, "/api/FinanceTransferCategoryAccountType": { "get": { "tags": [ "FinanceTransferCategoryAccountType" ], "summary": "FinanceTransferCategoryAccountType: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferCategoryAccountType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferCategoryAccountType_GetAll_0A6D3EDC4AA0", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferCategoryAccountType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferCategoryAccountType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferCategoryAccountType" } } } } } }, "post": { "tags": [ "FinanceTransferCategoryAccountType" ], "summary": "FinanceTransferCategoryAccountType: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferCategoryAccountType-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferCategoryAccountType_Post_28C35B1B0FEF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferCategoryAccountType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferCategoryAccountType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferCategoryAccountType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferCategoryAccountType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferCategoryAccountType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferCategoryAccountType" } } } } } }, "put": { "tags": [ "FinanceTransferCategoryAccountType" ], "summary": "FinanceTransferCategoryAccountType: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferCategoryAccountType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferCategoryAccountType_Put_7397FE93A27C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferCategoryAccountType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferCategoryAccountType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferCategoryAccountType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferCategoryAccountType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferCategoryAccountType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferCategoryAccountType" } } } } } } }, "/api/FinanceTransferCategoryAccountType/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "FinanceTransferCategoryAccountType" ], "summary": "FinanceTransferCategoryAccountType: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferCategoryAccountType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferCategoryAccountType_GetPageByValue_88B88BE1958D", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceTransferCategoryAccountType/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "FinanceTransferCategoryAccountType" ], "summary": "FinanceTransferCategoryAccountType: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferCategoryAccountType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferCategoryAccountType_GetPageByValue2_3A91357AE0F7", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceTransferCategoryAccountType/DeleteByFilter": { "post": { "tags": [ "FinanceTransferCategoryAccountType" ], "summary": "FinanceTransferCategoryAccountType: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferCategoryAccountType-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferCategoryAccountType_DeleteByFilter_45B19F01597C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/FinanceTransferCategoryAccountType/GetAllByValue": { "post": { "tags": [ "FinanceTransferCategoryAccountType" ], "summary": "FinanceTransferCategoryAccountType: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferCategoryAccountType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferCategoryAccountType_GetAllByValue_2049FDFB6FEC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferCategoryAccountType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferCategoryAccountType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferCategoryAccountType" } } } } } } }, "/api/FinanceTransferCategoryAccountType/GetAllGraphByValue": { "post": { "tags": [ "FinanceTransferCategoryAccountType" ], "summary": "FinanceTransferCategoryAccountType: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferCategoryAccountType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferCategoryAccountType_GetAllGraphByValue_595EB3C6AB82", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferCategoryAccountType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferCategoryAccountType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferCategoryAccountType" } } } } } } }, "/api/FinanceTransferCategoryAccountType/GetByValue": { "post": { "tags": [ "FinanceTransferCategoryAccountType" ], "summary": "FinanceTransferCategoryAccountType: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferCategoryAccountType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferCategoryAccountType_GetByValue_A6726931CDF2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferCategoryAccountType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferCategoryAccountType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferCategoryAccountType" } } } } } } }, "/api/FinanceTransferCategoryAccountType/GetLookup": { "post": { "tags": [ "FinanceTransferCategoryAccountType" ], "summary": "FinanceTransferCategoryAccountType: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferCategoryAccountType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferCategoryAccountType_GetLookup_9EE805A5B57C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceTransferCategoryAccountType/GetLookupByValue": { "post": { "tags": [ "FinanceTransferCategoryAccountType" ], "summary": "FinanceTransferCategoryAccountType: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferCategoryAccountType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferCategoryAccountType_GetLookupByValue_F07C52C35DF9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceTransferCategoryAccountType/Page": { "get": { "tags": [ "FinanceTransferCategoryAccountType" ], "summary": "FinanceTransferCategoryAccountType: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferCategoryAccountType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferCategoryAccountType_GetPage_3231025F54CF", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceTransferCategoryAccountType/PageAsc": { "get": { "tags": [ "FinanceTransferCategoryAccountType" ], "summary": "FinanceTransferCategoryAccountType: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferCategoryAccountType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferCategoryAccountType_GetPageAsc_F3D0E66988A2", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceTransferCategoryAccountType/SearchByValue": { "post": { "tags": [ "FinanceTransferCategoryAccountType" ], "summary": "FinanceTransferCategoryAccountType: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferCategoryAccountType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferCategoryAccountType_SearchByValue_93EB0A5F602B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceTransferCategoryAccountType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceTransferCategoryAccountType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceTransferCategoryAccountType" } } } } } } }, "/api/FinanceTransferCategoryAccountType/TryGetByValue": { "post": { "tags": [ "FinanceTransferCategoryAccountType" ], "summary": "FinanceTransferCategoryAccountType: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferCategoryAccountType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferCategoryAccountType_TryGetByValue_6440F4279771", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferCategoryAccountType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferCategoryAccountType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferCategoryAccountType" } } } } } } }, "/api/FinanceTransferCategoryAccountType/UpsertGraph": { "put": { "tags": [ "FinanceTransferCategoryAccountType" ], "summary": "FinanceTransferCategoryAccountType: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferCategoryAccountType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferCategoryAccountType_UpsertGraph_912F7B122386", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferCategoryAccountType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferCategoryAccountType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferCategoryAccountType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferCategoryAccountType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferCategoryAccountType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferCategoryAccountType" } } } } } } }, "/api/FinanceTransferCategoryAccountType/UpsertGraphWithExtraFields": { "put": { "tags": [ "FinanceTransferCategoryAccountType" ], "summary": "FinanceTransferCategoryAccountType: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferCategoryAccountType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferCategoryAccountType_UpsertGraphWithExtraFields_A4360517BC2E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransferCategoryAccountType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransferCategoryAccountType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransferCategoryAccountType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransferCategoryAccountType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransferCategoryAccountType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransferCategoryAccountType" } } } } } } }, "/api/FinanceTransferPosition": { "get": { "tags": [ "FinanceTransferPosition" ], "summary": "FinanceTransferPosition: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPosition_GetAll_23C7B9D2FF6C", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferPosition" } } } } } }, "post": { "tags": [ "FinanceTransferPosition" ], "summary": "FinanceTransferPosition: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPosition-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPosition_Post_46719D73A6DA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPosition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPosition" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferPosition" } } } } } }, "put": { "tags": [ "FinanceTransferPosition" ], "summary": "FinanceTransferPosition: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPosition-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPosition_Put_47D99CBB46A6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPosition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPosition" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferPosition" } } } } } } }, "/api/FinanceTransferPosition/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "FinanceTransferPosition" ], "summary": "FinanceTransferPosition: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPosition_GetPageByValue_E68DF42561C2", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceTransferPosition/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "FinanceTransferPosition" ], "summary": "FinanceTransferPosition: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPosition_GetPageByValue2_218168DF3853", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceTransferPosition/DeleteByFilter": { "post": { "tags": [ "FinanceTransferPosition" ], "summary": "FinanceTransferPosition: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPosition-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPosition_DeleteByFilter_3E32034A8DF7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/FinanceTransferPosition/DeletePosition": { "post": { "tags": [ "FinanceTransferPosition" ], "summary": "FinanceTransferPosition: DeletePosition", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPosition-Delete.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPosition_DeletePosition_9CBC58D80DFF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPosition_DeletePositionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPosition_DeletePositionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPosition_DeletePositionRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/FinanceTransferPosition/GetAllByValue": { "post": { "tags": [ "FinanceTransferPosition" ], "summary": "FinanceTransferPosition: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPosition_GetAllByValue_0586F20E846E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferPosition" } } } } } } }, "/api/FinanceTransferPosition/GetAllFromViewByValue": { "post": { "tags": [ "FinanceTransferPosition" ], "summary": "FinanceTransferPosition: GetAllFromViewByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPosition-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPosition_GetAllFromViewByValue_8E68CD2003D3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPosition_GetAllFromViewByValueRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPosition_GetAllFromViewByValueRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPosition_GetAllFromViewByValueRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW660_FinanceTransferPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW660_FinanceTransferPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW660_FinanceTransferPosition" } } } } } } }, "/api/FinanceTransferPosition/GetAllGraphByValue": { "post": { "tags": [ "FinanceTransferPosition" ], "summary": "FinanceTransferPosition: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPosition_GetAllGraphByValue_15F399D45355", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferPosition" } } } } } } }, "/api/FinanceTransferPosition/GetByValue": { "post": { "tags": [ "FinanceTransferPosition" ], "summary": "FinanceTransferPosition: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPosition_GetByValue_345F3A3D13D2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferPosition" } } } } } } }, "/api/FinanceTransferPosition/GetLookup": { "post": { "tags": [ "FinanceTransferPosition" ], "summary": "FinanceTransferPosition: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPosition_GetLookup_C8991DDAFB74", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceTransferPosition/GetLookupByValue": { "post": { "tags": [ "FinanceTransferPosition" ], "summary": "FinanceTransferPosition: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPosition_GetLookupByValue_DD1B1E4E6A4C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceTransferPosition/Import": { "post": { "tags": [ "FinanceTransferPosition" ], "summary": "FinanceTransferPosition: Import", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPosition-Create.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPosition_Import_6C45F259346D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPosition_ImportRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPosition_ImportRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPosition_ImportRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/FinanceTransferPosition/InsertPosition": { "post": { "tags": [ "FinanceTransferPosition" ], "summary": "FinanceTransferPosition: InsertPosition", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPosition-Create.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPosition_InsertPosition_9F447157CA02", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPosition_InsertPositionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPosition_InsertPositionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPosition_InsertPositionRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/FinanceTransferPosition/Page": { "get": { "tags": [ "FinanceTransferPosition" ], "summary": "FinanceTransferPosition: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPosition_GetPage_58150FFC2FA2", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceTransferPosition/PageAsc": { "get": { "tags": [ "FinanceTransferPosition" ], "summary": "FinanceTransferPosition: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPosition_GetPageAsc_3A928C75260E", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceTransferPosition/PageFromView": { "get": { "tags": [ "FinanceTransferPosition" ], "summary": "FinanceTransferPosition: GetPageFromView", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPosition-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPosition_GetPageFromView_524B437F9416", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceTransferPosition/SearchByValue": { "post": { "tags": [ "FinanceTransferPosition" ], "summary": "FinanceTransferPosition: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPosition_SearchByValue_A0D4493CE93C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceTransferPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceTransferPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceTransferPosition" } } } } } } }, "/api/FinanceTransferPosition/TryGetByValue": { "post": { "tags": [ "FinanceTransferPosition" ], "summary": "FinanceTransferPosition: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPosition_TryGetByValue_9F80473ACBBF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferPosition" } } } } } } }, "/api/FinanceTransferPosition/UpdateAccountId": { "post": { "tags": [ "FinanceTransferPosition" ], "summary": "FinanceTransferPosition: UpdateAccountId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPosition-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPosition_UpdateAccountId_E4E94B3B542E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPosition_UpdateAccountIdRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPosition_UpdateAccountIdRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPosition_UpdateAccountIdRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/FinanceTransferPosition/UpdateAmount": { "post": { "tags": [ "FinanceTransferPosition" ], "summary": "FinanceTransferPosition: UpdateAmount", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPosition-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPosition_UpdateAmount_6E555CD35234", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPosition_UpdateAmountRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPosition_UpdateAmountRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPosition_UpdateAmountRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/FinanceTransferPosition/UpdateCustomerId": { "post": { "tags": [ "FinanceTransferPosition" ], "summary": "FinanceTransferPosition: UpdateCustomerId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPosition-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPosition_UpdateCustomerId_96ABE5A61142", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPosition_UpdateCustomerIdRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPosition_UpdateCustomerIdRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPosition_UpdateCustomerIdRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/FinanceTransferPosition/UpdateForeignCurrencyAmount": { "post": { "tags": [ "FinanceTransferPosition" ], "summary": "FinanceTransferPosition: UpdateForeignCurrencyAmount", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPosition-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPosition_UpdateForeignCurrencyAmount_28F816C06A07", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPosition_UpdateForeignCurrencyAmountRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPosition_UpdateForeignCurrencyAmountRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPosition_UpdateForeignCurrencyAmountRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/FinanceTransferPosition/UpdateMemo1": { "post": { "tags": [ "FinanceTransferPosition" ], "summary": "FinanceTransferPosition: UpdateMemo1", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPosition-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPosition_UpdateMemo1_F28E9E678364", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPosition_UpdateMemo1Request" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPosition_UpdateMemo1Request" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPosition_UpdateMemo1Request" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/FinanceTransferPosition/UpdateName": { "post": { "tags": [ "FinanceTransferPosition" ], "summary": "FinanceTransferPosition: UpdateName", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPosition-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPosition_UpdateName_B859D574AB52", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPosition_UpdateNameRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPosition_UpdateNameRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPosition_UpdateNameRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/FinanceTransferPosition/UpdatePostingPeriodId": { "post": { "tags": [ "FinanceTransferPosition" ], "summary": "FinanceTransferPosition: UpdatePostingPeriodId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPosition-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPosition_UpdatePostingPeriodId_120F6C9C1BF7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPosition_UpdatePostingPeriodIdRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPosition_UpdatePostingPeriodIdRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPosition_UpdatePostingPeriodIdRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/FinanceTransferPosition/UpdateRate": { "post": { "tags": [ "FinanceTransferPosition" ], "summary": "FinanceTransferPosition: UpdateRate", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPosition-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPosition_UpdateRate_CFEEF3BA521A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPosition_UpdateRateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPosition_UpdateRateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPosition_UpdateRateRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/FinanceTransferPosition/UpdateStatementDate": { "post": { "tags": [ "FinanceTransferPosition" ], "summary": "FinanceTransferPosition: UpdateStatementDate", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPosition-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPosition_UpdateStatementDate_0CAF9F637A0C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPosition_UpdateStatementDateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPosition_UpdateStatementDateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPosition_UpdateStatementDateRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/FinanceTransferPosition/UpdateSupplierId": { "post": { "tags": [ "FinanceTransferPosition" ], "summary": "FinanceTransferPosition: UpdateSupplierId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPosition-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPosition_UpdateSupplierId_B1BC4B0FCC0B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPosition_UpdateSupplierIdRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPosition_UpdateSupplierIdRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPosition_UpdateSupplierIdRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/FinanceTransferPosition/UpsertGraph": { "put": { "tags": [ "FinanceTransferPosition" ], "summary": "FinanceTransferPosition: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPosition-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPosition_UpsertGraph_910B1BB8BBC0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPosition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPosition" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferPosition" } } } } } } }, "/api/FinanceTransferPosition/UpsertGraphWithExtraFields": { "put": { "tags": [ "FinanceTransferPosition" ], "summary": "FinanceTransferPosition: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPosition-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPosition_UpsertGraphWithExtraFields_659E46A4902A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransferPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransferPosition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransferPosition" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransferPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransferPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransferPosition" } } } } } } }, "/api/FinanceTransferPositionAccountPlan": { "get": { "tags": [ "FinanceTransferPositionAccountPlan" ], "summary": "FinanceTransferPositionAccountPlan: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPositionAccountPlan-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPositionAccountPlan_GetAll_A5F3DFDB9350", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferPositionAccountPlan" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferPositionAccountPlan" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferPositionAccountPlan" } } } } } }, "post": { "tags": [ "FinanceTransferPositionAccountPlan" ], "summary": "FinanceTransferPositionAccountPlan: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPositionAccountPlan-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPositionAccountPlan_Post_4044D34CC470", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionAccountPlan" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionAccountPlan" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionAccountPlan" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferPositionAccountPlan" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferPositionAccountPlan" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferPositionAccountPlan" } } } } } }, "put": { "tags": [ "FinanceTransferPositionAccountPlan" ], "summary": "FinanceTransferPositionAccountPlan: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPositionAccountPlan-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPositionAccountPlan_Put_647F6714BE13", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionAccountPlan" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionAccountPlan" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionAccountPlan" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferPositionAccountPlan" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferPositionAccountPlan" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferPositionAccountPlan" } } } } } } }, "/api/FinanceTransferPositionAccountPlan/{FinanceTransferPositionId}/PageFromView": { "get": { "tags": [ "FinanceTransferPositionAccountPlan" ], "summary": "FinanceTransferPositionAccountPlan: GetPageFromView", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPositionAccountPlan-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPositionAccountPlan_GetPageFromView_AE8B005A1CDA", "parameters": [ { "name": "FinanceTransferPositionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceTransferPositionAccountPlan/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "FinanceTransferPositionAccountPlan" ], "summary": "FinanceTransferPositionAccountPlan: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPositionAccountPlan-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPositionAccountPlan_GetPageByValue_81EB4819DAAC", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceTransferPositionAccountPlan/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "FinanceTransferPositionAccountPlan" ], "summary": "FinanceTransferPositionAccountPlan: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPositionAccountPlan-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPositionAccountPlan_GetPageByValue2_6A93A78B2174", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceTransferPositionAccountPlan/Delete_FinanceTransferPositionAccountPlan": { "post": { "tags": [ "FinanceTransferPositionAccountPlan" ], "summary": "FinanceTransferPositionAccountPlan: Delete_FinanceTransferPositionAccountPlan", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPositionAccountPlan-Delete.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPositionAccountPlan_Delete_FinanceTransferPositionAccountPlan_1AEAC3049993", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionAccountPlan_DeleteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionAccountPlan_DeleteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionAccountPlan_DeleteRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/FinanceTransferPositionAccountPlan/DeleteByFilter": { "post": { "tags": [ "FinanceTransferPositionAccountPlan" ], "summary": "FinanceTransferPositionAccountPlan: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPositionAccountPlan-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPositionAccountPlan_DeleteByFilter_1AFE093A17BC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/FinanceTransferPositionAccountPlan/GetAllByValue": { "post": { "tags": [ "FinanceTransferPositionAccountPlan" ], "summary": "FinanceTransferPositionAccountPlan: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPositionAccountPlan-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPositionAccountPlan_GetAllByValue_89C297754B42", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferPositionAccountPlan" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferPositionAccountPlan" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferPositionAccountPlan" } } } } } } }, "/api/FinanceTransferPositionAccountPlan/GetAllFromViewByValue": { "post": { "tags": [ "FinanceTransferPositionAccountPlan" ], "summary": "FinanceTransferPositionAccountPlan: GetAllFromViewByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPositionAccountPlan-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPositionAccountPlan_GetAllFromViewByValue_7B1A1D23B44A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionAccountPlan_GetAllFromViewByValueRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionAccountPlan_GetAllFromViewByValueRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionAccountPlan_GetAllFromViewByValueRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW661_FinanceTransferPositionAccountPlan" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW661_FinanceTransferPositionAccountPlan" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW661_FinanceTransferPositionAccountPlan" } } } } } } }, "/api/FinanceTransferPositionAccountPlan/GetAllGraphByValue": { "post": { "tags": [ "FinanceTransferPositionAccountPlan" ], "summary": "FinanceTransferPositionAccountPlan: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPositionAccountPlan-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPositionAccountPlan_GetAllGraphByValue_9B4BC358BCD0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferPositionAccountPlan" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferPositionAccountPlan" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferPositionAccountPlan" } } } } } } }, "/api/FinanceTransferPositionAccountPlan/GetByValue": { "post": { "tags": [ "FinanceTransferPositionAccountPlan" ], "summary": "FinanceTransferPositionAccountPlan: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPositionAccountPlan-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPositionAccountPlan_GetByValue_4152BB180E77", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferPositionAccountPlan" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferPositionAccountPlan" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferPositionAccountPlan" } } } } } } }, "/api/FinanceTransferPositionAccountPlan/GetLookup": { "post": { "tags": [ "FinanceTransferPositionAccountPlan" ], "summary": "FinanceTransferPositionAccountPlan: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPositionAccountPlan-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPositionAccountPlan_GetLookup_F68EFB17F6AF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceTransferPositionAccountPlan/GetLookupByValue": { "post": { "tags": [ "FinanceTransferPositionAccountPlan" ], "summary": "FinanceTransferPositionAccountPlan: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPositionAccountPlan-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPositionAccountPlan_GetLookupByValue_A5F16DF27BF0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceTransferPositionAccountPlan/Insert_GeneralLedgerAccount": { "post": { "tags": [ "FinanceTransferPositionAccountPlan" ], "summary": "FinanceTransferPositionAccountPlan: Insert_GeneralLedgerAccount", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPositionAccountPlan-Create.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPositionAccountPlan_Insert_GeneralLedgerAccount_241B5B3416C1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionAccountPlan_InsertGeneralLedgerAccountRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionAccountPlan_InsertGeneralLedgerAccountRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionAccountPlan_InsertGeneralLedgerAccountRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/FinanceTransferPositionAccountPlan/Insert_PersonalAccount": { "post": { "tags": [ "FinanceTransferPositionAccountPlan" ], "summary": "FinanceTransferPositionAccountPlan: Insert_PersonalAccount", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPositionAccountPlan-Create.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPositionAccountPlan_Insert_PersonalAccount_3F0D5A724B93", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionAccountPlan_InsertPersonalAccountRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionAccountPlan_InsertPersonalAccountRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionAccountPlan_InsertPersonalAccountRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/FinanceTransferPositionAccountPlan/Page": { "get": { "tags": [ "FinanceTransferPositionAccountPlan" ], "summary": "FinanceTransferPositionAccountPlan: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPositionAccountPlan-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPositionAccountPlan_GetPage_A778A63DAAB0", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceTransferPositionAccountPlan/PageAsc": { "get": { "tags": [ "FinanceTransferPositionAccountPlan" ], "summary": "FinanceTransferPositionAccountPlan: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPositionAccountPlan-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPositionAccountPlan_GetPageAsc_FA7F79F57993", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceTransferPositionAccountPlan/SearchByValue": { "post": { "tags": [ "FinanceTransferPositionAccountPlan" ], "summary": "FinanceTransferPositionAccountPlan: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPositionAccountPlan-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPositionAccountPlan_SearchByValue_0BEF3D7F0B36", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceTransferPositionAccountPlan" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceTransferPositionAccountPlan" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceTransferPositionAccountPlan" } } } } } } }, "/api/FinanceTransferPositionAccountPlan/TryGetByValue": { "post": { "tags": [ "FinanceTransferPositionAccountPlan" ], "summary": "FinanceTransferPositionAccountPlan: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPositionAccountPlan-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPositionAccountPlan_TryGetByValue_BDBA2EF16344", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferPositionAccountPlan" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferPositionAccountPlan" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferPositionAccountPlan" } } } } } } }, "/api/FinanceTransferPositionAccountPlan/Update_Amount": { "post": { "tags": [ "FinanceTransferPositionAccountPlan" ], "summary": "FinanceTransferPositionAccountPlan: Update_Amount", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPositionAccountPlan-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPositionAccountPlan_Update_Amount_A1E647CE50F1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionAccountPlan_UpdateAmountRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionAccountPlan_UpdateAmountRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionAccountPlan_UpdateAmountRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/FinanceTransferPositionAccountPlan/Update_ForeignCurrencyAmount": { "post": { "tags": [ "FinanceTransferPositionAccountPlan" ], "summary": "FinanceTransferPositionAccountPlan: Update_ForeignCurrencyAmount", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPositionAccountPlan-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPositionAccountPlan_Update_ForeignCurrencyAmount_698442B800B7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionAccountPlan_UpdateForeignCurrencyAmountRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionAccountPlan_UpdateForeignCurrencyAmountRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionAccountPlan_UpdateForeignCurrencyAmountRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/FinanceTransferPositionAccountPlan/Update_TaxKeyId": { "post": { "tags": [ "FinanceTransferPositionAccountPlan" ], "summary": "FinanceTransferPositionAccountPlan: Update_TaxKeyId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPositionAccountPlan-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPositionAccountPlan_Update_TaxKeyId_5F8E601C6A36", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionAccountPlan_UpdateTaxKeyIdRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionAccountPlan_UpdateTaxKeyIdRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionAccountPlan_UpdateTaxKeyIdRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/FinanceTransferPositionAccountPlan/UpsertGraph": { "put": { "tags": [ "FinanceTransferPositionAccountPlan" ], "summary": "FinanceTransferPositionAccountPlan: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPositionAccountPlan-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPositionAccountPlan_UpsertGraph_C3838E49DB2D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionAccountPlan" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionAccountPlan" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionAccountPlan" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferPositionAccountPlan" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferPositionAccountPlan" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferPositionAccountPlan" } } } } } } }, "/api/FinanceTransferPositionAccountPlan/UpsertGraphWithExtraFields": { "put": { "tags": [ "FinanceTransferPositionAccountPlan" ], "summary": "FinanceTransferPositionAccountPlan: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPositionAccountPlan-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPositionAccountPlan_UpsertGraphWithExtraFields_861479D62F9D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransferPositionAccountPlan" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransferPositionAccountPlan" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransferPositionAccountPlan" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransferPositionAccountPlan" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransferPositionAccountPlan" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransferPositionAccountPlan" } } } } } } }, "/api/FinanceTransferPositionOpenItem": { "get": { "tags": [ "FinanceTransferPositionOpenItem" ], "summary": "FinanceTransferPositionOpenItem: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPositionOpenItem-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPositionOpenItem_GetAll_3C24279004A0", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferPositionOpenItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferPositionOpenItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferPositionOpenItem" } } } } } }, "post": { "tags": [ "FinanceTransferPositionOpenItem" ], "summary": "FinanceTransferPositionOpenItem: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPositionOpenItem-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPositionOpenItem_Post_CD80FD5AE1C1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionOpenItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionOpenItem" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionOpenItem" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferPositionOpenItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferPositionOpenItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferPositionOpenItem" } } } } } }, "put": { "tags": [ "FinanceTransferPositionOpenItem" ], "summary": "FinanceTransferPositionOpenItem: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPositionOpenItem-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPositionOpenItem_Put_C6A5C99B682D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionOpenItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionOpenItem" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionOpenItem" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferPositionOpenItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferPositionOpenItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferPositionOpenItem" } } } } } } }, "/api/FinanceTransferPositionOpenItem/{FinanceTransferPositionId}/PageFromView": { "get": { "tags": [ "FinanceTransferPositionOpenItem" ], "summary": "FinanceTransferPositionOpenItem: GetPageFromView", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPositionOpenItem-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPositionOpenItem_GetPageFromView_734B3485EC94", "parameters": [ { "name": "FinanceTransferPositionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceTransferPositionOpenItem/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "FinanceTransferPositionOpenItem" ], "summary": "FinanceTransferPositionOpenItem: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPositionOpenItem-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPositionOpenItem_GetPageByValue_81FEFB6BBCF7", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceTransferPositionOpenItem/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "FinanceTransferPositionOpenItem" ], "summary": "FinanceTransferPositionOpenItem: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPositionOpenItem-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPositionOpenItem_GetPageByValue2_4462D0BC70B7", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceTransferPositionOpenItem/Delete_FinanceTransferPositionOpenItem": { "post": { "tags": [ "FinanceTransferPositionOpenItem" ], "summary": "FinanceTransferPositionOpenItem: Delete_FinanceTransferPositionOpenItem", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPositionOpenItem-Delete.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPositionOpenItem_Delete_FinanceTransferPositionOpenItem_3E536E649ECE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionOpenItem_DeleteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionOpenItem_DeleteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionOpenItem_DeleteRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/FinanceTransferPositionOpenItem/DeleteByFilter": { "post": { "tags": [ "FinanceTransferPositionOpenItem" ], "summary": "FinanceTransferPositionOpenItem: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPositionOpenItem-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPositionOpenItem_DeleteByFilter_B8CB8AC08A88", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/FinanceTransferPositionOpenItem/GetAllByValue": { "post": { "tags": [ "FinanceTransferPositionOpenItem" ], "summary": "FinanceTransferPositionOpenItem: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPositionOpenItem-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPositionOpenItem_GetAllByValue_5957050101B4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferPositionOpenItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferPositionOpenItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferPositionOpenItem" } } } } } } }, "/api/FinanceTransferPositionOpenItem/GetAllFromViewByValue": { "post": { "tags": [ "FinanceTransferPositionOpenItem" ], "summary": "FinanceTransferPositionOpenItem: GetAllFromViewByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPositionOpenItem-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPositionOpenItem_GetAllFromViewByValue_73004D05310F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionOpenItem_GetAllFromViewByValueRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionOpenItem_GetAllFromViewByValueRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionOpenItem_GetAllFromViewByValueRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW662_FinanceTransferPositionOpenItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW662_FinanceTransferPositionOpenItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW662_FinanceTransferPositionOpenItem" } } } } } } }, "/api/FinanceTransferPositionOpenItem/GetAllGraphByValue": { "post": { "tags": [ "FinanceTransferPositionOpenItem" ], "summary": "FinanceTransferPositionOpenItem: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPositionOpenItem-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPositionOpenItem_GetAllGraphByValue_6FD99C757780", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferPositionOpenItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferPositionOpenItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferPositionOpenItem" } } } } } } }, "/api/FinanceTransferPositionOpenItem/GetByValue": { "post": { "tags": [ "FinanceTransferPositionOpenItem" ], "summary": "FinanceTransferPositionOpenItem: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPositionOpenItem-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPositionOpenItem_GetByValue_6480D8F1C98F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferPositionOpenItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferPositionOpenItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferPositionOpenItem" } } } } } } }, "/api/FinanceTransferPositionOpenItem/GetLookup": { "post": { "tags": [ "FinanceTransferPositionOpenItem" ], "summary": "FinanceTransferPositionOpenItem: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPositionOpenItem-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPositionOpenItem_GetLookup_8865D6C6926D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceTransferPositionOpenItem/GetLookupByValue": { "post": { "tags": [ "FinanceTransferPositionOpenItem" ], "summary": "FinanceTransferPositionOpenItem: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPositionOpenItem-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPositionOpenItem_GetLookupByValue_E575FB616CDF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceTransferPositionOpenItem/Insert_FinanceTransferPositionOpenItem": { "post": { "tags": [ "FinanceTransferPositionOpenItem" ], "summary": "FinanceTransferPositionOpenItem: Insert_FinanceTransferPositionOpenItem", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPositionOpenItem-Create.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPositionOpenItem_Insert_FinanceTransferPositionOpenItem_9814771BAB92", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionOpenItem_InsertRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionOpenItem_InsertRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionOpenItem_InsertRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/FinanceTransferPositionOpenItem/Page": { "get": { "tags": [ "FinanceTransferPositionOpenItem" ], "summary": "FinanceTransferPositionOpenItem: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPositionOpenItem-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPositionOpenItem_GetPage_5EC2E85039CE", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceTransferPositionOpenItem/PageAsc": { "get": { "tags": [ "FinanceTransferPositionOpenItem" ], "summary": "FinanceTransferPositionOpenItem: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPositionOpenItem-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPositionOpenItem_GetPageAsc_9356D349868E", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceTransferPositionOpenItem/SearchByValue": { "post": { "tags": [ "FinanceTransferPositionOpenItem" ], "summary": "FinanceTransferPositionOpenItem: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPositionOpenItem-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPositionOpenItem_SearchByValue_6A518A9D20D6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceTransferPositionOpenItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceTransferPositionOpenItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceTransferPositionOpenItem" } } } } } } }, "/api/FinanceTransferPositionOpenItem/TryGetByValue": { "post": { "tags": [ "FinanceTransferPositionOpenItem" ], "summary": "FinanceTransferPositionOpenItem: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPositionOpenItem-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPositionOpenItem_TryGetByValue_05CE984DC2FE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferPositionOpenItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferPositionOpenItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferPositionOpenItem" } } } } } } }, "/api/FinanceTransferPositionOpenItem/Update_Amount": { "post": { "tags": [ "FinanceTransferPositionOpenItem" ], "summary": "FinanceTransferPositionOpenItem: Update_Amount", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPositionOpenItem-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPositionOpenItem_Update_Amount_1D744246AF89", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionOpenItem_UpdateAmountRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionOpenItem_UpdateAmountRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionOpenItem_UpdateAmountRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/FinanceTransferPositionOpenItem/Update_CashDiscountAmount": { "post": { "tags": [ "FinanceTransferPositionOpenItem" ], "summary": "FinanceTransferPositionOpenItem: Update_CashDiscountAmount", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPositionOpenItem-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPositionOpenItem_Update_CashDiscountAmount_1C4D75699D73", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionOpenItem_UpdateCashDiscountAmountRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionOpenItem_UpdateCashDiscountAmountRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionOpenItem_UpdateCashDiscountAmountRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/FinanceTransferPositionOpenItem/Update_CurrencyDifference": { "post": { "tags": [ "FinanceTransferPositionOpenItem" ], "summary": "FinanceTransferPositionOpenItem: Update_CurrencyDifference", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPositionOpenItem-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPositionOpenItem_Update_CurrencyDifference_2E5D7FAE0514", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionOpenItem_UpdateCurrencyDifferenceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionOpenItem_UpdateCurrencyDifferenceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionOpenItem_UpdateCurrencyDifferenceRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/FinanceTransferPositionOpenItem/Update_CurrencyDifferenceAccountId": { "post": { "tags": [ "FinanceTransferPositionOpenItem" ], "summary": "FinanceTransferPositionOpenItem: Update_CurrencyDifferenceAccountId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPositionOpenItem-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPositionOpenItem_Update_CurrencyDifferenceAccountId_E7F1F0C6ADC6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionOpenItem_UpdateCurrencyDifferenceAccountIdRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionOpenItem_UpdateCurrencyDifferenceAccountIdRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionOpenItem_UpdateCurrencyDifferenceAccountIdRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/FinanceTransferPositionOpenItem/Update_CurrencyDifferenceSubject": { "post": { "tags": [ "FinanceTransferPositionOpenItem" ], "summary": "FinanceTransferPositionOpenItem: Update_CurrencyDifferenceSubject", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPositionOpenItem-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPositionOpenItem_Update_CurrencyDifferenceSubject_136E9CFFD79A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionOpenItem_UpdateCurrencyDifferenceSubjectRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionOpenItem_UpdateCurrencyDifferenceSubjectRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionOpenItem_UpdateCurrencyDifferenceSubjectRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/FinanceTransferPositionOpenItem/Update_ForeignCurrencyCashDiscountAmount": { "post": { "tags": [ "FinanceTransferPositionOpenItem" ], "summary": "FinanceTransferPositionOpenItem: Update_ForeignCurrencyCashDiscountAmount", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPositionOpenItem-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPositionOpenItem_Update_ForeignCurrencyCashDiscountAmount_3F5940C2F19B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionOpenItem_UpdateForeignCurrencyCashDiscountAmountRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionOpenItem_UpdateForeignCurrencyCashDiscountAmountRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionOpenItem_UpdateForeignCurrencyCashDiscountAmountRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/FinanceTransferPositionOpenItem/Update_ForeignCurrencyPaymentAmount": { "post": { "tags": [ "FinanceTransferPositionOpenItem" ], "summary": "FinanceTransferPositionOpenItem: Update_ForeignCurrencyPaymentAmount", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPositionOpenItem-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPositionOpenItem_Update_ForeignCurrencyPaymentAmount_053022FAF3FF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionOpenItem_UpdateForeignCurrencyPaymentAmountRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionOpenItem_UpdateForeignCurrencyPaymentAmountRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionOpenItem_UpdateForeignCurrencyPaymentAmountRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/FinanceTransferPositionOpenItem/UpsertGraph": { "put": { "tags": [ "FinanceTransferPositionOpenItem" ], "summary": "FinanceTransferPositionOpenItem: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPositionOpenItem-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPositionOpenItem_UpsertGraph_0A145C2E1337", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionOpenItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionOpenItem" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionOpenItem" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferPositionOpenItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferPositionOpenItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferPositionOpenItem" } } } } } } }, "/api/FinanceTransferPositionOpenItem/UpsertGraphWithExtraFields": { "put": { "tags": [ "FinanceTransferPositionOpenItem" ], "summary": "FinanceTransferPositionOpenItem: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPositionOpenItem-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPositionOpenItem_UpsertGraphWithExtraFields_E9F7963083D5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransferPositionOpenItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransferPositionOpenItem" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransferPositionOpenItem" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransferPositionOpenItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransferPositionOpenItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransferPositionOpenItem" } } } } } } }, "/api/FinanceTransferPositionTextKey": { "get": { "tags": [ "FinanceTransferPositionTextKey" ], "summary": "FinanceTransferPositionTextKey: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPositionTextKey-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPositionTextKey_GetAll_04D524D5BE9D", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferPositionTextKey" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferPositionTextKey" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferPositionTextKey" } } } } } }, "post": { "tags": [ "FinanceTransferPositionTextKey" ], "summary": "FinanceTransferPositionTextKey: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPositionTextKey-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPositionTextKey_Post_21C846686A2B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionTextKey" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionTextKey" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionTextKey" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferPositionTextKey" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferPositionTextKey" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferPositionTextKey" } } } } } }, "put": { "tags": [ "FinanceTransferPositionTextKey" ], "summary": "FinanceTransferPositionTextKey: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPositionTextKey-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPositionTextKey_Put_5C23F22CF45B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionTextKey" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionTextKey" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionTextKey" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferPositionTextKey" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferPositionTextKey" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferPositionTextKey" } } } } } } }, "/api/FinanceTransferPositionTextKey/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "FinanceTransferPositionTextKey" ], "summary": "FinanceTransferPositionTextKey: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPositionTextKey-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPositionTextKey_GetPageByValue_8A1662C3FE6D", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceTransferPositionTextKey/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "FinanceTransferPositionTextKey" ], "summary": "FinanceTransferPositionTextKey: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPositionTextKey-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPositionTextKey_GetPageByValue2_87699D3A4B6B", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceTransferPositionTextKey/DeleteByFilter": { "post": { "tags": [ "FinanceTransferPositionTextKey" ], "summary": "FinanceTransferPositionTextKey: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPositionTextKey-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPositionTextKey_DeleteByFilter_E75D17F2BB48", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/FinanceTransferPositionTextKey/GetAllByValue": { "post": { "tags": [ "FinanceTransferPositionTextKey" ], "summary": "FinanceTransferPositionTextKey: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPositionTextKey-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPositionTextKey_GetAllByValue_8B222E7B9C46", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferPositionTextKey" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferPositionTextKey" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferPositionTextKey" } } } } } } }, "/api/FinanceTransferPositionTextKey/GetAllGraphByValue": { "post": { "tags": [ "FinanceTransferPositionTextKey" ], "summary": "FinanceTransferPositionTextKey: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPositionTextKey-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPositionTextKey_GetAllGraphByValue_3005C499BC44", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferPositionTextKey" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferPositionTextKey" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferPositionTextKey" } } } } } } }, "/api/FinanceTransferPositionTextKey/GetByValue": { "post": { "tags": [ "FinanceTransferPositionTextKey" ], "summary": "FinanceTransferPositionTextKey: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPositionTextKey-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPositionTextKey_GetByValue_2C5085CAA7D9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferPositionTextKey" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferPositionTextKey" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferPositionTextKey" } } } } } } }, "/api/FinanceTransferPositionTextKey/GetLookup": { "post": { "tags": [ "FinanceTransferPositionTextKey" ], "summary": "FinanceTransferPositionTextKey: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPositionTextKey-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPositionTextKey_GetLookup_A32E03E6E4B2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceTransferPositionTextKey/GetLookupByValue": { "post": { "tags": [ "FinanceTransferPositionTextKey" ], "summary": "FinanceTransferPositionTextKey: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPositionTextKey-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPositionTextKey_GetLookupByValue_1F9878DDDCD9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceTransferPositionTextKey/Page": { "get": { "tags": [ "FinanceTransferPositionTextKey" ], "summary": "FinanceTransferPositionTextKey: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPositionTextKey-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPositionTextKey_GetPage_9721B206E2CB", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceTransferPositionTextKey/PageAsc": { "get": { "tags": [ "FinanceTransferPositionTextKey" ], "summary": "FinanceTransferPositionTextKey: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPositionTextKey-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPositionTextKey_GetPageAsc_ECBF6A8F9C10", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceTransferPositionTextKey/SearchByValue": { "post": { "tags": [ "FinanceTransferPositionTextKey" ], "summary": "FinanceTransferPositionTextKey: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPositionTextKey-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPositionTextKey_SearchByValue_01EFF767FB5D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceTransferPositionTextKey" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceTransferPositionTextKey" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceTransferPositionTextKey" } } } } } } }, "/api/FinanceTransferPositionTextKey/TryGetByValue": { "post": { "tags": [ "FinanceTransferPositionTextKey" ], "summary": "FinanceTransferPositionTextKey: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPositionTextKey-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPositionTextKey_TryGetByValue_73BD6AA29AED", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferPositionTextKey" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferPositionTextKey" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferPositionTextKey" } } } } } } }, "/api/FinanceTransferPositionTextKey/UpsertGraph": { "put": { "tags": [ "FinanceTransferPositionTextKey" ], "summary": "FinanceTransferPositionTextKey: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPositionTextKey-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPositionTextKey_UpsertGraph_A0FAD0C00530", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionTextKey" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionTextKey" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionTextKey" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferPositionTextKey" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferPositionTextKey" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferPositionTextKey" } } } } } } }, "/api/FinanceTransferPositionTextKey/UpsertGraphWithExtraFields": { "put": { "tags": [ "FinanceTransferPositionTextKey" ], "summary": "FinanceTransferPositionTextKey: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferPositionTextKey-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferPositionTextKey_UpsertGraphWithExtraFields_F6CC7BE1BDE1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransferPositionTextKey" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransferPositionTextKey" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransferPositionTextKey" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransferPositionTextKey" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransferPositionTextKey" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransferPositionTextKey" } } } } } } }, "/api/FinanceTransferSuggestion": { "get": { "tags": [ "FinanceTransferSuggestion" ], "summary": "FinanceTransferSuggestion: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferSuggestion-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferSuggestion_GetAll_F441E88653C4", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferSuggestion" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferSuggestion" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferSuggestion" } } } } } }, "post": { "tags": [ "FinanceTransferSuggestion" ], "summary": "FinanceTransferSuggestion: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferSuggestion-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferSuggestion_Post_6019E03181F0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferSuggestion" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferSuggestion" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferSuggestion" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferSuggestion" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferSuggestion" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferSuggestion" } } } } } }, "put": { "tags": [ "FinanceTransferSuggestion" ], "summary": "FinanceTransferSuggestion: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferSuggestion-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferSuggestion_Put_C8CD2290315A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferSuggestion" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferSuggestion" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferSuggestion" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferSuggestion" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferSuggestion" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferSuggestion" } } } } } } }, "/api/FinanceTransferSuggestion/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "FinanceTransferSuggestion" ], "summary": "FinanceTransferSuggestion: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferSuggestion-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferSuggestion_GetPageByValue_0E9C39F7C37F", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceTransferSuggestion/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "FinanceTransferSuggestion" ], "summary": "FinanceTransferSuggestion: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferSuggestion-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferSuggestion_GetPageByValue2_AFF5DA91B7CF", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceTransferSuggestion/DeleteByFilter": { "post": { "tags": [ "FinanceTransferSuggestion" ], "summary": "FinanceTransferSuggestion: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferSuggestion-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferSuggestion_DeleteByFilter_0105A8AE98A5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/FinanceTransferSuggestion/GetAllByValue": { "post": { "tags": [ "FinanceTransferSuggestion" ], "summary": "FinanceTransferSuggestion: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferSuggestion-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferSuggestion_GetAllByValue_138A74E16CB7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferSuggestion" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferSuggestion" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferSuggestion" } } } } } } }, "/api/FinanceTransferSuggestion/GetAllGraphByValue": { "post": { "tags": [ "FinanceTransferSuggestion" ], "summary": "FinanceTransferSuggestion: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferSuggestion-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferSuggestion_GetAllGraphByValue_EFF26E0BB29B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferSuggestion" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferSuggestion" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferSuggestion" } } } } } } }, "/api/FinanceTransferSuggestion/GetByValue": { "post": { "tags": [ "FinanceTransferSuggestion" ], "summary": "FinanceTransferSuggestion: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferSuggestion-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferSuggestion_GetByValue_A63724A9ED82", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferSuggestion" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferSuggestion" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferSuggestion" } } } } } } }, "/api/FinanceTransferSuggestion/GetLookup": { "post": { "tags": [ "FinanceTransferSuggestion" ], "summary": "FinanceTransferSuggestion: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferSuggestion-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferSuggestion_GetLookup_889196B25002", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceTransferSuggestion/GetLookupByValue": { "post": { "tags": [ "FinanceTransferSuggestion" ], "summary": "FinanceTransferSuggestion: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferSuggestion-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferSuggestion_GetLookupByValue_3A74EBDC4C10", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceTransferSuggestion/Page": { "get": { "tags": [ "FinanceTransferSuggestion" ], "summary": "FinanceTransferSuggestion: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferSuggestion-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferSuggestion_GetPage_802E6E9A5AD4", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceTransferSuggestion/PageAsc": { "get": { "tags": [ "FinanceTransferSuggestion" ], "summary": "FinanceTransferSuggestion: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferSuggestion-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferSuggestion_GetPageAsc_385A8D57D382", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceTransferSuggestion/SearchByValue": { "post": { "tags": [ "FinanceTransferSuggestion" ], "summary": "FinanceTransferSuggestion: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferSuggestion-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferSuggestion_SearchByValue_4A411174725D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceTransferSuggestion" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceTransferSuggestion" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceTransferSuggestion" } } } } } } }, "/api/FinanceTransferSuggestion/TryGetByValue": { "post": { "tags": [ "FinanceTransferSuggestion" ], "summary": "FinanceTransferSuggestion: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferSuggestion-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferSuggestion_TryGetByValue_F2108C647796", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferSuggestion" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferSuggestion" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferSuggestion" } } } } } } }, "/api/FinanceTransferSuggestion/UpsertGraph": { "put": { "tags": [ "FinanceTransferSuggestion" ], "summary": "FinanceTransferSuggestion: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferSuggestion-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferSuggestion_UpsertGraph_C5B8339F393B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferSuggestion" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferSuggestion" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferSuggestion" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferSuggestion" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferSuggestion" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferSuggestion" } } } } } } }, "/api/FinanceTransferSuggestion/UpsertGraphWithExtraFields": { "put": { "tags": [ "FinanceTransferSuggestion" ], "summary": "FinanceTransferSuggestion: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferSuggestion-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferSuggestion_UpsertGraphWithExtraFields_D1DE40B5D028", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransferSuggestion" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransferSuggestion" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransferSuggestion" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransferSuggestion" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransferSuggestion" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransferSuggestion" } } } } } } }, "/api/FinanceTransferSuggestionField": { "get": { "tags": [ "FinanceTransferSuggestionField" ], "summary": "FinanceTransferSuggestionField: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferSuggestionField-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferSuggestionField_GetAll_31D0D0AFDB6F", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferSuggestionField" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferSuggestionField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferSuggestionField" } } } } } }, "post": { "tags": [ "FinanceTransferSuggestionField" ], "summary": "FinanceTransferSuggestionField: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferSuggestionField-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferSuggestionField_Post_370806C1038A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferSuggestionField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferSuggestionField" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferSuggestionField" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferSuggestionField" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferSuggestionField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferSuggestionField" } } } } } }, "put": { "tags": [ "FinanceTransferSuggestionField" ], "summary": "FinanceTransferSuggestionField: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferSuggestionField-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferSuggestionField_Put_299E1093B315", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferSuggestionField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferSuggestionField" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferSuggestionField" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferSuggestionField" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferSuggestionField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferSuggestionField" } } } } } } }, "/api/FinanceTransferSuggestionField/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "FinanceTransferSuggestionField" ], "summary": "FinanceTransferSuggestionField: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferSuggestionField-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferSuggestionField_GetPageByValue_9062869FA4E4", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceTransferSuggestionField/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "FinanceTransferSuggestionField" ], "summary": "FinanceTransferSuggestionField: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferSuggestionField-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferSuggestionField_GetPageByValue2_EA35F58535A5", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceTransferSuggestionField/DeleteByFilter": { "post": { "tags": [ "FinanceTransferSuggestionField" ], "summary": "FinanceTransferSuggestionField: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferSuggestionField-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferSuggestionField_DeleteByFilter_75B0676EEF2B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/FinanceTransferSuggestionField/GetAllByValue": { "post": { "tags": [ "FinanceTransferSuggestionField" ], "summary": "FinanceTransferSuggestionField: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferSuggestionField-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferSuggestionField_GetAllByValue_6EBBC6E6D7CB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferSuggestionField" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferSuggestionField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferSuggestionField" } } } } } } }, "/api/FinanceTransferSuggestionField/GetAllGraphByValue": { "post": { "tags": [ "FinanceTransferSuggestionField" ], "summary": "FinanceTransferSuggestionField: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferSuggestionField-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferSuggestionField_GetAllGraphByValue_3D2BD45A737B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferSuggestionField" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferSuggestionField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferSuggestionField" } } } } } } }, "/api/FinanceTransferSuggestionField/GetByValue": { "post": { "tags": [ "FinanceTransferSuggestionField" ], "summary": "FinanceTransferSuggestionField: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferSuggestionField-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferSuggestionField_GetByValue_EE27BE27E385", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferSuggestionField" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferSuggestionField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferSuggestionField" } } } } } } }, "/api/FinanceTransferSuggestionField/GetLookup": { "post": { "tags": [ "FinanceTransferSuggestionField" ], "summary": "FinanceTransferSuggestionField: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferSuggestionField-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferSuggestionField_GetLookup_395662FC8CFF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceTransferSuggestionField/GetLookupByValue": { "post": { "tags": [ "FinanceTransferSuggestionField" ], "summary": "FinanceTransferSuggestionField: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferSuggestionField-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferSuggestionField_GetLookupByValue_7EF9D93FFA7F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FinanceTransferSuggestionField/Page": { "get": { "tags": [ "FinanceTransferSuggestionField" ], "summary": "FinanceTransferSuggestionField: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferSuggestionField-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferSuggestionField_GetPage_E4149BFD72A1", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceTransferSuggestionField/PageAsc": { "get": { "tags": [ "FinanceTransferSuggestionField" ], "summary": "FinanceTransferSuggestionField: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferSuggestionField-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferSuggestionField_GetPageAsc_3F0157AFFCBA", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FinanceTransferSuggestionField/SearchByValue": { "post": { "tags": [ "FinanceTransferSuggestionField" ], "summary": "FinanceTransferSuggestionField: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferSuggestionField-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferSuggestionField_SearchByValue_56DBE4BFC74F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceTransferSuggestionField" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceTransferSuggestionField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceTransferSuggestionField" } } } } } } }, "/api/FinanceTransferSuggestionField/TryGetByValue": { "post": { "tags": [ "FinanceTransferSuggestionField" ], "summary": "FinanceTransferSuggestionField: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferSuggestionField-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferSuggestionField_TryGetByValue_667819D7CB59", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferSuggestionField" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferSuggestionField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferSuggestionField" } } } } } } }, "/api/FinanceTransferSuggestionField/UpsertGraph": { "put": { "tags": [ "FinanceTransferSuggestionField" ], "summary": "FinanceTransferSuggestionField: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferSuggestionField-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferSuggestionField_UpsertGraph_8ABCCA037804", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferSuggestionField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferSuggestionField" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferSuggestionField" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferSuggestionField" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferSuggestionField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferSuggestionField" } } } } } } }, "/api/FinanceTransferSuggestionField/UpsertGraphWithExtraFields": { "put": { "tags": [ "FinanceTransferSuggestionField" ], "summary": "FinanceTransferSuggestionField: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FinanceTransferSuggestionField-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FinanceTransferSuggestionField_UpsertGraphWithExtraFields_068986F9A25E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransferSuggestionField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransferSuggestionField" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransferSuggestionField" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransferSuggestionField" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransferSuggestionField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransferSuggestionField" } } } } } } }, "/api/FormattedSearch": { "get": { "tags": [ "FormattedSearch" ], "summary": "FormattedSearch: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FormattedSearch-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FormattedSearch_GetAll_4AD929338AC3", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FormattedSearch" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FormattedSearch" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FormattedSearch" } } } } } }, "post": { "tags": [ "FormattedSearch" ], "summary": "FormattedSearch: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FormattedSearch-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FormattedSearch_Post_51BD22EE39CA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FormattedSearch" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FormattedSearch" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FormattedSearch" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FormattedSearch" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FormattedSearch" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FormattedSearch" } } } } } }, "put": { "tags": [ "FormattedSearch" ], "summary": "FormattedSearch: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FormattedSearch-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FormattedSearch_Put_781227D71310", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FormattedSearch" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FormattedSearch" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FormattedSearch" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FormattedSearch" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FormattedSearch" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FormattedSearch" } } } } } } }, "/api/FormattedSearch/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "FormattedSearch" ], "summary": "FormattedSearch: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FormattedSearch-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FormattedSearch_GetPageByValue_54A61C930146", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FormattedSearch/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "FormattedSearch" ], "summary": "FormattedSearch: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FormattedSearch-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FormattedSearch_GetPageByValue2_8B5B799C0AB0", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FormattedSearch/DeleteByFilter": { "post": { "tags": [ "FormattedSearch" ], "summary": "FormattedSearch: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FormattedSearch-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FormattedSearch_DeleteByFilter_4F167452528B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/FormattedSearch/GetAllByValue": { "post": { "tags": [ "FormattedSearch" ], "summary": "FormattedSearch: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FormattedSearch-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FormattedSearch_GetAllByValue_B6B1B04CFAF2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FormattedSearch" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FormattedSearch" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FormattedSearch" } } } } } } }, "/api/FormattedSearch/GetAllGraphByValue": { "post": { "tags": [ "FormattedSearch" ], "summary": "FormattedSearch: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FormattedSearch-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FormattedSearch_GetAllGraphByValue_3848D39ECC5E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FormattedSearch" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FormattedSearch" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FormattedSearch" } } } } } } }, "/api/FormattedSearch/GetByValue": { "post": { "tags": [ "FormattedSearch" ], "summary": "FormattedSearch: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FormattedSearch-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FormattedSearch_GetByValue_671FF43E28C6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FormattedSearch" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FormattedSearch" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FormattedSearch" } } } } } } }, "/api/FormattedSearch/GetLookup": { "post": { "tags": [ "FormattedSearch" ], "summary": "FormattedSearch: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FormattedSearch-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FormattedSearch_GetLookup_96CC61F2773F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FormattedSearch/GetLookupByValue": { "post": { "tags": [ "FormattedSearch" ], "summary": "FormattedSearch: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FormattedSearch-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FormattedSearch_GetLookupByValue_2B9B543D28E7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FormattedSearch/Page": { "get": { "tags": [ "FormattedSearch" ], "summary": "FormattedSearch: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FormattedSearch-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FormattedSearch_GetPage_163117DFC10F", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FormattedSearch/PageAsc": { "get": { "tags": [ "FormattedSearch" ], "summary": "FormattedSearch: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FormattedSearch-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FormattedSearch_GetPageAsc_3709322B36CE", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FormattedSearch/SearchByValue": { "post": { "tags": [ "FormattedSearch" ], "summary": "FormattedSearch: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FormattedSearch-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FormattedSearch_SearchByValue_573235F765F7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FormattedSearch" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FormattedSearch" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FormattedSearch" } } } } } } }, "/api/FormattedSearch/TryGetByValue": { "post": { "tags": [ "FormattedSearch" ], "summary": "FormattedSearch: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FormattedSearch-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FormattedSearch_TryGetByValue_0DD754BBB516", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FormattedSearch" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FormattedSearch" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FormattedSearch" } } } } } } }, "/api/FormattedSearch/UpsertGraph": { "put": { "tags": [ "FormattedSearch" ], "summary": "FormattedSearch: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FormattedSearch-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FormattedSearch_UpsertGraph_11633797E0E7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FormattedSearch" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FormattedSearch" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FormattedSearch" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FormattedSearch" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FormattedSearch" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FormattedSearch" } } } } } } }, "/api/FormattedSearch/UpsertGraphWithExtraFields": { "put": { "tags": [ "FormattedSearch" ], "summary": "FormattedSearch: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FormattedSearch-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FormattedSearch_UpsertGraphWithExtraFields_527B87D7B8C1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FormattedSearch" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FormattedSearch" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FormattedSearch" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FormattedSearch" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FormattedSearch" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FormattedSearch" } } } } } } }, "/api/FormattedSearchFireMode": { "get": { "tags": [ "FormattedSearchFireMode" ], "summary": "FormattedSearchFireMode: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FormattedSearchFireMode-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FormattedSearchFireMode_GetAll_C16AB108421A", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FormattedSearchFireMode" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FormattedSearchFireMode" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FormattedSearchFireMode" } } } } } }, "post": { "tags": [ "FormattedSearchFireMode" ], "summary": "FormattedSearchFireMode: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FormattedSearchFireMode-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FormattedSearchFireMode_Post_C9E9B576AFC5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FormattedSearchFireMode" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FormattedSearchFireMode" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FormattedSearchFireMode" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FormattedSearchFireMode" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FormattedSearchFireMode" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FormattedSearchFireMode" } } } } } }, "put": { "tags": [ "FormattedSearchFireMode" ], "summary": "FormattedSearchFireMode: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FormattedSearchFireMode-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FormattedSearchFireMode_Put_D2F4B077C116", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FormattedSearchFireMode" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FormattedSearchFireMode" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FormattedSearchFireMode" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FormattedSearchFireMode" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FormattedSearchFireMode" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FormattedSearchFireMode" } } } } } } }, "/api/FormattedSearchFireMode/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "FormattedSearchFireMode" ], "summary": "FormattedSearchFireMode: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FormattedSearchFireMode-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FormattedSearchFireMode_GetPageByValue_D65026E38E2D", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FormattedSearchFireMode/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "FormattedSearchFireMode" ], "summary": "FormattedSearchFireMode: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FormattedSearchFireMode-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FormattedSearchFireMode_GetPageByValue2_04A67C735760", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FormattedSearchFireMode/DeleteByFilter": { "post": { "tags": [ "FormattedSearchFireMode" ], "summary": "FormattedSearchFireMode: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FormattedSearchFireMode-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FormattedSearchFireMode_DeleteByFilter_4C784CC987B4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/FormattedSearchFireMode/GetAllByValue": { "post": { "tags": [ "FormattedSearchFireMode" ], "summary": "FormattedSearchFireMode: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FormattedSearchFireMode-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FormattedSearchFireMode_GetAllByValue_5143663D0E94", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FormattedSearchFireMode" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FormattedSearchFireMode" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FormattedSearchFireMode" } } } } } } }, "/api/FormattedSearchFireMode/GetAllGraphByValue": { "post": { "tags": [ "FormattedSearchFireMode" ], "summary": "FormattedSearchFireMode: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FormattedSearchFireMode-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FormattedSearchFireMode_GetAllGraphByValue_668A44B1F5F5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FormattedSearchFireMode" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FormattedSearchFireMode" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FormattedSearchFireMode" } } } } } } }, "/api/FormattedSearchFireMode/GetByValue": { "post": { "tags": [ "FormattedSearchFireMode" ], "summary": "FormattedSearchFireMode: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FormattedSearchFireMode-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FormattedSearchFireMode_GetByValue_D6CB1E7882FC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FormattedSearchFireMode" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FormattedSearchFireMode" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FormattedSearchFireMode" } } } } } } }, "/api/FormattedSearchFireMode/GetLookup": { "post": { "tags": [ "FormattedSearchFireMode" ], "summary": "FormattedSearchFireMode: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FormattedSearchFireMode-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FormattedSearchFireMode_GetLookup_55E598AD2D2A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FormattedSearchFireMode/GetLookupByValue": { "post": { "tags": [ "FormattedSearchFireMode" ], "summary": "FormattedSearchFireMode: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FormattedSearchFireMode-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FormattedSearchFireMode_GetLookupByValue_CEB4587C732B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/FormattedSearchFireMode/Page": { "get": { "tags": [ "FormattedSearchFireMode" ], "summary": "FormattedSearchFireMode: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FormattedSearchFireMode-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FormattedSearchFireMode_GetPage_4F8DE5D52F73", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FormattedSearchFireMode/PageAsc": { "get": { "tags": [ "FormattedSearchFireMode" ], "summary": "FormattedSearchFireMode: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FormattedSearchFireMode-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FormattedSearchFireMode_GetPageAsc_35913921071D", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FormattedSearchFireMode/SearchByValue": { "post": { "tags": [ "FormattedSearchFireMode" ], "summary": "FormattedSearchFireMode: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FormattedSearchFireMode-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FormattedSearchFireMode_SearchByValue_389FE6A99790", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FormattedSearchFireMode" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FormattedSearchFireMode" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FormattedSearchFireMode" } } } } } } }, "/api/FormattedSearchFireMode/TryGetByValue": { "post": { "tags": [ "FormattedSearchFireMode" ], "summary": "FormattedSearchFireMode: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FormattedSearchFireMode-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FormattedSearchFireMode_TryGetByValue_2FF4966C4FDA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FormattedSearchFireMode" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FormattedSearchFireMode" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FormattedSearchFireMode" } } } } } } }, "/api/FormattedSearchFireMode/UpsertGraph": { "put": { "tags": [ "FormattedSearchFireMode" ], "summary": "FormattedSearchFireMode: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FormattedSearchFireMode-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FormattedSearchFireMode_UpsertGraph_7965F199A18A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FormattedSearchFireMode" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FormattedSearchFireMode" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.FormattedSearchFireMode" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FormattedSearchFireMode" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FormattedSearchFireMode" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FormattedSearchFireMode" } } } } } } }, "/api/FormattedSearchFireMode/UpsertGraphWithExtraFields": { "put": { "tags": [ "FormattedSearchFireMode" ], "summary": "FormattedSearchFireMode: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: FormattedSearchFireMode-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "FormattedSearchFireMode_UpsertGraphWithExtraFields_2B450D1E04A2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FormattedSearchFireMode" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FormattedSearchFireMode" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FormattedSearchFireMode" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FormattedSearchFireMode" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FormattedSearchFireMode" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FormattedSearchFireMode" } } } } } } }, "/api/Helpdesk": { "get": { "tags": [ "Helpdesk" ], "summary": "Helpdesk: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Helpdesk-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Helpdesk_GetAll_F093301BC47E", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Helpdesk" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Helpdesk" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Helpdesk" } } } } } }, "post": { "tags": [ "Helpdesk" ], "summary": "Helpdesk: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Helpdesk-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Helpdesk_Post_242C6F601A51", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Helpdesk" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Helpdesk" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Helpdesk" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Helpdesk" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Helpdesk" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Helpdesk" } } } } } }, "put": { "tags": [ "Helpdesk" ], "summary": "Helpdesk: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Helpdesk-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Helpdesk_Put_CC2FD76AAAF7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Helpdesk" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Helpdesk" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Helpdesk" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Helpdesk" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Helpdesk" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Helpdesk" } } } } } } }, "/api/Helpdesk/{CategoryId}/{MySideOnly}/{IncludeSubNodes}/PageFromView": { "get": { "tags": [ "Helpdesk" ], "summary": "Helpdesk: GetPageFromView", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Helpdesk-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Helpdesk_GetPageFromView_FAB5B02A75C7", "parameters": [ { "name": "CategoryId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "MySideOnly", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "IncludeSubNodes", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Helpdesk/{PartnerId}/{MyHelpdesksOnly}/PageFromViewForPartner": { "get": { "tags": [ "Helpdesk" ], "summary": "Helpdesk: GetPageFromViewForPartner", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Helpdesk-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Helpdesk_GetPageFromViewForPartner_55686126A1EC", "parameters": [ { "name": "PartnerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "MyHelpdesksOnly", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Helpdesk/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "Helpdesk" ], "summary": "Helpdesk: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Helpdesk-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Helpdesk_GetPageByValue_33B9A496B325", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Helpdesk/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "Helpdesk" ], "summary": "Helpdesk: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Helpdesk-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Helpdesk_GetPageByValue2_2DB8EEDC2395", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Helpdesk/DeleteByFilter": { "post": { "tags": [ "Helpdesk" ], "summary": "Helpdesk: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Helpdesk-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Helpdesk_DeleteByFilter_CFB93C68E6B7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/Helpdesk/GetAllByValue": { "post": { "tags": [ "Helpdesk" ], "summary": "Helpdesk: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Helpdesk-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Helpdesk_GetAllByValue_F78611F4F025", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Helpdesk" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Helpdesk" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Helpdesk" } } } } } } }, "/api/Helpdesk/GetAllGraphByValue": { "post": { "tags": [ "Helpdesk" ], "summary": "Helpdesk: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Helpdesk-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Helpdesk_GetAllGraphByValue_0B4E40F3AE35", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Helpdesk" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Helpdesk" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Helpdesk" } } } } } } }, "/api/Helpdesk/GetByValue": { "post": { "tags": [ "Helpdesk" ], "summary": "Helpdesk: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Helpdesk-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Helpdesk_GetByValue_8BF21C9AE3E0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Helpdesk" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Helpdesk" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Helpdesk" } } } } } } }, "/api/Helpdesk/GetLookup": { "post": { "tags": [ "Helpdesk" ], "summary": "Helpdesk: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Helpdesk-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Helpdesk_GetLookup_B4122D107AFE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/Helpdesk/GetLookupByValue": { "post": { "tags": [ "Helpdesk" ], "summary": "Helpdesk: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Helpdesk-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Helpdesk_GetLookupByValue_30CBAF8B87BD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/Helpdesk/Page": { "get": { "tags": [ "Helpdesk" ], "summary": "Helpdesk: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Helpdesk-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Helpdesk_GetPage_0A09D191609C", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Helpdesk/PageAsc": { "get": { "tags": [ "Helpdesk" ], "summary": "Helpdesk: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Helpdesk-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Helpdesk_GetPageAsc_70D1AACC7E78", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Helpdesk/SearchByValue": { "post": { "tags": [ "Helpdesk" ], "summary": "Helpdesk: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Helpdesk-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Helpdesk_SearchByValue_35B547D7CDB1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.Helpdesk" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.Helpdesk" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.Helpdesk" } } } } } } }, "/api/Helpdesk/TryGetByValue": { "post": { "tags": [ "Helpdesk" ], "summary": "Helpdesk: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Helpdesk-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Helpdesk_TryGetByValue_28A0CD65810E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Helpdesk" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Helpdesk" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Helpdesk" } } } } } } }, "/api/Helpdesk/UpsertGraph": { "put": { "tags": [ "Helpdesk" ], "summary": "Helpdesk: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Helpdesk-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Helpdesk_UpsertGraph_DB99243F564C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Helpdesk" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Helpdesk" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Helpdesk" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Helpdesk" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Helpdesk" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Helpdesk" } } } } } } }, "/api/Helpdesk/UpsertGraphWithExtraFields": { "put": { "tags": [ "Helpdesk" ], "summary": "Helpdesk: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Helpdesk-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Helpdesk_UpsertGraphWithExtraFields_EDB504524F30", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Helpdesk" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Helpdesk" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Helpdesk" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Helpdesk" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Helpdesk" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Helpdesk" } } } } } } }, "/api/HelpdeskCategory": { "get": { "tags": [ "HelpdeskCategory" ], "summary": "HelpdeskCategory: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskCategory_GetAll_3D5BE9D9F58A", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskCategory" } } } } } }, "post": { "tags": [ "HelpdeskCategory" ], "summary": "HelpdeskCategory: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskCategory-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskCategory_Post_34B8593A0AC2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskCategory" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskCategory" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskCategory" } } } } } }, "put": { "tags": [ "HelpdeskCategory" ], "summary": "HelpdeskCategory: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskCategory-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskCategory_Put_2264529E8218", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskCategory" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskCategory" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskCategory" } } } } } } }, "/api/HelpdeskCategory/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "HelpdeskCategory" ], "summary": "HelpdeskCategory: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskCategory_GetPageByValue_B1689D337C2A", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/HelpdeskCategory/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "HelpdeskCategory" ], "summary": "HelpdeskCategory: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskCategory_GetPageByValue2_828C8CEAFBAA", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/HelpdeskCategory/DeleteByFilter": { "post": { "tags": [ "HelpdeskCategory" ], "summary": "HelpdeskCategory: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskCategory-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskCategory_DeleteByFilter_C9223E1172AD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/HelpdeskCategory/GetAllByValue": { "post": { "tags": [ "HelpdeskCategory" ], "summary": "HelpdeskCategory: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskCategory_GetAllByValue_4A321C20AEB8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskCategory" } } } } } } }, "/api/HelpdeskCategory/GetAllGraphByValue": { "post": { "tags": [ "HelpdeskCategory" ], "summary": "HelpdeskCategory: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskCategory_GetAllGraphByValue_F30E75813FDC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskCategory" } } } } } } }, "/api/HelpdeskCategory/GetByValue": { "post": { "tags": [ "HelpdeskCategory" ], "summary": "HelpdeskCategory: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskCategory_GetByValue_5FF2196EAF8B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskCategory" } } } } } } }, "/api/HelpdeskCategory/GetLookup": { "post": { "tags": [ "HelpdeskCategory" ], "summary": "HelpdeskCategory: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskCategory_GetLookup_5F4C2A0BB466", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/HelpdeskCategory/GetLookupByValue": { "post": { "tags": [ "HelpdeskCategory" ], "summary": "HelpdeskCategory: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskCategory_GetLookupByValue_16BB8979B543", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/HelpdeskCategory/Page": { "get": { "tags": [ "HelpdeskCategory" ], "summary": "HelpdeskCategory: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskCategory_GetPage_6F9C8E1DC0A7", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/HelpdeskCategory/PageAsc": { "get": { "tags": [ "HelpdeskCategory" ], "summary": "HelpdeskCategory: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskCategory_GetPageAsc_2754FFAE1817", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/HelpdeskCategory/PageHelpdeskCategorysByParent/{ParentId}/{IncludeSubNodes}/{TopParentsOnly}": { "get": { "tags": [ "HelpdeskCategory" ], "summary": "HelpdeskCategory: GetPageHelpdeskCategorysByParent", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskCategory-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskCategory_GetPageHelpdeskCategorysByParent_7804CB7813B0", "parameters": [ { "name": "ParentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "IncludeSubNodes", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "TopParentsOnly", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/HelpdeskCategory/SearchByValue": { "post": { "tags": [ "HelpdeskCategory" ], "summary": "HelpdeskCategory: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskCategory_SearchByValue_9BDFC1EB2969", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.HelpdeskCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.HelpdeskCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.HelpdeskCategory" } } } } } } }, "/api/HelpdeskCategory/TryGetByValue": { "post": { "tags": [ "HelpdeskCategory" ], "summary": "HelpdeskCategory: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskCategory_TryGetByValue_854513685EE6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskCategory" } } } } } } }, "/api/HelpdeskCategory/UpsertGraph": { "put": { "tags": [ "HelpdeskCategory" ], "summary": "HelpdeskCategory: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskCategory-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskCategory_UpsertGraph_F62F9A8BCDEC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskCategory" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskCategory" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskCategory" } } } } } } }, "/api/HelpdeskCategory/UpsertGraphWithExtraFields": { "put": { "tags": [ "HelpdeskCategory" ], "summary": "HelpdeskCategory: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskCategory-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskCategory_UpsertGraphWithExtraFields_65A65E9F2258", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskCategory" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskCategory" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskCategory" } } } } } } }, "/api/HelpdeskDialog": { "get": { "tags": [ "HelpdeskDialog" ], "summary": "HelpdeskDialog: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskDialog-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskDialog_GetAll_16DFB97792A7", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskDialog" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskDialog" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskDialog" } } } } } }, "post": { "tags": [ "HelpdeskDialog" ], "summary": "HelpdeskDialog: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskDialog-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskDialog_Post_2FFEE5A1890E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskDialog" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskDialog" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskDialog" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskDialog" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskDialog" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskDialog" } } } } } }, "put": { "tags": [ "HelpdeskDialog" ], "summary": "HelpdeskDialog: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskDialog-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskDialog_Put_2B34CA2931F5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskDialog" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskDialog" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskDialog" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskDialog" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskDialog" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskDialog" } } } } } } }, "/api/HelpdeskDialog/{HelpdeskId}/PageFromViewByHelpdeskId": { "get": { "tags": [ "HelpdeskDialog" ], "summary": "HelpdeskDialog: GetPageFromViewByArticleId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskDialog-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskDialog_GetPageFromViewByArticleId_DB13A21B8394", "parameters": [ { "name": "HelpdeskId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/HelpdeskDialog/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "HelpdeskDialog" ], "summary": "HelpdeskDialog: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskDialog-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskDialog_GetPageByValue_0AEAA06ED634", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/HelpdeskDialog/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "HelpdeskDialog" ], "summary": "HelpdeskDialog: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskDialog-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskDialog_GetPageByValue2_678783E87FF6", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/HelpdeskDialog/DeleteByFilter": { "post": { "tags": [ "HelpdeskDialog" ], "summary": "HelpdeskDialog: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskDialog-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskDialog_DeleteByFilter_EF93D2D44861", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/HelpdeskDialog/GetAllByValue": { "post": { "tags": [ "HelpdeskDialog" ], "summary": "HelpdeskDialog: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskDialog-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskDialog_GetAllByValue_8619F4F236BD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskDialog" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskDialog" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskDialog" } } } } } } }, "/api/HelpdeskDialog/GetAllGraphByValue": { "post": { "tags": [ "HelpdeskDialog" ], "summary": "HelpdeskDialog: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskDialog-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskDialog_GetAllGraphByValue_CAC05E861677", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskDialog" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskDialog" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskDialog" } } } } } } }, "/api/HelpdeskDialog/GetByValue": { "post": { "tags": [ "HelpdeskDialog" ], "summary": "HelpdeskDialog: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskDialog-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskDialog_GetByValue_A6FC9B45059E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskDialog" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskDialog" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskDialog" } } } } } } }, "/api/HelpdeskDialog/GetLookup": { "post": { "tags": [ "HelpdeskDialog" ], "summary": "HelpdeskDialog: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskDialog-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskDialog_GetLookup_1086DE7554DE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/HelpdeskDialog/GetLookupByValue": { "post": { "tags": [ "HelpdeskDialog" ], "summary": "HelpdeskDialog: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskDialog-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskDialog_GetLookupByValue_D3232AFF1200", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/HelpdeskDialog/Page": { "get": { "tags": [ "HelpdeskDialog" ], "summary": "HelpdeskDialog: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskDialog-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskDialog_GetPage_E80EE36F96D7", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/HelpdeskDialog/PageAsc": { "get": { "tags": [ "HelpdeskDialog" ], "summary": "HelpdeskDialog: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskDialog-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskDialog_GetPageAsc_0ECD8B37A9E5", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/HelpdeskDialog/SearchByValue": { "post": { "tags": [ "HelpdeskDialog" ], "summary": "HelpdeskDialog: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskDialog-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskDialog_SearchByValue_4E90E379ECCA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.HelpdeskDialog" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.HelpdeskDialog" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.HelpdeskDialog" } } } } } } }, "/api/HelpdeskDialog/TryGetByValue": { "post": { "tags": [ "HelpdeskDialog" ], "summary": "HelpdeskDialog: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskDialog-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskDialog_TryGetByValue_A75BCE9C8005", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskDialog" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskDialog" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskDialog" } } } } } } }, "/api/HelpdeskDialog/UpsertGraph": { "put": { "tags": [ "HelpdeskDialog" ], "summary": "HelpdeskDialog: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskDialog-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskDialog_UpsertGraph_CA8A01BCF85E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskDialog" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskDialog" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskDialog" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskDialog" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskDialog" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskDialog" } } } } } } }, "/api/HelpdeskDialog/UpsertGraphWithExtraFields": { "put": { "tags": [ "HelpdeskDialog" ], "summary": "HelpdeskDialog: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskDialog-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskDialog_UpsertGraphWithExtraFields_F2915D6243B8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskDialog" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskDialog" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskDialog" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskDialog" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskDialog" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskDialog" } } } } } } }, "/api/HelpdeskDialogProtocol": { "get": { "tags": [ "HelpdeskDialogProtocol" ], "summary": "HelpdeskDialogProtocol: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskDialogProtocol-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskDialogProtocol_GetAll_9445CB9AB37B", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskDialogProtocol" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskDialogProtocol" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskDialogProtocol" } } } } } }, "post": { "tags": [ "HelpdeskDialogProtocol" ], "summary": "HelpdeskDialogProtocol: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskDialogProtocol-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskDialogProtocol_Post_E05D79A464AD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskDialogProtocol" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskDialogProtocol" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskDialogProtocol" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskDialogProtocol" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskDialogProtocol" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskDialogProtocol" } } } } } }, "put": { "tags": [ "HelpdeskDialogProtocol" ], "summary": "HelpdeskDialogProtocol: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskDialogProtocol-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskDialogProtocol_Put_5B3B340A9555", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskDialogProtocol" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskDialogProtocol" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskDialogProtocol" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskDialogProtocol" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskDialogProtocol" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskDialogProtocol" } } } } } } }, "/api/HelpdeskDialogProtocol/{HelpdeskId}/PageByHelpdeskId": { "get": { "tags": [ "HelpdeskDialogProtocol" ], "summary": "HelpdeskDialogProtocol: GetPageByHelpdeskId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskDialogProtocol-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskDialogProtocol_GetPageByHelpdeskId_5C6F47F24DFD", "parameters": [ { "name": "HelpdeskId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/HelpdeskDialogProtocol/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "HelpdeskDialogProtocol" ], "summary": "HelpdeskDialogProtocol: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskDialogProtocol-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskDialogProtocol_GetPageByValue_F822BE132A63", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/HelpdeskDialogProtocol/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "HelpdeskDialogProtocol" ], "summary": "HelpdeskDialogProtocol: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskDialogProtocol-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskDialogProtocol_GetPageByValue2_D6F50FD4FC1F", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/HelpdeskDialogProtocol/DeleteByFilter": { "post": { "tags": [ "HelpdeskDialogProtocol" ], "summary": "HelpdeskDialogProtocol: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskDialogProtocol-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskDialogProtocol_DeleteByFilter_A7FAF1342128", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/HelpdeskDialogProtocol/GetAllByValue": { "post": { "tags": [ "HelpdeskDialogProtocol" ], "summary": "HelpdeskDialogProtocol: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskDialogProtocol-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskDialogProtocol_GetAllByValue_9C277B0E3F5C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskDialogProtocol" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskDialogProtocol" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskDialogProtocol" } } } } } } }, "/api/HelpdeskDialogProtocol/GetAllGraphByValue": { "post": { "tags": [ "HelpdeskDialogProtocol" ], "summary": "HelpdeskDialogProtocol: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskDialogProtocol-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskDialogProtocol_GetAllGraphByValue_5088F8F01712", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskDialogProtocol" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskDialogProtocol" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskDialogProtocol" } } } } } } }, "/api/HelpdeskDialogProtocol/GetByValue": { "post": { "tags": [ "HelpdeskDialogProtocol" ], "summary": "HelpdeskDialogProtocol: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskDialogProtocol-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskDialogProtocol_GetByValue_A5286B9E39D3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskDialogProtocol" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskDialogProtocol" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskDialogProtocol" } } } } } } }, "/api/HelpdeskDialogProtocol/GetLookup": { "post": { "tags": [ "HelpdeskDialogProtocol" ], "summary": "HelpdeskDialogProtocol: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskDialogProtocol-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskDialogProtocol_GetLookup_65831803604A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/HelpdeskDialogProtocol/GetLookupByValue": { "post": { "tags": [ "HelpdeskDialogProtocol" ], "summary": "HelpdeskDialogProtocol: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskDialogProtocol-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskDialogProtocol_GetLookupByValue_A1A07C782F58", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/HelpdeskDialogProtocol/Page": { "get": { "tags": [ "HelpdeskDialogProtocol" ], "summary": "HelpdeskDialogProtocol: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskDialogProtocol-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskDialogProtocol_GetPage_C81EDA2B95AC", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/HelpdeskDialogProtocol/PageAsc": { "get": { "tags": [ "HelpdeskDialogProtocol" ], "summary": "HelpdeskDialogProtocol: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskDialogProtocol-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskDialogProtocol_GetPageAsc_096DBEFE961F", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/HelpdeskDialogProtocol/SearchByValue": { "post": { "tags": [ "HelpdeskDialogProtocol" ], "summary": "HelpdeskDialogProtocol: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskDialogProtocol-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskDialogProtocol_SearchByValue_C1136A03AFDC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.HelpdeskDialogProtocol" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.HelpdeskDialogProtocol" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.HelpdeskDialogProtocol" } } } } } } }, "/api/HelpdeskDialogProtocol/TryGetByValue": { "post": { "tags": [ "HelpdeskDialogProtocol" ], "summary": "HelpdeskDialogProtocol: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskDialogProtocol-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskDialogProtocol_TryGetByValue_7EB8182F54BD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskDialogProtocol" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskDialogProtocol" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskDialogProtocol" } } } } } } }, "/api/HelpdeskDialogProtocol/UpsertGraph": { "put": { "tags": [ "HelpdeskDialogProtocol" ], "summary": "HelpdeskDialogProtocol: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskDialogProtocol-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskDialogProtocol_UpsertGraph_706D94AE4D6A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskDialogProtocol" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskDialogProtocol" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskDialogProtocol" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskDialogProtocol" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskDialogProtocol" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskDialogProtocol" } } } } } } }, "/api/HelpdeskDialogProtocol/UpsertGraphWithExtraFields": { "put": { "tags": [ "HelpdeskDialogProtocol" ], "summary": "HelpdeskDialogProtocol: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskDialogProtocol-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskDialogProtocol_UpsertGraphWithExtraFields_4E9E915420DF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskDialogProtocol" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskDialogProtocol" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskDialogProtocol" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskDialogProtocol" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskDialogProtocol" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskDialogProtocol" } } } } } } }, "/api/HelpdeskNotification": { "get": { "tags": [ "HelpdeskNotification" ], "summary": "HelpdeskNotification: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskNotification-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskNotification_GetAll_D1AE16527428", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskNotification" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskNotification" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskNotification" } } } } } }, "post": { "tags": [ "HelpdeskNotification" ], "summary": "HelpdeskNotification: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskNotification-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskNotification_Post_97C3CFC51485", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskNotification" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskNotification" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskNotification" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskNotification" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskNotification" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskNotification" } } } } } }, "put": { "tags": [ "HelpdeskNotification" ], "summary": "HelpdeskNotification: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskNotification-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskNotification_Put_E630CB31A136", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskNotification" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskNotification" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskNotification" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskNotification" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskNotification" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskNotification" } } } } } } }, "/api/HelpdeskNotification/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "HelpdeskNotification" ], "summary": "HelpdeskNotification: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskNotification-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskNotification_GetPageByValue_AFAD9E023F53", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/HelpdeskNotification/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "HelpdeskNotification" ], "summary": "HelpdeskNotification: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskNotification-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskNotification_GetPageByValue2_DBB65792ABCB", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/HelpdeskNotification/DeleteByFilter": { "post": { "tags": [ "HelpdeskNotification" ], "summary": "HelpdeskNotification: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskNotification-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskNotification_DeleteByFilter_3B8EC9E1FACE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/HelpdeskNotification/GetAllByValue": { "post": { "tags": [ "HelpdeskNotification" ], "summary": "HelpdeskNotification: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskNotification-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskNotification_GetAllByValue_74CDAABB0118", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskNotification" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskNotification" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskNotification" } } } } } } }, "/api/HelpdeskNotification/GetAllGraphByValue": { "post": { "tags": [ "HelpdeskNotification" ], "summary": "HelpdeskNotification: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskNotification-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskNotification_GetAllGraphByValue_B4C8C1AE9DB9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskNotification" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskNotification" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskNotification" } } } } } } }, "/api/HelpdeskNotification/GetByValue": { "post": { "tags": [ "HelpdeskNotification" ], "summary": "HelpdeskNotification: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskNotification-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskNotification_GetByValue_F061FA9412BC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskNotification" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskNotification" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskNotification" } } } } } } }, "/api/HelpdeskNotification/GetLookup": { "post": { "tags": [ "HelpdeskNotification" ], "summary": "HelpdeskNotification: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskNotification-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskNotification_GetLookup_7703FDAFE1ED", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/HelpdeskNotification/GetLookupByValue": { "post": { "tags": [ "HelpdeskNotification" ], "summary": "HelpdeskNotification: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskNotification-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskNotification_GetLookupByValue_36DC7D0A77A5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/HelpdeskNotification/Page": { "get": { "tags": [ "HelpdeskNotification" ], "summary": "HelpdeskNotification: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskNotification-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskNotification_GetPage_4298A4D5807C", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/HelpdeskNotification/PageAsc": { "get": { "tags": [ "HelpdeskNotification" ], "summary": "HelpdeskNotification: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskNotification-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskNotification_GetPageAsc_9D6755783719", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/HelpdeskNotification/SearchByValue": { "post": { "tags": [ "HelpdeskNotification" ], "summary": "HelpdeskNotification: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskNotification-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskNotification_SearchByValue_FF68D63B6AA0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.HelpdeskNotification" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.HelpdeskNotification" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.HelpdeskNotification" } } } } } } }, "/api/HelpdeskNotification/TryGetByValue": { "post": { "tags": [ "HelpdeskNotification" ], "summary": "HelpdeskNotification: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskNotification-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskNotification_TryGetByValue_3F602C506FF1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskNotification" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskNotification" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskNotification" } } } } } } }, "/api/HelpdeskNotification/UpsertGraph": { "put": { "tags": [ "HelpdeskNotification" ], "summary": "HelpdeskNotification: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskNotification-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskNotification_UpsertGraph_C07C3691FD9C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskNotification" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskNotification" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskNotification" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskNotification" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskNotification" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskNotification" } } } } } } }, "/api/HelpdeskNotification/UpsertGraphWithExtraFields": { "put": { "tags": [ "HelpdeskNotification" ], "summary": "HelpdeskNotification: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskNotification-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskNotification_UpsertGraphWithExtraFields_C34CFFBB3DF4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskNotification" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskNotification" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskNotification" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskNotification" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskNotification" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskNotification" } } } } } } }, "/api/HelpdeskNotificationEvent": { "get": { "tags": [ "HelpdeskNotificationEvent" ], "summary": "HelpdeskNotificationEvent: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskNotificationEvent-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskNotificationEvent_GetAll_47EE7A38DA5F", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskNotificationEvent" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskNotificationEvent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskNotificationEvent" } } } } } }, "post": { "tags": [ "HelpdeskNotificationEvent" ], "summary": "HelpdeskNotificationEvent: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskNotificationEvent-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskNotificationEvent_Post_3914C6FB0137", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskNotificationEvent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskNotificationEvent" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskNotificationEvent" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskNotificationEvent" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskNotificationEvent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskNotificationEvent" } } } } } }, "put": { "tags": [ "HelpdeskNotificationEvent" ], "summary": "HelpdeskNotificationEvent: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskNotificationEvent-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskNotificationEvent_Put_253378DE3BA3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskNotificationEvent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskNotificationEvent" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskNotificationEvent" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskNotificationEvent" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskNotificationEvent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskNotificationEvent" } } } } } } }, "/api/HelpdeskNotificationEvent/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "HelpdeskNotificationEvent" ], "summary": "HelpdeskNotificationEvent: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskNotificationEvent-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskNotificationEvent_GetPageByValue_7AC1B177DF5C", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/HelpdeskNotificationEvent/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "HelpdeskNotificationEvent" ], "summary": "HelpdeskNotificationEvent: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskNotificationEvent-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskNotificationEvent_GetPageByValue2_2C3AC17E4BFB", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/HelpdeskNotificationEvent/DeleteByFilter": { "post": { "tags": [ "HelpdeskNotificationEvent" ], "summary": "HelpdeskNotificationEvent: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskNotificationEvent-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskNotificationEvent_DeleteByFilter_075A7E9BDF72", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/HelpdeskNotificationEvent/GetAllByValue": { "post": { "tags": [ "HelpdeskNotificationEvent" ], "summary": "HelpdeskNotificationEvent: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskNotificationEvent-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskNotificationEvent_GetAllByValue_71345CF4C5CB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskNotificationEvent" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskNotificationEvent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskNotificationEvent" } } } } } } }, "/api/HelpdeskNotificationEvent/GetAllGraphByValue": { "post": { "tags": [ "HelpdeskNotificationEvent" ], "summary": "HelpdeskNotificationEvent: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskNotificationEvent-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskNotificationEvent_GetAllGraphByValue_45D3FC04D90E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskNotificationEvent" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskNotificationEvent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskNotificationEvent" } } } } } } }, "/api/HelpdeskNotificationEvent/GetByValue": { "post": { "tags": [ "HelpdeskNotificationEvent" ], "summary": "HelpdeskNotificationEvent: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskNotificationEvent-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskNotificationEvent_GetByValue_F1D09B3892A0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskNotificationEvent" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskNotificationEvent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskNotificationEvent" } } } } } } }, "/api/HelpdeskNotificationEvent/GetLookup": { "post": { "tags": [ "HelpdeskNotificationEvent" ], "summary": "HelpdeskNotificationEvent: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskNotificationEvent-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskNotificationEvent_GetLookup_67E66BD4AFA5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/HelpdeskNotificationEvent/GetLookupByValue": { "post": { "tags": [ "HelpdeskNotificationEvent" ], "summary": "HelpdeskNotificationEvent: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskNotificationEvent-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskNotificationEvent_GetLookupByValue_D8AD55B083FC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/HelpdeskNotificationEvent/Page": { "get": { "tags": [ "HelpdeskNotificationEvent" ], "summary": "HelpdeskNotificationEvent: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskNotificationEvent-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskNotificationEvent_GetPage_09D1B314FBE4", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/HelpdeskNotificationEvent/PageAsc": { "get": { "tags": [ "HelpdeskNotificationEvent" ], "summary": "HelpdeskNotificationEvent: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskNotificationEvent-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskNotificationEvent_GetPageAsc_A1FB1C36A9D9", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/HelpdeskNotificationEvent/SearchByValue": { "post": { "tags": [ "HelpdeskNotificationEvent" ], "summary": "HelpdeskNotificationEvent: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskNotificationEvent-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskNotificationEvent_SearchByValue_D9E20DA73723", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.HelpdeskNotificationEvent" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.HelpdeskNotificationEvent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.HelpdeskNotificationEvent" } } } } } } }, "/api/HelpdeskNotificationEvent/TryGetByValue": { "post": { "tags": [ "HelpdeskNotificationEvent" ], "summary": "HelpdeskNotificationEvent: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskNotificationEvent-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskNotificationEvent_TryGetByValue_A79DB58DB676", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskNotificationEvent" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskNotificationEvent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskNotificationEvent" } } } } } } }, "/api/HelpdeskNotificationEvent/UpsertGraph": { "put": { "tags": [ "HelpdeskNotificationEvent" ], "summary": "HelpdeskNotificationEvent: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskNotificationEvent-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskNotificationEvent_UpsertGraph_DBCC81D719AC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskNotificationEvent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskNotificationEvent" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskNotificationEvent" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskNotificationEvent" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskNotificationEvent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskNotificationEvent" } } } } } } }, "/api/HelpdeskNotificationEvent/UpsertGraphWithExtraFields": { "put": { "tags": [ "HelpdeskNotificationEvent" ], "summary": "HelpdeskNotificationEvent: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskNotificationEvent-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskNotificationEvent_UpsertGraphWithExtraFields_0D89A54426A6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskNotificationEvent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskNotificationEvent" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskNotificationEvent" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskNotificationEvent" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskNotificationEvent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskNotificationEvent" } } } } } } }, "/api/HelpdeskPrio": { "get": { "tags": [ "HelpdeskPrio" ], "summary": "HelpdeskPrio: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskPrio-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskPrio_GetAll_9D8F323B3987", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskPrio" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskPrio" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskPrio" } } } } } }, "post": { "tags": [ "HelpdeskPrio" ], "summary": "HelpdeskPrio: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskPrio-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskPrio_Post_7F6E15B904E9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskPrio" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskPrio" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskPrio" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskPrio" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskPrio" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskPrio" } } } } } }, "put": { "tags": [ "HelpdeskPrio" ], "summary": "HelpdeskPrio: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskPrio-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskPrio_Put_9F79E0823AED", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskPrio" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskPrio" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskPrio" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskPrio" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskPrio" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskPrio" } } } } } } }, "/api/HelpdeskPrio/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "HelpdeskPrio" ], "summary": "HelpdeskPrio: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskPrio-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskPrio_GetPageByValue_7E5E34D0EFB1", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/HelpdeskPrio/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "HelpdeskPrio" ], "summary": "HelpdeskPrio: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskPrio-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskPrio_GetPageByValue2_EE00C954FC20", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/HelpdeskPrio/DeleteByFilter": { "post": { "tags": [ "HelpdeskPrio" ], "summary": "HelpdeskPrio: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskPrio-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskPrio_DeleteByFilter_7FDC83218C3C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/HelpdeskPrio/GetAllByValue": { "post": { "tags": [ "HelpdeskPrio" ], "summary": "HelpdeskPrio: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskPrio-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskPrio_GetAllByValue_151820CC6BBF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskPrio" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskPrio" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskPrio" } } } } } } }, "/api/HelpdeskPrio/GetAllGraphByValue": { "post": { "tags": [ "HelpdeskPrio" ], "summary": "HelpdeskPrio: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskPrio-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskPrio_GetAllGraphByValue_70B518089D2A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskPrio" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskPrio" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskPrio" } } } } } } }, "/api/HelpdeskPrio/GetByValue": { "post": { "tags": [ "HelpdeskPrio" ], "summary": "HelpdeskPrio: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskPrio-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskPrio_GetByValue_430B7E9D919A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskPrio" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskPrio" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskPrio" } } } } } } }, "/api/HelpdeskPrio/GetLookup": { "post": { "tags": [ "HelpdeskPrio" ], "summary": "HelpdeskPrio: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskPrio-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskPrio_GetLookup_1FED2F40ACC5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/HelpdeskPrio/GetLookupByValue": { "post": { "tags": [ "HelpdeskPrio" ], "summary": "HelpdeskPrio: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskPrio-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskPrio_GetLookupByValue_16B020269E25", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/HelpdeskPrio/Page": { "get": { "tags": [ "HelpdeskPrio" ], "summary": "HelpdeskPrio: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskPrio-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskPrio_GetPage_E3AA2E65F303", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/HelpdeskPrio/PageAsc": { "get": { "tags": [ "HelpdeskPrio" ], "summary": "HelpdeskPrio: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskPrio-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskPrio_GetPageAsc_226E667A97DC", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/HelpdeskPrio/SearchByValue": { "post": { "tags": [ "HelpdeskPrio" ], "summary": "HelpdeskPrio: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskPrio-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskPrio_SearchByValue_98D3EE4B4CCC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.HelpdeskPrio" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.HelpdeskPrio" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.HelpdeskPrio" } } } } } } }, "/api/HelpdeskPrio/TryGetByValue": { "post": { "tags": [ "HelpdeskPrio" ], "summary": "HelpdeskPrio: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskPrio-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskPrio_TryGetByValue_AD32B71C553D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskPrio" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskPrio" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskPrio" } } } } } } }, "/api/HelpdeskPrio/UpsertGraph": { "put": { "tags": [ "HelpdeskPrio" ], "summary": "HelpdeskPrio: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskPrio-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskPrio_UpsertGraph_755B1E7A73CF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskPrio" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskPrio" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskPrio" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskPrio" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskPrio" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskPrio" } } } } } } }, "/api/HelpdeskPrio/UpsertGraphWithExtraFields": { "put": { "tags": [ "HelpdeskPrio" ], "summary": "HelpdeskPrio: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskPrio-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskPrio_UpsertGraphWithExtraFields_9DAF2239F9B1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskPrio" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskPrio" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskPrio" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskPrio" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskPrio" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskPrio" } } } } } } }, "/api/HelpdeskSetting": { "get": { "tags": [ "HelpdeskSetting" ], "summary": "HelpdeskSetting: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskSetting_GetAll_B83A153C1FE1", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskSetting" } } } } } }, "post": { "tags": [ "HelpdeskSetting" ], "summary": "HelpdeskSetting: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskSetting-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskSetting_Post_C6AE0C63060B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskSetting" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskSetting" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskSetting" } } } } } }, "put": { "tags": [ "HelpdeskSetting" ], "summary": "HelpdeskSetting: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskSetting-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskSetting_Put_AE402BB599B6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskSetting" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskSetting" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskSetting" } } } } } } }, "/api/HelpdeskSetting/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "HelpdeskSetting" ], "summary": "HelpdeskSetting: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskSetting_GetPageByValue_0E24575D8B39", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/HelpdeskSetting/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "HelpdeskSetting" ], "summary": "HelpdeskSetting: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskSetting_GetPageByValue2_4602D5AEF9E4", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/HelpdeskSetting/DeleteByFilter": { "post": { "tags": [ "HelpdeskSetting" ], "summary": "HelpdeskSetting: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskSetting-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskSetting_DeleteByFilter_132EC9566B17", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/HelpdeskSetting/GetAllByValue": { "post": { "tags": [ "HelpdeskSetting" ], "summary": "HelpdeskSetting: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskSetting_GetAllByValue_AF0952F52566", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskSetting" } } } } } } }, "/api/HelpdeskSetting/GetAllGraphByValue": { "post": { "tags": [ "HelpdeskSetting" ], "summary": "HelpdeskSetting: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskSetting_GetAllGraphByValue_524E65A5FE4E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskSetting" } } } } } } }, "/api/HelpdeskSetting/GetByValue": { "post": { "tags": [ "HelpdeskSetting" ], "summary": "HelpdeskSetting: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskSetting_GetByValue_941F67E549E3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskSetting" } } } } } } }, "/api/HelpdeskSetting/GetLookup": { "post": { "tags": [ "HelpdeskSetting" ], "summary": "HelpdeskSetting: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskSetting_GetLookup_46D54CFE0EC9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/HelpdeskSetting/GetLookupByValue": { "post": { "tags": [ "HelpdeskSetting" ], "summary": "HelpdeskSetting: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskSetting_GetLookupByValue_57263FC0717B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/HelpdeskSetting/Page": { "get": { "tags": [ "HelpdeskSetting" ], "summary": "HelpdeskSetting: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskSetting_GetPage_47D2C670BFA0", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/HelpdeskSetting/PageAsc": { "get": { "tags": [ "HelpdeskSetting" ], "summary": "HelpdeskSetting: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskSetting_GetPageAsc_7769A22F8550", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/HelpdeskSetting/SearchByValue": { "post": { "tags": [ "HelpdeskSetting" ], "summary": "HelpdeskSetting: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskSetting_SearchByValue_A84A6990C397", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.HelpdeskSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.HelpdeskSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.HelpdeskSetting" } } } } } } }, "/api/HelpdeskSetting/TryGetByValue": { "post": { "tags": [ "HelpdeskSetting" ], "summary": "HelpdeskSetting: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskSetting_TryGetByValue_E953145D14A9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskSetting" } } } } } } }, "/api/HelpdeskSetting/UpsertGraph": { "put": { "tags": [ "HelpdeskSetting" ], "summary": "HelpdeskSetting: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskSetting-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskSetting_UpsertGraph_DEC409FC92A0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskSetting" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskSetting" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskSetting" } } } } } } }, "/api/HelpdeskSetting/UpsertGraphWithExtraFields": { "put": { "tags": [ "HelpdeskSetting" ], "summary": "HelpdeskSetting: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskSetting-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskSetting_UpsertGraphWithExtraFields_649739191D5C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskSetting" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskSetting" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskSetting" } } } } } } }, "/api/HelpdeskStar": { "get": { "tags": [ "HelpdeskStar" ], "summary": "HelpdeskStar: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskStar-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskStar_GetAll_C3DB6E8B0ABD", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskStar" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskStar" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskStar" } } } } } }, "post": { "tags": [ "HelpdeskStar" ], "summary": "HelpdeskStar: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskStar-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskStar_Post_143252B776FD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskStar" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskStar" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskStar" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskStar" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskStar" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskStar" } } } } } }, "put": { "tags": [ "HelpdeskStar" ], "summary": "HelpdeskStar: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskStar-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskStar_Put_FCFA41DD8E50", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskStar" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskStar" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskStar" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskStar" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskStar" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskStar" } } } } } } }, "/api/HelpdeskStar/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "HelpdeskStar" ], "summary": "HelpdeskStar: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskStar-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskStar_GetPageByValue_630686859D8D", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/HelpdeskStar/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "HelpdeskStar" ], "summary": "HelpdeskStar: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskStar-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskStar_GetPageByValue2_CBFFF64B09AF", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/HelpdeskStar/DeleteByFilter": { "post": { "tags": [ "HelpdeskStar" ], "summary": "HelpdeskStar: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskStar-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskStar_DeleteByFilter_E7BAC1FCF23F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/HelpdeskStar/GetAllByValue": { "post": { "tags": [ "HelpdeskStar" ], "summary": "HelpdeskStar: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskStar-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskStar_GetAllByValue_876CF491C588", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskStar" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskStar" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskStar" } } } } } } }, "/api/HelpdeskStar/GetAllGraphByValue": { "post": { "tags": [ "HelpdeskStar" ], "summary": "HelpdeskStar: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskStar-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskStar_GetAllGraphByValue_2B615A0559BD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskStar" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskStar" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskStar" } } } } } } }, "/api/HelpdeskStar/GetByValue": { "post": { "tags": [ "HelpdeskStar" ], "summary": "HelpdeskStar: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskStar-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskStar_GetByValue_C2897650700F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskStar" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskStar" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskStar" } } } } } } }, "/api/HelpdeskStar/GetLookup": { "post": { "tags": [ "HelpdeskStar" ], "summary": "HelpdeskStar: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskStar-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskStar_GetLookup_886A280729BC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/HelpdeskStar/GetLookupByValue": { "post": { "tags": [ "HelpdeskStar" ], "summary": "HelpdeskStar: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskStar-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskStar_GetLookupByValue_F8816A99FD47", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/HelpdeskStar/Page": { "get": { "tags": [ "HelpdeskStar" ], "summary": "HelpdeskStar: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskStar-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskStar_GetPage_4F5B4E6C5CD1", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/HelpdeskStar/PageAsc": { "get": { "tags": [ "HelpdeskStar" ], "summary": "HelpdeskStar: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskStar-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskStar_GetPageAsc_836FB5B82438", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/HelpdeskStar/SearchByValue": { "post": { "tags": [ "HelpdeskStar" ], "summary": "HelpdeskStar: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskStar-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskStar_SearchByValue_5D38C3A0F4B7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.HelpdeskStar" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.HelpdeskStar" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.HelpdeskStar" } } } } } } }, "/api/HelpdeskStar/TryGetByValue": { "post": { "tags": [ "HelpdeskStar" ], "summary": "HelpdeskStar: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskStar-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskStar_TryGetByValue_CFD2074EC411", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskStar" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskStar" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskStar" } } } } } } }, "/api/HelpdeskStar/UpsertGraph": { "put": { "tags": [ "HelpdeskStar" ], "summary": "HelpdeskStar: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskStar-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskStar_UpsertGraph_CEFF03A1B3F3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskStar" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskStar" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskStar" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskStar" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskStar" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskStar" } } } } } } }, "/api/HelpdeskStar/UpsertGraphWithExtraFields": { "put": { "tags": [ "HelpdeskStar" ], "summary": "HelpdeskStar: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskStar-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskStar_UpsertGraphWithExtraFields_D71EE86A90F3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskStar" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskStar" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskStar" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskStar" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskStar" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskStar" } } } } } } }, "/api/HelpdeskStatusSupporter": { "get": { "tags": [ "HelpdeskStatusSupporter" ], "summary": "HelpdeskStatusSupporter: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskStatusSupporter-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskStatusSupporter_GetAll_75DD092357C3", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskStatusSupporter" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskStatusSupporter" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskStatusSupporter" } } } } } }, "post": { "tags": [ "HelpdeskStatusSupporter" ], "summary": "HelpdeskStatusSupporter: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskStatusSupporter-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskStatusSupporter_Post_625D101C4A0D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskStatusSupporter" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskStatusSupporter" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskStatusSupporter" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskStatusSupporter" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskStatusSupporter" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskStatusSupporter" } } } } } }, "put": { "tags": [ "HelpdeskStatusSupporter" ], "summary": "HelpdeskStatusSupporter: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskStatusSupporter-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskStatusSupporter_Put_F17EC6BF6885", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskStatusSupporter" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskStatusSupporter" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskStatusSupporter" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskStatusSupporter" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskStatusSupporter" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskStatusSupporter" } } } } } } }, "/api/HelpdeskStatusSupporter/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "HelpdeskStatusSupporter" ], "summary": "HelpdeskStatusSupporter: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskStatusSupporter-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskStatusSupporter_GetPageByValue_AD9EC6272A9D", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/HelpdeskStatusSupporter/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "HelpdeskStatusSupporter" ], "summary": "HelpdeskStatusSupporter: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskStatusSupporter-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskStatusSupporter_GetPageByValue2_BF0A020EA8EA", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/HelpdeskStatusSupporter/DeleteByFilter": { "post": { "tags": [ "HelpdeskStatusSupporter" ], "summary": "HelpdeskStatusSupporter: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskStatusSupporter-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskStatusSupporter_DeleteByFilter_EC458AB1FD4B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/HelpdeskStatusSupporter/GetAllByValue": { "post": { "tags": [ "HelpdeskStatusSupporter" ], "summary": "HelpdeskStatusSupporter: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskStatusSupporter-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskStatusSupporter_GetAllByValue_8CB89231B5F6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskStatusSupporter" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskStatusSupporter" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskStatusSupporter" } } } } } } }, "/api/HelpdeskStatusSupporter/GetAllGraphByValue": { "post": { "tags": [ "HelpdeskStatusSupporter" ], "summary": "HelpdeskStatusSupporter: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskStatusSupporter-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskStatusSupporter_GetAllGraphByValue_015F2B426929", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskStatusSupporter" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskStatusSupporter" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskStatusSupporter" } } } } } } }, "/api/HelpdeskStatusSupporter/GetByValue": { "post": { "tags": [ "HelpdeskStatusSupporter" ], "summary": "HelpdeskStatusSupporter: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskStatusSupporter-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskStatusSupporter_GetByValue_A81D8BFC497F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskStatusSupporter" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskStatusSupporter" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskStatusSupporter" } } } } } } }, "/api/HelpdeskStatusSupporter/GetLookup": { "post": { "tags": [ "HelpdeskStatusSupporter" ], "summary": "HelpdeskStatusSupporter: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskStatusSupporter-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskStatusSupporter_GetLookup_250C8B721F4E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/HelpdeskStatusSupporter/GetLookupByValue": { "post": { "tags": [ "HelpdeskStatusSupporter" ], "summary": "HelpdeskStatusSupporter: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskStatusSupporter-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskStatusSupporter_GetLookupByValue_74D350E8DB76", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/HelpdeskStatusSupporter/Page": { "get": { "tags": [ "HelpdeskStatusSupporter" ], "summary": "HelpdeskStatusSupporter: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskStatusSupporter-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskStatusSupporter_GetPage_F63A4A7A0D75", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/HelpdeskStatusSupporter/PageAsc": { "get": { "tags": [ "HelpdeskStatusSupporter" ], "summary": "HelpdeskStatusSupporter: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskStatusSupporter-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskStatusSupporter_GetPageAsc_C8E49CA7E6B8", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/HelpdeskStatusSupporter/SearchByValue": { "post": { "tags": [ "HelpdeskStatusSupporter" ], "summary": "HelpdeskStatusSupporter: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskStatusSupporter-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskStatusSupporter_SearchByValue_BA291EA80439", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.HelpdeskStatusSupporter" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.HelpdeskStatusSupporter" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.HelpdeskStatusSupporter" } } } } } } }, "/api/HelpdeskStatusSupporter/TryGetByValue": { "post": { "tags": [ "HelpdeskStatusSupporter" ], "summary": "HelpdeskStatusSupporter: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskStatusSupporter-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskStatusSupporter_TryGetByValue_5B22BEAC61F1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskStatusSupporter" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskStatusSupporter" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskStatusSupporter" } } } } } } }, "/api/HelpdeskStatusSupporter/UpsertGraph": { "put": { "tags": [ "HelpdeskStatusSupporter" ], "summary": "HelpdeskStatusSupporter: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskStatusSupporter-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskStatusSupporter_UpsertGraph_C343D8369106", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskStatusSupporter" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskStatusSupporter" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskStatusSupporter" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskStatusSupporter" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskStatusSupporter" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskStatusSupporter" } } } } } } }, "/api/HelpdeskStatusSupporter/UpsertGraphWithExtraFields": { "put": { "tags": [ "HelpdeskStatusSupporter" ], "summary": "HelpdeskStatusSupporter: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskStatusSupporter-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskStatusSupporter_UpsertGraphWithExtraFields_56AC339F1A25", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskStatusSupporter" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskStatusSupporter" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskStatusSupporter" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskStatusSupporter" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskStatusSupporter" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskStatusSupporter" } } } } } } }, "/api/HelpdeskTopic": { "get": { "tags": [ "HelpdeskTopic" ], "summary": "HelpdeskTopic: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskTopic-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskTopic_GetAll_60997DCED2C4", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskTopic" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskTopic" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskTopic" } } } } } }, "post": { "tags": [ "HelpdeskTopic" ], "summary": "HelpdeskTopic: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskTopic-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskTopic_Post_A627C943F3FF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskTopic" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskTopic" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskTopic" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskTopic" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskTopic" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskTopic" } } } } } }, "put": { "tags": [ "HelpdeskTopic" ], "summary": "HelpdeskTopic: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskTopic-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskTopic_Put_40B2C1F689D4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskTopic" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskTopic" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskTopic" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskTopic" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskTopic" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskTopic" } } } } } } }, "/api/HelpdeskTopic/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "HelpdeskTopic" ], "summary": "HelpdeskTopic: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskTopic-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskTopic_GetPageByValue_C1CB923AF181", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/HelpdeskTopic/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "HelpdeskTopic" ], "summary": "HelpdeskTopic: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskTopic-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskTopic_GetPageByValue2_9BFD8AAAA3B9", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/HelpdeskTopic/DeleteByFilter": { "post": { "tags": [ "HelpdeskTopic" ], "summary": "HelpdeskTopic: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskTopic-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskTopic_DeleteByFilter_3C1F5C41D855", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/HelpdeskTopic/GetAllByValue": { "post": { "tags": [ "HelpdeskTopic" ], "summary": "HelpdeskTopic: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskTopic-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskTopic_GetAllByValue_47DD45FFD4A0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskTopic" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskTopic" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskTopic" } } } } } } }, "/api/HelpdeskTopic/GetAllGraphByValue": { "post": { "tags": [ "HelpdeskTopic" ], "summary": "HelpdeskTopic: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskTopic-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskTopic_GetAllGraphByValue_6D70663BB0AE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskTopic" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskTopic" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskTopic" } } } } } } }, "/api/HelpdeskTopic/GetByValue": { "post": { "tags": [ "HelpdeskTopic" ], "summary": "HelpdeskTopic: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskTopic-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskTopic_GetByValue_A038DF8BC9F6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskTopic" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskTopic" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskTopic" } } } } } } }, "/api/HelpdeskTopic/GetLookup": { "post": { "tags": [ "HelpdeskTopic" ], "summary": "HelpdeskTopic: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskTopic-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskTopic_GetLookup_7F8AAA0B0EA2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/HelpdeskTopic/GetLookupByValue": { "post": { "tags": [ "HelpdeskTopic" ], "summary": "HelpdeskTopic: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskTopic-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskTopic_GetLookupByValue_5056811D532C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/HelpdeskTopic/Page": { "get": { "tags": [ "HelpdeskTopic" ], "summary": "HelpdeskTopic: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskTopic-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskTopic_GetPage_787EA7D13530", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/HelpdeskTopic/PageAsc": { "get": { "tags": [ "HelpdeskTopic" ], "summary": "HelpdeskTopic: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskTopic-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskTopic_GetPageAsc_3C55EFE9D1FE", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/HelpdeskTopic/SearchByValue": { "post": { "tags": [ "HelpdeskTopic" ], "summary": "HelpdeskTopic: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskTopic-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskTopic_SearchByValue_F0A921396172", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.HelpdeskTopic" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.HelpdeskTopic" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.HelpdeskTopic" } } } } } } }, "/api/HelpdeskTopic/TryGetByValue": { "post": { "tags": [ "HelpdeskTopic" ], "summary": "HelpdeskTopic: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskTopic-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskTopic_TryGetByValue_AF2CDBB3D12A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskTopic" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskTopic" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskTopic" } } } } } } }, "/api/HelpdeskTopic/UpsertGraph": { "put": { "tags": [ "HelpdeskTopic" ], "summary": "HelpdeskTopic: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskTopic-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskTopic_UpsertGraph_CE3FF0D242B3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskTopic" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskTopic" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskTopic" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskTopic" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskTopic" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskTopic" } } } } } } }, "/api/HelpdeskTopic/UpsertGraphWithExtraFields": { "put": { "tags": [ "HelpdeskTopic" ], "summary": "HelpdeskTopic: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: HelpdeskTopic-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "HelpdeskTopic_UpsertGraphWithExtraFields_B540B37058FE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskTopic" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskTopic" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskTopic" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskTopic" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskTopic" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskTopic" } } } } } } }, "/api/Intercom": { "get": { "tags": [ "Intercom" ], "summary": "Intercom: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Intercom-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Intercom_GetAll_0E34A4DE0D71", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Intercom" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Intercom" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Intercom" } } } } } }, "post": { "tags": [ "Intercom" ], "summary": "Intercom: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Intercom-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Intercom_Post_AA9A25F6AC82", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Intercom" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Intercom" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Intercom" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Intercom" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Intercom" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Intercom" } } } } } }, "put": { "tags": [ "Intercom" ], "summary": "Intercom: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Intercom-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Intercom_Put_2BF9DC218277", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Intercom" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Intercom" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Intercom" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Intercom" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Intercom" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Intercom" } } } } } } }, "/api/Intercom/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "Intercom" ], "summary": "Intercom: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Intercom-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Intercom_GetPageByValue_65E80ED0C8F0", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Intercom/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "Intercom" ], "summary": "Intercom: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Intercom-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Intercom_GetPageByValue2_946699821CB9", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Intercom/DeleteByFilter": { "post": { "tags": [ "Intercom" ], "summary": "Intercom: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Intercom-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Intercom_DeleteByFilter_1F54E08E44DF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/Intercom/GetAllByValue": { "post": { "tags": [ "Intercom" ], "summary": "Intercom: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Intercom-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Intercom_GetAllByValue_F89B0AE3DB73", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Intercom" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Intercom" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Intercom" } } } } } } }, "/api/Intercom/GetAllGraphByValue": { "post": { "tags": [ "Intercom" ], "summary": "Intercom: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Intercom-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Intercom_GetAllGraphByValue_EC161FD65E53", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Intercom" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Intercom" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Intercom" } } } } } } }, "/api/Intercom/GetByValue": { "post": { "tags": [ "Intercom" ], "summary": "Intercom: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Intercom-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Intercom_GetByValue_FA5DE5E52BE4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Intercom" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Intercom" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Intercom" } } } } } } }, "/api/Intercom/GetLookup": { "post": { "tags": [ "Intercom" ], "summary": "Intercom: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Intercom-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Intercom_GetLookup_E9F2BA70BDC3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/Intercom/GetLookupByValue": { "post": { "tags": [ "Intercom" ], "summary": "Intercom: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Intercom-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Intercom_GetLookupByValue_42466476F515", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/Intercom/Page": { "get": { "tags": [ "Intercom" ], "summary": "Intercom: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Intercom-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Intercom_GetPage_5E1E9D66B363", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Intercom/PageAsc": { "get": { "tags": [ "Intercom" ], "summary": "Intercom: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Intercom-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Intercom_GetPageAsc_7D7D4056ADEB", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Intercom/PageFromView/{GroupId}/{IncludeSubNodes}/{Checked}/{Canceled}/{LoggedInEmployeeId}": { "get": { "tags": [ "Intercom" ], "summary": "Intercom: GetPageFromView", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Intercom-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Intercom_GetPageFromView_BFA6E1BA283B", "parameters": [ { "name": "GroupId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "IncludeSubNodes", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "Checked", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "Canceled", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "LoggedInEmployeeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Intercom/SearchByValue": { "post": { "tags": [ "Intercom" ], "summary": "Intercom: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Intercom-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Intercom_SearchByValue_9BD191E6A8BF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.Intercom" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.Intercom" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.Intercom" } } } } } } }, "/api/Intercom/TryGetByValue": { "post": { "tags": [ "Intercom" ], "summary": "Intercom: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Intercom-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Intercom_TryGetByValue_D4FD7E9344F7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Intercom" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Intercom" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Intercom" } } } } } } }, "/api/Intercom/UpsertGraph": { "put": { "tags": [ "Intercom" ], "summary": "Intercom: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Intercom-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Intercom_UpsertGraph_F8ECF7BC71C3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Intercom" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Intercom" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Intercom" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Intercom" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Intercom" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Intercom" } } } } } } }, "/api/Intercom/UpsertGraphWithExtraFields": { "put": { "tags": [ "Intercom" ], "summary": "Intercom: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Intercom-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Intercom_UpsertGraphWithExtraFields_D853D122CA18", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Intercom" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Intercom" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Intercom" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Intercom" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Intercom" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Intercom" } } } } } } }, "/api/IntercomGroup": { "get": { "tags": [ "IntercomGroup" ], "summary": "IntercomGroup: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: IntercomGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "IntercomGroup_GetAll_52660FA41785", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.IntercomGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.IntercomGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.IntercomGroup" } } } } } }, "post": { "tags": [ "IntercomGroup" ], "summary": "IntercomGroup: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: IntercomGroup-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "IntercomGroup_Post_0BA2AE205F47", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.IntercomGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.IntercomGroup" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.IntercomGroup" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.IntercomGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.IntercomGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.IntercomGroup" } } } } } }, "put": { "tags": [ "IntercomGroup" ], "summary": "IntercomGroup: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: IntercomGroup-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "IntercomGroup_Put_D709CED77719", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.IntercomGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.IntercomGroup" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.IntercomGroup" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.IntercomGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.IntercomGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.IntercomGroup" } } } } } } }, "/api/IntercomGroup/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "IntercomGroup" ], "summary": "IntercomGroup: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: IntercomGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "IntercomGroup_GetPageByValue_B458B56850E0", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/IntercomGroup/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "IntercomGroup" ], "summary": "IntercomGroup: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: IntercomGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "IntercomGroup_GetPageByValue2_C06A4057358F", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/IntercomGroup/DeleteByFilter": { "post": { "tags": [ "IntercomGroup" ], "summary": "IntercomGroup: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: IntercomGroup-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "IntercomGroup_DeleteByFilter_28C7C037FBDE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/IntercomGroup/GetAllByValue": { "post": { "tags": [ "IntercomGroup" ], "summary": "IntercomGroup: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: IntercomGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "IntercomGroup_GetAllByValue_F0B26142CBD5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.IntercomGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.IntercomGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.IntercomGroup" } } } } } } }, "/api/IntercomGroup/GetAllGraphByValue": { "post": { "tags": [ "IntercomGroup" ], "summary": "IntercomGroup: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: IntercomGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "IntercomGroup_GetAllGraphByValue_D7BFAB4AE19E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.IntercomGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.IntercomGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.IntercomGroup" } } } } } } }, "/api/IntercomGroup/GetByValue": { "post": { "tags": [ "IntercomGroup" ], "summary": "IntercomGroup: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: IntercomGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "IntercomGroup_GetByValue_A74F317AEACE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.IntercomGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.IntercomGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.IntercomGroup" } } } } } } }, "/api/IntercomGroup/GetLookup": { "post": { "tags": [ "IntercomGroup" ], "summary": "IntercomGroup: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: IntercomGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "IntercomGroup_GetLookup_D39CDF818D46", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/IntercomGroup/GetLookupByValue": { "post": { "tags": [ "IntercomGroup" ], "summary": "IntercomGroup: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: IntercomGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "IntercomGroup_GetLookupByValue_6E692D5D87E1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/IntercomGroup/Page": { "get": { "tags": [ "IntercomGroup" ], "summary": "IntercomGroup: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: IntercomGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "IntercomGroup_GetPage_C822A4A41E8F", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/IntercomGroup/PageAsc": { "get": { "tags": [ "IntercomGroup" ], "summary": "IntercomGroup: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: IntercomGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "IntercomGroup_GetPageAsc_23AC88C79CFC", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/IntercomGroup/PageIntercomGroupsByParent/{ParentId}/{IncludeSubNodes}/{TopParentsOnly}": { "get": { "tags": [ "IntercomGroup" ], "summary": "IntercomGroup: GetPageIntercomGroupsByParent", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: IntercomGroup-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "IntercomGroup_GetPageIntercomGroupsByParent_C51817BE7FA4", "parameters": [ { "name": "ParentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "IncludeSubNodes", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "TopParentsOnly", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/IntercomGroup/SearchByValue": { "post": { "tags": [ "IntercomGroup" ], "summary": "IntercomGroup: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: IntercomGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "IntercomGroup_SearchByValue_0170E155F142", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.IntercomGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.IntercomGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.IntercomGroup" } } } } } } }, "/api/IntercomGroup/TryGetByValue": { "post": { "tags": [ "IntercomGroup" ], "summary": "IntercomGroup: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: IntercomGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "IntercomGroup_TryGetByValue_4DDAF6A8C22B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.IntercomGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.IntercomGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.IntercomGroup" } } } } } } }, "/api/IntercomGroup/UpsertGraph": { "put": { "tags": [ "IntercomGroup" ], "summary": "IntercomGroup: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: IntercomGroup-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "IntercomGroup_UpsertGraph_A48B90B21E3D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.IntercomGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.IntercomGroup" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.IntercomGroup" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.IntercomGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.IntercomGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.IntercomGroup" } } } } } } }, "/api/IntercomGroup/UpsertGraphWithExtraFields": { "put": { "tags": [ "IntercomGroup" ], "summary": "IntercomGroup: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: IntercomGroup-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "IntercomGroup_UpsertGraphWithExtraFields_27869E5E2C71", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.IntercomGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.IntercomGroup" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.IntercomGroup" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.IntercomGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.IntercomGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.IntercomGroup" } } } } } } }, "/api/IntercomPrio": { "get": { "tags": [ "IntercomPrio" ], "summary": "IntercomPrio: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: IntercomPrio-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "IntercomPrio_GetAll_A2FB6EC945E6", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.IntercomPrio" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.IntercomPrio" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.IntercomPrio" } } } } } }, "post": { "tags": [ "IntercomPrio" ], "summary": "IntercomPrio: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: IntercomPrio-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "IntercomPrio_Post_F4BA6354C1D0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.IntercomPrio" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.IntercomPrio" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.IntercomPrio" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.IntercomPrio" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.IntercomPrio" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.IntercomPrio" } } } } } }, "put": { "tags": [ "IntercomPrio" ], "summary": "IntercomPrio: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: IntercomPrio-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "IntercomPrio_Put_4159115A357F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.IntercomPrio" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.IntercomPrio" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.IntercomPrio" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.IntercomPrio" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.IntercomPrio" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.IntercomPrio" } } } } } } }, "/api/IntercomPrio/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "IntercomPrio" ], "summary": "IntercomPrio: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: IntercomPrio-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "IntercomPrio_GetPageByValue_53FD578D642D", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/IntercomPrio/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "IntercomPrio" ], "summary": "IntercomPrio: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: IntercomPrio-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "IntercomPrio_GetPageByValue2_9AAD936433F3", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/IntercomPrio/DeleteByFilter": { "post": { "tags": [ "IntercomPrio" ], "summary": "IntercomPrio: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: IntercomPrio-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "IntercomPrio_DeleteByFilter_AA3E4C3B5B1B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/IntercomPrio/GetAllByValue": { "post": { "tags": [ "IntercomPrio" ], "summary": "IntercomPrio: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: IntercomPrio-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "IntercomPrio_GetAllByValue_B4F52D684AE7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.IntercomPrio" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.IntercomPrio" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.IntercomPrio" } } } } } } }, "/api/IntercomPrio/GetAllGraphByValue": { "post": { "tags": [ "IntercomPrio" ], "summary": "IntercomPrio: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: IntercomPrio-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "IntercomPrio_GetAllGraphByValue_0564AF8FCC98", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.IntercomPrio" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.IntercomPrio" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.IntercomPrio" } } } } } } }, "/api/IntercomPrio/GetByValue": { "post": { "tags": [ "IntercomPrio" ], "summary": "IntercomPrio: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: IntercomPrio-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "IntercomPrio_GetByValue_B4806DB82473", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.IntercomPrio" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.IntercomPrio" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.IntercomPrio" } } } } } } }, "/api/IntercomPrio/GetLookup": { "post": { "tags": [ "IntercomPrio" ], "summary": "IntercomPrio: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: IntercomPrio-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "IntercomPrio_GetLookup_6AC8C464E5D7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/IntercomPrio/GetLookupByValue": { "post": { "tags": [ "IntercomPrio" ], "summary": "IntercomPrio: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: IntercomPrio-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "IntercomPrio_GetLookupByValue_D69C0F303926", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/IntercomPrio/Page": { "get": { "tags": [ "IntercomPrio" ], "summary": "IntercomPrio: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: IntercomPrio-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "IntercomPrio_GetPage_61D0AA743C3E", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/IntercomPrio/PageAsc": { "get": { "tags": [ "IntercomPrio" ], "summary": "IntercomPrio: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: IntercomPrio-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "IntercomPrio_GetPageAsc_3CC69EA92273", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/IntercomPrio/SearchByValue": { "post": { "tags": [ "IntercomPrio" ], "summary": "IntercomPrio: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: IntercomPrio-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "IntercomPrio_SearchByValue_67B9D113CBD1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.IntercomPrio" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.IntercomPrio" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.IntercomPrio" } } } } } } }, "/api/IntercomPrio/TryGetByValue": { "post": { "tags": [ "IntercomPrio" ], "summary": "IntercomPrio: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: IntercomPrio-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "IntercomPrio_TryGetByValue_6A60F873196C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.IntercomPrio" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.IntercomPrio" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.IntercomPrio" } } } } } } }, "/api/IntercomPrio/UpsertGraph": { "put": { "tags": [ "IntercomPrio" ], "summary": "IntercomPrio: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: IntercomPrio-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "IntercomPrio_UpsertGraph_4479426D0950", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.IntercomPrio" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.IntercomPrio" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.IntercomPrio" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.IntercomPrio" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.IntercomPrio" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.IntercomPrio" } } } } } } }, "/api/IntercomPrio/UpsertGraphWithExtraFields": { "put": { "tags": [ "IntercomPrio" ], "summary": "IntercomPrio: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: IntercomPrio-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "IntercomPrio_UpsertGraphWithExtraFields_6F455C92BAC2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.IntercomPrio" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.IntercomPrio" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.IntercomPrio" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.IntercomPrio" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.IntercomPrio" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.IntercomPrio" } } } } } } }, "/api/IntercomRecipientStatus": { "get": { "tags": [ "IntercomRecipientStatus" ], "summary": "IntercomRecipientStatus: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: IntercomRecipientStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "IntercomRecipientStatus_GetAll_E9AA81B09DCE", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.IntercomRecipientStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.IntercomRecipientStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.IntercomRecipientStatus" } } } } } }, "post": { "tags": [ "IntercomRecipientStatus" ], "summary": "IntercomRecipientStatus: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: IntercomRecipientStatus-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "IntercomRecipientStatus_Post_4947E37D3B0F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.IntercomRecipientStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.IntercomRecipientStatus" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.IntercomRecipientStatus" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.IntercomRecipientStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.IntercomRecipientStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.IntercomRecipientStatus" } } } } } }, "put": { "tags": [ "IntercomRecipientStatus" ], "summary": "IntercomRecipientStatus: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: IntercomRecipientStatus-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "IntercomRecipientStatus_Put_2D4B59C13DAA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.IntercomRecipientStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.IntercomRecipientStatus" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.IntercomRecipientStatus" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.IntercomRecipientStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.IntercomRecipientStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.IntercomRecipientStatus" } } } } } } }, "/api/IntercomRecipientStatus/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "IntercomRecipientStatus" ], "summary": "IntercomRecipientStatus: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: IntercomRecipientStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "IntercomRecipientStatus_GetPageByValue_2281A8753AB5", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/IntercomRecipientStatus/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "IntercomRecipientStatus" ], "summary": "IntercomRecipientStatus: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: IntercomRecipientStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "IntercomRecipientStatus_GetPageByValue2_D7A2097868A4", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/IntercomRecipientStatus/DeleteByFilter": { "post": { "tags": [ "IntercomRecipientStatus" ], "summary": "IntercomRecipientStatus: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: IntercomRecipientStatus-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "IntercomRecipientStatus_DeleteByFilter_3521B61D2804", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/IntercomRecipientStatus/GetAllByValue": { "post": { "tags": [ "IntercomRecipientStatus" ], "summary": "IntercomRecipientStatus: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: IntercomRecipientStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "IntercomRecipientStatus_GetAllByValue_8337A0B44471", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.IntercomRecipientStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.IntercomRecipientStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.IntercomRecipientStatus" } } } } } } }, "/api/IntercomRecipientStatus/GetAllGraphByValue": { "post": { "tags": [ "IntercomRecipientStatus" ], "summary": "IntercomRecipientStatus: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: IntercomRecipientStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "IntercomRecipientStatus_GetAllGraphByValue_D681244E4420", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.IntercomRecipientStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.IntercomRecipientStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.IntercomRecipientStatus" } } } } } } }, "/api/IntercomRecipientStatus/GetByValue": { "post": { "tags": [ "IntercomRecipientStatus" ], "summary": "IntercomRecipientStatus: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: IntercomRecipientStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "IntercomRecipientStatus_GetByValue_F16AA4AB640A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.IntercomRecipientStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.IntercomRecipientStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.IntercomRecipientStatus" } } } } } } }, "/api/IntercomRecipientStatus/GetLookup": { "post": { "tags": [ "IntercomRecipientStatus" ], "summary": "IntercomRecipientStatus: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: IntercomRecipientStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "IntercomRecipientStatus_GetLookup_84E35D2C3E90", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/IntercomRecipientStatus/GetLookupByValue": { "post": { "tags": [ "IntercomRecipientStatus" ], "summary": "IntercomRecipientStatus: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: IntercomRecipientStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "IntercomRecipientStatus_GetLookupByValue_4CB0D1CCB1A9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/IntercomRecipientStatus/Page": { "get": { "tags": [ "IntercomRecipientStatus" ], "summary": "IntercomRecipientStatus: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: IntercomRecipientStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "IntercomRecipientStatus_GetPage_FF94315B9C93", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/IntercomRecipientStatus/PageAsc": { "get": { "tags": [ "IntercomRecipientStatus" ], "summary": "IntercomRecipientStatus: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: IntercomRecipientStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "IntercomRecipientStatus_GetPageAsc_118703E96D7D", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/IntercomRecipientStatus/SearchByValue": { "post": { "tags": [ "IntercomRecipientStatus" ], "summary": "IntercomRecipientStatus: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: IntercomRecipientStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "IntercomRecipientStatus_SearchByValue_FB756110C308", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.IntercomRecipientStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.IntercomRecipientStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.IntercomRecipientStatus" } } } } } } }, "/api/IntercomRecipientStatus/TryGetByValue": { "post": { "tags": [ "IntercomRecipientStatus" ], "summary": "IntercomRecipientStatus: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: IntercomRecipientStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "IntercomRecipientStatus_TryGetByValue_B25ACBAB888C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.IntercomRecipientStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.IntercomRecipientStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.IntercomRecipientStatus" } } } } } } }, "/api/IntercomRecipientStatus/UpsertGraph": { "put": { "tags": [ "IntercomRecipientStatus" ], "summary": "IntercomRecipientStatus: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: IntercomRecipientStatus-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "IntercomRecipientStatus_UpsertGraph_BE797F30889D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.IntercomRecipientStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.IntercomRecipientStatus" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.IntercomRecipientStatus" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.IntercomRecipientStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.IntercomRecipientStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.IntercomRecipientStatus" } } } } } } }, "/api/IntercomRecipientStatus/UpsertGraphWithExtraFields": { "put": { "tags": [ "IntercomRecipientStatus" ], "summary": "IntercomRecipientStatus: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: IntercomRecipientStatus-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "IntercomRecipientStatus_UpsertGraphWithExtraFields_9F647A01C0D0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.IntercomRecipientStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.IntercomRecipientStatus" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.IntercomRecipientStatus" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.IntercomRecipientStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.IntercomRecipientStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.IntercomRecipientStatus" } } } } } } }, "/api/IntercomSenderStatus": { "get": { "tags": [ "IntercomSenderStatus" ], "summary": "IntercomSenderStatus: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: IntercomSenderStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "IntercomSenderStatus_GetAll_250BA8FBC7C2", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.IntercomSenderStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.IntercomSenderStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.IntercomSenderStatus" } } } } } }, "post": { "tags": [ "IntercomSenderStatus" ], "summary": "IntercomSenderStatus: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: IntercomSenderStatus-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "IntercomSenderStatus_Post_3376C819E6A1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.IntercomSenderStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.IntercomSenderStatus" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.IntercomSenderStatus" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.IntercomSenderStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.IntercomSenderStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.IntercomSenderStatus" } } } } } }, "put": { "tags": [ "IntercomSenderStatus" ], "summary": "IntercomSenderStatus: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: IntercomSenderStatus-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "IntercomSenderStatus_Put_A7D42BC85614", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.IntercomSenderStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.IntercomSenderStatus" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.IntercomSenderStatus" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.IntercomSenderStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.IntercomSenderStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.IntercomSenderStatus" } } } } } } }, "/api/IntercomSenderStatus/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "IntercomSenderStatus" ], "summary": "IntercomSenderStatus: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: IntercomSenderStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "IntercomSenderStatus_GetPageByValue_8E7397F961C0", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/IntercomSenderStatus/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "IntercomSenderStatus" ], "summary": "IntercomSenderStatus: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: IntercomSenderStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "IntercomSenderStatus_GetPageByValue2_53E0FBEA94B1", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/IntercomSenderStatus/DeleteByFilter": { "post": { "tags": [ "IntercomSenderStatus" ], "summary": "IntercomSenderStatus: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: IntercomSenderStatus-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "IntercomSenderStatus_DeleteByFilter_64F66AFF00AE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/IntercomSenderStatus/GetAllByValue": { "post": { "tags": [ "IntercomSenderStatus" ], "summary": "IntercomSenderStatus: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: IntercomSenderStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "IntercomSenderStatus_GetAllByValue_31A73C5284D0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.IntercomSenderStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.IntercomSenderStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.IntercomSenderStatus" } } } } } } }, "/api/IntercomSenderStatus/GetAllGraphByValue": { "post": { "tags": [ "IntercomSenderStatus" ], "summary": "IntercomSenderStatus: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: IntercomSenderStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "IntercomSenderStatus_GetAllGraphByValue_5D4C2DB9A623", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.IntercomSenderStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.IntercomSenderStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.IntercomSenderStatus" } } } } } } }, "/api/IntercomSenderStatus/GetByValue": { "post": { "tags": [ "IntercomSenderStatus" ], "summary": "IntercomSenderStatus: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: IntercomSenderStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "IntercomSenderStatus_GetByValue_F4D86D2E8CFC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.IntercomSenderStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.IntercomSenderStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.IntercomSenderStatus" } } } } } } }, "/api/IntercomSenderStatus/GetLookup": { "post": { "tags": [ "IntercomSenderStatus" ], "summary": "IntercomSenderStatus: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: IntercomSenderStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "IntercomSenderStatus_GetLookup_AB41469369C1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/IntercomSenderStatus/GetLookupByValue": { "post": { "tags": [ "IntercomSenderStatus" ], "summary": "IntercomSenderStatus: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: IntercomSenderStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "IntercomSenderStatus_GetLookupByValue_8911D83FF668", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/IntercomSenderStatus/Page": { "get": { "tags": [ "IntercomSenderStatus" ], "summary": "IntercomSenderStatus: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: IntercomSenderStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "IntercomSenderStatus_GetPage_8D2045D4A3C4", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/IntercomSenderStatus/PageAsc": { "get": { "tags": [ "IntercomSenderStatus" ], "summary": "IntercomSenderStatus: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: IntercomSenderStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "IntercomSenderStatus_GetPageAsc_A1D78B018385", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/IntercomSenderStatus/SearchByValue": { "post": { "tags": [ "IntercomSenderStatus" ], "summary": "IntercomSenderStatus: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: IntercomSenderStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "IntercomSenderStatus_SearchByValue_B4D228F004FC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.IntercomSenderStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.IntercomSenderStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.IntercomSenderStatus" } } } } } } }, "/api/IntercomSenderStatus/TryGetByValue": { "post": { "tags": [ "IntercomSenderStatus" ], "summary": "IntercomSenderStatus: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: IntercomSenderStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "IntercomSenderStatus_TryGetByValue_9FFF7D8DC155", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.IntercomSenderStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.IntercomSenderStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.IntercomSenderStatus" } } } } } } }, "/api/IntercomSenderStatus/UpsertGraph": { "put": { "tags": [ "IntercomSenderStatus" ], "summary": "IntercomSenderStatus: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: IntercomSenderStatus-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "IntercomSenderStatus_UpsertGraph_8C712CBF309E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.IntercomSenderStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.IntercomSenderStatus" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.IntercomSenderStatus" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.IntercomSenderStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.IntercomSenderStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.IntercomSenderStatus" } } } } } } }, "/api/IntercomSenderStatus/UpsertGraphWithExtraFields": { "put": { "tags": [ "IntercomSenderStatus" ], "summary": "IntercomSenderStatus: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: IntercomSenderStatus-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "IntercomSenderStatus_UpsertGraphWithExtraFields_1A12629AB4C4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.IntercomSenderStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.IntercomSenderStatus" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.IntercomSenderStatus" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.IntercomSenderStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.IntercomSenderStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.IntercomSenderStatus" } } } } } } }, "/api/KeepAlive": { "get": { "tags": [ "KeepAlive" ], "summary": "KeepAlive: Get", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "KeepAlive_Get_7F74CB89E7E5", "responses": { "200": { "description": "OK" } } } }, "/api/License": { "get": { "tags": [ "License" ], "summary": "License: GetLicense", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "License_GetLicense_6BD2C2894B1F", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models_MasterDb.License" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models_MasterDb.License" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models_MasterDb.License" } } } } } } }, "/api/Map": { "get": { "tags": [ "Map" ], "summary": "Map: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Map-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Map_GetAll_E0FADC46A186", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Map" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Map" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Map" } } } } } }, "post": { "tags": [ "Map" ], "summary": "Map: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Map-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Map_Post_8B7F05293937", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Map" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Map" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Map" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Map" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Map" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Map" } } } } } }, "put": { "tags": [ "Map" ], "summary": "Map: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Map-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Map_Put_7EC59EF4D69F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Map" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Map" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Map" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Map" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Map" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Map" } } } } } } }, "/api/Map/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "Map" ], "summary": "Map: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Map-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Map_GetPageByValue_9683031D1A44", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Map/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "Map" ], "summary": "Map: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Map-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Map_GetPageByValue2_7C7E5D34C5D2", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Map/DeleteByFilter": { "post": { "tags": [ "Map" ], "summary": "Map: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Map-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Map_DeleteByFilter_A933583CD1E8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/Map/GetAllByValue": { "post": { "tags": [ "Map" ], "summary": "Map: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Map-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Map_GetAllByValue_A4E6EC17297F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Map" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Map" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Map" } } } } } } }, "/api/Map/GetAllGraphByValue": { "post": { "tags": [ "Map" ], "summary": "Map: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Map-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Map_GetAllGraphByValue_32E3D59E4E8D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Map" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Map" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Map" } } } } } } }, "/api/Map/GetByValue": { "post": { "tags": [ "Map" ], "summary": "Map: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Map-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Map_GetByValue_B32F190200DC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Map" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Map" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Map" } } } } } } }, "/api/Map/GetLookup": { "post": { "tags": [ "Map" ], "summary": "Map: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Map-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Map_GetLookup_E723217A9A77", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/Map/GetLookupByValue": { "post": { "tags": [ "Map" ], "summary": "Map: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Map-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Map_GetLookupByValue_27EC6E4E04A0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/Map/Page": { "get": { "tags": [ "Map" ], "summary": "Map: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Map-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Map_GetPage_F0DB4F94EEA9", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Map/PageAsc": { "get": { "tags": [ "Map" ], "summary": "Map: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Map-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Map_GetPageAsc_B5AD74895578", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Map/SearchByValue": { "post": { "tags": [ "Map" ], "summary": "Map: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Map-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Map_SearchByValue_490E9BC6BAC1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.Map" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.Map" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.Map" } } } } } } }, "/api/Map/TryGetByValue": { "post": { "tags": [ "Map" ], "summary": "Map: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Map-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Map_TryGetByValue_9FA007C32E3C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Map" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Map" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Map" } } } } } } }, "/api/Map/UpsertGraph": { "put": { "tags": [ "Map" ], "summary": "Map: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Map-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Map_UpsertGraph_AF747F11BC28", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Map" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Map" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Map" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Map" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Map" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Map" } } } } } } }, "/api/Map/UpsertGraphWithExtraFields": { "put": { "tags": [ "Map" ], "summary": "Map: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Map-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Map_UpsertGraphWithExtraFields_56E5A82405B4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Map" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Map" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Map" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Map" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Map" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Map" } } } } } } }, "/api/Marketplace": { "get": { "tags": [ "Marketplace" ], "summary": "Marketplace: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Marketplace-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Marketplace_GetAll_BA06055B19D6", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Marketplace" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Marketplace" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Marketplace" } } } } } }, "post": { "tags": [ "Marketplace" ], "summary": "Marketplace: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Marketplace-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Marketplace_Post_8D850A4A57C3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Marketplace" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Marketplace" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Marketplace" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Marketplace" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Marketplace" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Marketplace" } } } } } }, "put": { "tags": [ "Marketplace" ], "summary": "Marketplace: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Marketplace-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Marketplace_Put_01A23363865C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Marketplace" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Marketplace" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Marketplace" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Marketplace" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Marketplace" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Marketplace" } } } } } } }, "/api/Marketplace/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "Marketplace" ], "summary": "Marketplace: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Marketplace-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Marketplace_GetPageByValue_2190B8C808BE", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Marketplace/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "Marketplace" ], "summary": "Marketplace: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Marketplace-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Marketplace_GetPageByValue2_4E3D73FAE7A2", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Marketplace/DeleteByFilter": { "post": { "tags": [ "Marketplace" ], "summary": "Marketplace: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Marketplace-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Marketplace_DeleteByFilter_EC0F08BFEBA0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/Marketplace/GetAllByValue": { "post": { "tags": [ "Marketplace" ], "summary": "Marketplace: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Marketplace-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Marketplace_GetAllByValue_FC84FA5FFBC4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Marketplace" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Marketplace" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Marketplace" } } } } } } }, "/api/Marketplace/GetAllGraphByValue": { "post": { "tags": [ "Marketplace" ], "summary": "Marketplace: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Marketplace-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Marketplace_GetAllGraphByValue_7FA4558B0231", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Marketplace" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Marketplace" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Marketplace" } } } } } } }, "/api/Marketplace/GetByValue": { "post": { "tags": [ "Marketplace" ], "summary": "Marketplace: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Marketplace-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Marketplace_GetByValue_255979516229", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Marketplace" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Marketplace" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Marketplace" } } } } } } }, "/api/Marketplace/GetLookup": { "post": { "tags": [ "Marketplace" ], "summary": "Marketplace: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Marketplace-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Marketplace_GetLookup_C09A054155F2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/Marketplace/GetLookupByValue": { "post": { "tags": [ "Marketplace" ], "summary": "Marketplace: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Marketplace-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Marketplace_GetLookupByValue_A6A84D1EF635", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/Marketplace/Page": { "get": { "tags": [ "Marketplace" ], "summary": "Marketplace: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Marketplace-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Marketplace_GetPage_482F4E51237B", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Marketplace/PageAsc": { "get": { "tags": [ "Marketplace" ], "summary": "Marketplace: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Marketplace-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Marketplace_GetPageAsc_CC28FDAA9A60", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Marketplace/SearchByValue": { "post": { "tags": [ "Marketplace" ], "summary": "Marketplace: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Marketplace-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Marketplace_SearchByValue_6F1AE80BB6AD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.Marketplace" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.Marketplace" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.Marketplace" } } } } } } }, "/api/Marketplace/TryGetByValue": { "post": { "tags": [ "Marketplace" ], "summary": "Marketplace: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Marketplace-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Marketplace_TryGetByValue_0C3FB518580B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Marketplace" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Marketplace" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Marketplace" } } } } } } }, "/api/Marketplace/UpsertGraph": { "put": { "tags": [ "Marketplace" ], "summary": "Marketplace: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Marketplace-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Marketplace_UpsertGraph_6FF37B777CFB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Marketplace" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Marketplace" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Marketplace" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Marketplace" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Marketplace" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Marketplace" } } } } } } }, "/api/Marketplace/UpsertGraphWithExtraFields": { "put": { "tags": [ "Marketplace" ], "summary": "Marketplace: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Marketplace-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Marketplace_UpsertGraphWithExtraFields_A76A17B21692", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Marketplace" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Marketplace" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Marketplace" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Marketplace" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Marketplace" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Marketplace" } } } } } } }, "/api/MarketplaceSellerArticle": { "get": { "tags": [ "MarketplaceSellerArticle" ], "summary": "MarketplaceSellerArticle: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MarketplaceSellerArticle-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MarketplaceSellerArticle_GetAll_C536AA321044", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.MarketplaceSellerArticle" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.MarketplaceSellerArticle" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.MarketplaceSellerArticle" } } } } } }, "post": { "tags": [ "MarketplaceSellerArticle" ], "summary": "MarketplaceSellerArticle: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MarketplaceSellerArticle-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MarketplaceSellerArticle_Post_FB63951CBB3D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.MarketplaceSellerArticle" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.MarketplaceSellerArticle" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.MarketplaceSellerArticle" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.MarketplaceSellerArticle" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.MarketplaceSellerArticle" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.MarketplaceSellerArticle" } } } } } }, "put": { "tags": [ "MarketplaceSellerArticle" ], "summary": "MarketplaceSellerArticle: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MarketplaceSellerArticle-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MarketplaceSellerArticle_Put_8337C1B169AD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.MarketplaceSellerArticle" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.MarketplaceSellerArticle" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.MarketplaceSellerArticle" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.MarketplaceSellerArticle" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.MarketplaceSellerArticle" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.MarketplaceSellerArticle" } } } } } } }, "/api/MarketplaceSellerArticle/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "MarketplaceSellerArticle" ], "summary": "MarketplaceSellerArticle: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MarketplaceSellerArticle-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MarketplaceSellerArticle_GetPageByValue_D41918F92942", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/MarketplaceSellerArticle/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "MarketplaceSellerArticle" ], "summary": "MarketplaceSellerArticle: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MarketplaceSellerArticle-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MarketplaceSellerArticle_GetPageByValue2_185F2F837B5B", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/MarketplaceSellerArticle/DeleteByFilter": { "post": { "tags": [ "MarketplaceSellerArticle" ], "summary": "MarketplaceSellerArticle: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MarketplaceSellerArticle-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MarketplaceSellerArticle_DeleteByFilter_E002FC6BEB06", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/MarketplaceSellerArticle/GetAllByValue": { "post": { "tags": [ "MarketplaceSellerArticle" ], "summary": "MarketplaceSellerArticle: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MarketplaceSellerArticle-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MarketplaceSellerArticle_GetAllByValue_C3BEFCF1AF78", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.MarketplaceSellerArticle" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.MarketplaceSellerArticle" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.MarketplaceSellerArticle" } } } } } } }, "/api/MarketplaceSellerArticle/GetAllGraphByValue": { "post": { "tags": [ "MarketplaceSellerArticle" ], "summary": "MarketplaceSellerArticle: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MarketplaceSellerArticle-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MarketplaceSellerArticle_GetAllGraphByValue_396673D187C1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.MarketplaceSellerArticle" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.MarketplaceSellerArticle" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.MarketplaceSellerArticle" } } } } } } }, "/api/MarketplaceSellerArticle/GetByValue": { "post": { "tags": [ "MarketplaceSellerArticle" ], "summary": "MarketplaceSellerArticle: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MarketplaceSellerArticle-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MarketplaceSellerArticle_GetByValue_9316531A3D6E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.MarketplaceSellerArticle" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.MarketplaceSellerArticle" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.MarketplaceSellerArticle" } } } } } } }, "/api/MarketplaceSellerArticle/GetLookup": { "post": { "tags": [ "MarketplaceSellerArticle" ], "summary": "MarketplaceSellerArticle: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MarketplaceSellerArticle-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MarketplaceSellerArticle_GetLookup_3117B9C68AF7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/MarketplaceSellerArticle/GetLookupByValue": { "post": { "tags": [ "MarketplaceSellerArticle" ], "summary": "MarketplaceSellerArticle: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MarketplaceSellerArticle-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MarketplaceSellerArticle_GetLookupByValue_1C5592ECA107", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/MarketplaceSellerArticle/Page": { "get": { "tags": [ "MarketplaceSellerArticle" ], "summary": "MarketplaceSellerArticle: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MarketplaceSellerArticle-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MarketplaceSellerArticle_GetPage_A37055EB006F", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/MarketplaceSellerArticle/PageAsc": { "get": { "tags": [ "MarketplaceSellerArticle" ], "summary": "MarketplaceSellerArticle: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MarketplaceSellerArticle-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MarketplaceSellerArticle_GetPageAsc_470AA7F5894A", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/MarketplaceSellerArticle/SearchByValue": { "post": { "tags": [ "MarketplaceSellerArticle" ], "summary": "MarketplaceSellerArticle: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MarketplaceSellerArticle-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MarketplaceSellerArticle_SearchByValue_37BCFB4397C6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.MarketplaceSellerArticle" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.MarketplaceSellerArticle" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.MarketplaceSellerArticle" } } } } } } }, "/api/MarketplaceSellerArticle/TryGetByValue": { "post": { "tags": [ "MarketplaceSellerArticle" ], "summary": "MarketplaceSellerArticle: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MarketplaceSellerArticle-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MarketplaceSellerArticle_TryGetByValue_900CCC11D97D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.MarketplaceSellerArticle" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.MarketplaceSellerArticle" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.MarketplaceSellerArticle" } } } } } } }, "/api/MarketplaceSellerArticle/UpsertGraph": { "put": { "tags": [ "MarketplaceSellerArticle" ], "summary": "MarketplaceSellerArticle: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MarketplaceSellerArticle-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MarketplaceSellerArticle_UpsertGraph_D5066D71370A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.MarketplaceSellerArticle" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.MarketplaceSellerArticle" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.MarketplaceSellerArticle" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.MarketplaceSellerArticle" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.MarketplaceSellerArticle" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.MarketplaceSellerArticle" } } } } } } }, "/api/MarketplaceSellerArticle/UpsertGraphWithExtraFields": { "put": { "tags": [ "MarketplaceSellerArticle" ], "summary": "MarketplaceSellerArticle: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MarketplaceSellerArticle-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MarketplaceSellerArticle_UpsertGraphWithExtraFields_791C6ECDBE6B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.MarketplaceSellerArticle" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.MarketplaceSellerArticle" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.MarketplaceSellerArticle" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.MarketplaceSellerArticle" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.MarketplaceSellerArticle" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.MarketplaceSellerArticle" } } } } } } }, "/api/MarketplaceSellerPosition": { "get": { "tags": [ "MarketplaceSellerPosition" ], "summary": "MarketplaceSellerPosition: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MarketplaceSellerPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MarketplaceSellerPosition_GetAll_45649CC943B1", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.MarketplaceSellerPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.MarketplaceSellerPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.MarketplaceSellerPosition" } } } } } }, "post": { "tags": [ "MarketplaceSellerPosition" ], "summary": "MarketplaceSellerPosition: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MarketplaceSellerPosition-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MarketplaceSellerPosition_Post_F72D923E7EA2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.MarketplaceSellerPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.MarketplaceSellerPosition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.MarketplaceSellerPosition" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.MarketplaceSellerPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.MarketplaceSellerPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.MarketplaceSellerPosition" } } } } } }, "put": { "tags": [ "MarketplaceSellerPosition" ], "summary": "MarketplaceSellerPosition: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MarketplaceSellerPosition-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MarketplaceSellerPosition_Put_60BC567E7115", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.MarketplaceSellerPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.MarketplaceSellerPosition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.MarketplaceSellerPosition" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.MarketplaceSellerPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.MarketplaceSellerPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.MarketplaceSellerPosition" } } } } } } }, "/api/MarketplaceSellerPosition/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "MarketplaceSellerPosition" ], "summary": "MarketplaceSellerPosition: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MarketplaceSellerPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MarketplaceSellerPosition_GetPageByValue_8298C8112040", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/MarketplaceSellerPosition/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "MarketplaceSellerPosition" ], "summary": "MarketplaceSellerPosition: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MarketplaceSellerPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MarketplaceSellerPosition_GetPageByValue2_955E14FECE40", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/MarketplaceSellerPosition/DeleteByFilter": { "post": { "tags": [ "MarketplaceSellerPosition" ], "summary": "MarketplaceSellerPosition: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MarketplaceSellerPosition-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MarketplaceSellerPosition_DeleteByFilter_D213AA6C2CEF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/MarketplaceSellerPosition/GetAllByValue": { "post": { "tags": [ "MarketplaceSellerPosition" ], "summary": "MarketplaceSellerPosition: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MarketplaceSellerPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MarketplaceSellerPosition_GetAllByValue_ECA4A15DBF79", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.MarketplaceSellerPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.MarketplaceSellerPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.MarketplaceSellerPosition" } } } } } } }, "/api/MarketplaceSellerPosition/GetAllGraphByValue": { "post": { "tags": [ "MarketplaceSellerPosition" ], "summary": "MarketplaceSellerPosition: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MarketplaceSellerPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MarketplaceSellerPosition_GetAllGraphByValue_96789A1DA9BD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.MarketplaceSellerPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.MarketplaceSellerPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.MarketplaceSellerPosition" } } } } } } }, "/api/MarketplaceSellerPosition/GetByValue": { "post": { "tags": [ "MarketplaceSellerPosition" ], "summary": "MarketplaceSellerPosition: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MarketplaceSellerPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MarketplaceSellerPosition_GetByValue_9BEC563042F0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.MarketplaceSellerPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.MarketplaceSellerPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.MarketplaceSellerPosition" } } } } } } }, "/api/MarketplaceSellerPosition/GetLookup": { "post": { "tags": [ "MarketplaceSellerPosition" ], "summary": "MarketplaceSellerPosition: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MarketplaceSellerPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MarketplaceSellerPosition_GetLookup_0BE3EFFA59D8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/MarketplaceSellerPosition/GetLookupByValue": { "post": { "tags": [ "MarketplaceSellerPosition" ], "summary": "MarketplaceSellerPosition: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MarketplaceSellerPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MarketplaceSellerPosition_GetLookupByValue_591D74447196", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/MarketplaceSellerPosition/GetPageView": { "get": { "tags": [ "MarketplaceSellerPosition" ], "summary": "MarketplaceSellerPosition: GetPageView", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MarketplaceSellerPosition-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MarketplaceSellerPosition_GetPageView_DE8F3020E5D8", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/MarketplaceSellerPosition/Page": { "get": { "tags": [ "MarketplaceSellerPosition" ], "summary": "MarketplaceSellerPosition: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MarketplaceSellerPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MarketplaceSellerPosition_GetPage_19FCF36A934B", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/MarketplaceSellerPosition/PageAsc": { "get": { "tags": [ "MarketplaceSellerPosition" ], "summary": "MarketplaceSellerPosition: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MarketplaceSellerPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MarketplaceSellerPosition_GetPageAsc_413E0B740FA8", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/MarketplaceSellerPosition/SearchByValue": { "post": { "tags": [ "MarketplaceSellerPosition" ], "summary": "MarketplaceSellerPosition: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MarketplaceSellerPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MarketplaceSellerPosition_SearchByValue_02A387BD7AFC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.MarketplaceSellerPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.MarketplaceSellerPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.MarketplaceSellerPosition" } } } } } } }, "/api/MarketplaceSellerPosition/TryGetByValue": { "post": { "tags": [ "MarketplaceSellerPosition" ], "summary": "MarketplaceSellerPosition: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MarketplaceSellerPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MarketplaceSellerPosition_TryGetByValue_0018F9940C84", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.MarketplaceSellerPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.MarketplaceSellerPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.MarketplaceSellerPosition" } } } } } } }, "/api/MarketplaceSellerPosition/UpsertGraph": { "put": { "tags": [ "MarketplaceSellerPosition" ], "summary": "MarketplaceSellerPosition: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MarketplaceSellerPosition-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MarketplaceSellerPosition_UpsertGraph_50EF93F04B4A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.MarketplaceSellerPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.MarketplaceSellerPosition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.MarketplaceSellerPosition" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.MarketplaceSellerPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.MarketplaceSellerPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.MarketplaceSellerPosition" } } } } } } }, "/api/MarketplaceSellerPosition/UpsertGraphWithExtraFields": { "put": { "tags": [ "MarketplaceSellerPosition" ], "summary": "MarketplaceSellerPosition: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MarketplaceSellerPosition-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MarketplaceSellerPosition_UpsertGraphWithExtraFields_241194255F78", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.MarketplaceSellerPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.MarketplaceSellerPosition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.MarketplaceSellerPosition" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.MarketplaceSellerPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.MarketplaceSellerPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.MarketplaceSellerPosition" } } } } } } }, "/api/MarketplaceSetting": { "get": { "tags": [ "MarketplaceSetting" ], "summary": "MarketplaceSetting: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MarketplaceSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MarketplaceSetting_GetAll_71C985A9974B", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.MarketplaceSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.MarketplaceSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.MarketplaceSetting" } } } } } }, "post": { "tags": [ "MarketplaceSetting" ], "summary": "MarketplaceSetting: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MarketplaceSetting-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MarketplaceSetting_Post_8E032554F15B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.MarketplaceSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.MarketplaceSetting" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.MarketplaceSetting" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.MarketplaceSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.MarketplaceSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.MarketplaceSetting" } } } } } }, "put": { "tags": [ "MarketplaceSetting" ], "summary": "MarketplaceSetting: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MarketplaceSetting-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MarketplaceSetting_Put_25D58DB8163C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.MarketplaceSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.MarketplaceSetting" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.MarketplaceSetting" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.MarketplaceSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.MarketplaceSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.MarketplaceSetting" } } } } } } }, "/api/MarketplaceSetting/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "MarketplaceSetting" ], "summary": "MarketplaceSetting: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MarketplaceSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MarketplaceSetting_GetPageByValue_443A9497E3E5", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/MarketplaceSetting/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "MarketplaceSetting" ], "summary": "MarketplaceSetting: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MarketplaceSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MarketplaceSetting_GetPageByValue2_7C090245BA2B", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/MarketplaceSetting/DeleteByFilter": { "post": { "tags": [ "MarketplaceSetting" ], "summary": "MarketplaceSetting: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MarketplaceSetting-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MarketplaceSetting_DeleteByFilter_BB3DC98E586A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/MarketplaceSetting/GetAllByValue": { "post": { "tags": [ "MarketplaceSetting" ], "summary": "MarketplaceSetting: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MarketplaceSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MarketplaceSetting_GetAllByValue_8EB18EBA4880", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.MarketplaceSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.MarketplaceSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.MarketplaceSetting" } } } } } } }, "/api/MarketplaceSetting/GetAllGraphByValue": { "post": { "tags": [ "MarketplaceSetting" ], "summary": "MarketplaceSetting: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MarketplaceSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MarketplaceSetting_GetAllGraphByValue_DF97AE3D4BF0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.MarketplaceSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.MarketplaceSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.MarketplaceSetting" } } } } } } }, "/api/MarketplaceSetting/GetByValue": { "post": { "tags": [ "MarketplaceSetting" ], "summary": "MarketplaceSetting: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MarketplaceSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MarketplaceSetting_GetByValue_624325877143", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.MarketplaceSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.MarketplaceSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.MarketplaceSetting" } } } } } } }, "/api/MarketplaceSetting/GetLookup": { "post": { "tags": [ "MarketplaceSetting" ], "summary": "MarketplaceSetting: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MarketplaceSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MarketplaceSetting_GetLookup_53447D64CB53", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/MarketplaceSetting/GetLookupByValue": { "post": { "tags": [ "MarketplaceSetting" ], "summary": "MarketplaceSetting: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MarketplaceSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MarketplaceSetting_GetLookupByValue_B505FCFB71AD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/MarketplaceSetting/Page": { "get": { "tags": [ "MarketplaceSetting" ], "summary": "MarketplaceSetting: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MarketplaceSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MarketplaceSetting_GetPage_C7D59B726CF9", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/MarketplaceSetting/PageAsc": { "get": { "tags": [ "MarketplaceSetting" ], "summary": "MarketplaceSetting: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MarketplaceSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MarketplaceSetting_GetPageAsc_192BE83078AB", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/MarketplaceSetting/SearchByValue": { "post": { "tags": [ "MarketplaceSetting" ], "summary": "MarketplaceSetting: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MarketplaceSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MarketplaceSetting_SearchByValue_09756B328E8F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.MarketplaceSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.MarketplaceSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.MarketplaceSetting" } } } } } } }, "/api/MarketplaceSetting/TryGetByValue": { "post": { "tags": [ "MarketplaceSetting" ], "summary": "MarketplaceSetting: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MarketplaceSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MarketplaceSetting_TryGetByValue_28907FEC21A6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.MarketplaceSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.MarketplaceSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.MarketplaceSetting" } } } } } } }, "/api/MarketplaceSetting/UpsertGraph": { "put": { "tags": [ "MarketplaceSetting" ], "summary": "MarketplaceSetting: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MarketplaceSetting-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MarketplaceSetting_UpsertGraph_CD6E47BAD510", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.MarketplaceSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.MarketplaceSetting" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.MarketplaceSetting" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.MarketplaceSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.MarketplaceSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.MarketplaceSetting" } } } } } } }, "/api/MarketplaceSetting/UpsertGraphWithExtraFields": { "put": { "tags": [ "MarketplaceSetting" ], "summary": "MarketplaceSetting: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MarketplaceSetting-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MarketplaceSetting_UpsertGraphWithExtraFields_8A4730E79DAB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.MarketplaceSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.MarketplaceSetting" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.MarketplaceSetting" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.MarketplaceSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.MarketplaceSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.MarketplaceSetting" } } } } } } }, "/api/MassEmail": { "get": { "tags": [ "MassEmail" ], "summary": "MassEmail: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MassEmail-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MassEmail_GetAll_EC709567E0E2", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.MassEmail" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.MassEmail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.MassEmail" } } } } } }, "post": { "tags": [ "MassEmail" ], "summary": "MassEmail: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MassEmail-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MassEmail_Post_3988EC8158E4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.MassEmail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.MassEmail" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.MassEmail" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.MassEmail" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.MassEmail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.MassEmail" } } } } } }, "put": { "tags": [ "MassEmail" ], "summary": "MassEmail: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MassEmail-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MassEmail_Put_025FD12CB167", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.MassEmail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.MassEmail" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.MassEmail" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.MassEmail" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.MassEmail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.MassEmail" } } } } } } }, "/api/MassEmail/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "MassEmail" ], "summary": "MassEmail: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MassEmail-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MassEmail_GetPageByValue_E29F5E293DF4", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/MassEmail/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "MassEmail" ], "summary": "MassEmail: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MassEmail-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MassEmail_GetPageByValue2_2EF659A0DF73", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/MassEmail/AddContactPersonRecipients/{MassEmailId}": { "post": { "tags": [ "MassEmail" ], "summary": "MassEmail: AddContactPersonRecipients", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MassEmail-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MassEmail_AddContactPersonRecipients_587B78B8A134", "parameters": [ { "name": "MassEmailId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/MassEmail/AddPartnerRecipients/{MassEmailId}": { "post": { "tags": [ "MassEmail" ], "summary": "MassEmail: AddPartnerRecipients", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MassEmail-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MassEmail_AddPartnerRecipients_4D7DBC202D81", "parameters": [ { "name": "MassEmailId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/MassEmail/DeleteByFilter": { "post": { "tags": [ "MassEmail" ], "summary": "MassEmail: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MassEmail-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MassEmail_DeleteByFilter_4518509C7531", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/MassEmail/FillRecipientsFromPartnerGroup/{MassEmailId}/{PartnerGroupId}/{IncludeSubGroups}": { "post": { "tags": [ "MassEmail" ], "summary": "MassEmail: FillRecipientsFromPartnerGroup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MassEmail-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MassEmail_FillRecipientsFromPartnerGroup_68E9EEA0C838", "parameters": [ { "name": "MassEmailId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PartnerGroupId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "IncludeSubGroups", "in": "path", "required": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/MassEmail/GetAllByValue": { "post": { "tags": [ "MassEmail" ], "summary": "MassEmail: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MassEmail-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MassEmail_GetAllByValue_784E2773B03E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.MassEmail" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.MassEmail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.MassEmail" } } } } } } }, "/api/MassEmail/GetAllGraphByValue": { "post": { "tags": [ "MassEmail" ], "summary": "MassEmail: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MassEmail-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MassEmail_GetAllGraphByValue_2029DD8C9572", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.MassEmail" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.MassEmail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.MassEmail" } } } } } } }, "/api/MassEmail/GetByValue": { "post": { "tags": [ "MassEmail" ], "summary": "MassEmail: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MassEmail-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MassEmail_GetByValue_5C5A5DD7593E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.MassEmail" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.MassEmail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.MassEmail" } } } } } } }, "/api/MassEmail/GetLookup": { "post": { "tags": [ "MassEmail" ], "summary": "MassEmail: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MassEmail-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MassEmail_GetLookup_AC81DA03FD13", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/MassEmail/GetLookupByValue": { "post": { "tags": [ "MassEmail" ], "summary": "MassEmail: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MassEmail-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MassEmail_GetLookupByValue_F9C943847B0E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/MassEmail/Page": { "get": { "tags": [ "MassEmail" ], "summary": "MassEmail: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MassEmail-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MassEmail_GetPage_CFCB811FFA60", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/MassEmail/PageAsc": { "get": { "tags": [ "MassEmail" ], "summary": "MassEmail: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MassEmail-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MassEmail_GetPageAsc_BDA7CF3FF58B", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/MassEmail/PageFromView": { "get": { "tags": [ "MassEmail" ], "summary": "MassEmail: GetPageFromView", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MassEmail-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MassEmail_GetPageFromView_A06FA858A2B1", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/MassEmail/PageRecipientDetailByMassEmailId/{MassEmailId}": { "get": { "tags": [ "MassEmail" ], "summary": "MassEmail: GetRecipientDetailPageByMassEmailId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MassEmail-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MassEmail_GetRecipientDetailPageByMassEmailId_E576B198C0C6", "parameters": [ { "name": "MassEmailId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/MassEmail/PageRecipientDetailByPartnerId/{PartnerId}": { "get": { "tags": [ "MassEmail" ], "summary": "MassEmail: GetRecipientDetailPageByPartnerId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MassEmail-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MassEmail_GetRecipientDetailPageByPartnerId_426602EA2D06", "parameters": [ { "name": "PartnerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/MassEmail/SearchByValue": { "post": { "tags": [ "MassEmail" ], "summary": "MassEmail: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MassEmail-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MassEmail_SearchByValue_1221D489DE75", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.MassEmail" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.MassEmail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.MassEmail" } } } } } } }, "/api/MassEmail/SearchContactPersonCandidates": { "post": { "tags": [ "MassEmail" ], "summary": "MassEmail: SearchContactPersonCandidates", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MassEmail-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MassEmail_SearchContactPersonCandidates_ED9571C7AC05", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.MassEmailCandidateFilter" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.MassEmailCandidateFilter" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.MassEmailCandidateFilter" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.MassEmailRecipientCandidate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.MassEmailRecipientCandidate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.MassEmailRecipientCandidate" } } } } } } }, "/api/MassEmail/SearchPartnerCandidates": { "post": { "tags": [ "MassEmail" ], "summary": "MassEmail: SearchPartnerCandidates", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MassEmail-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MassEmail_SearchPartnerCandidates_40CD96C092A7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.MassEmailCandidateFilter" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.MassEmailCandidateFilter" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.MassEmailCandidateFilter" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.MassEmailRecipientCandidate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.MassEmailRecipientCandidate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.MassEmailRecipientCandidate" } } } } } } }, "/api/MassEmail/Send/{MassEmailId}": { "post": { "tags": [ "MassEmail" ], "summary": "MassEmail: Send", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MassEmail-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MassEmail_Send_AB579D740D21", "parameters": [ { "name": "MassEmailId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.MassEmail" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.MassEmail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.MassEmail" } } } } } } }, "/api/MassEmail/TryGetByValue": { "post": { "tags": [ "MassEmail" ], "summary": "MassEmail: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MassEmail-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MassEmail_TryGetByValue_88F5AC34D674", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.MassEmail" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.MassEmail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.MassEmail" } } } } } } }, "/api/MassEmail/UpsertGraph": { "put": { "tags": [ "MassEmail" ], "summary": "MassEmail: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MassEmail-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MassEmail_UpsertGraph_8C6F046BA52C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.MassEmail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.MassEmail" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.MassEmail" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.MassEmail" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.MassEmail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.MassEmail" } } } } } } }, "/api/MassEmail/UpsertGraphWithExtraFields": { "put": { "tags": [ "MassEmail" ], "summary": "MassEmail: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MassEmail-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MassEmail_UpsertGraphWithExtraFields_BFB1FD1ABAF8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.MassEmail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.MassEmail" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.MassEmail" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.MassEmail" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.MassEmail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.MassEmail" } } } } } } }, "/api/MassEmailRecipient": { "get": { "tags": [ "MassEmailRecipient" ], "summary": "MassEmailRecipient: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MassEmailRecipient-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MassEmailRecipient_GetAll_D93F22066B50", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.MassEmailRecipient" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.MassEmailRecipient" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.MassEmailRecipient" } } } } } }, "post": { "tags": [ "MassEmailRecipient" ], "summary": "MassEmailRecipient: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MassEmailRecipient-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MassEmailRecipient_Post_3F26F92558ED", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.MassEmailRecipient" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.MassEmailRecipient" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.MassEmailRecipient" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.MassEmailRecipient" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.MassEmailRecipient" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.MassEmailRecipient" } } } } } }, "put": { "tags": [ "MassEmailRecipient" ], "summary": "MassEmailRecipient: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MassEmailRecipient-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MassEmailRecipient_Put_D46304B86F6A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.MassEmailRecipient" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.MassEmailRecipient" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.MassEmailRecipient" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.MassEmailRecipient" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.MassEmailRecipient" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.MassEmailRecipient" } } } } } } }, "/api/MassEmailRecipient/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "MassEmailRecipient" ], "summary": "MassEmailRecipient: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MassEmailRecipient-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MassEmailRecipient_GetPageByValue_8B7D25F82862", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/MassEmailRecipient/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "MassEmailRecipient" ], "summary": "MassEmailRecipient: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MassEmailRecipient-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MassEmailRecipient_GetPageByValue2_FF55FA8C4CDE", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/MassEmailRecipient/DeleteByFilter": { "post": { "tags": [ "MassEmailRecipient" ], "summary": "MassEmailRecipient: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MassEmailRecipient-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MassEmailRecipient_DeleteByFilter_BC9E41BDF698", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/MassEmailRecipient/GetAllByValue": { "post": { "tags": [ "MassEmailRecipient" ], "summary": "MassEmailRecipient: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MassEmailRecipient-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MassEmailRecipient_GetAllByValue_A6C1A1DB3DC2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.MassEmailRecipient" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.MassEmailRecipient" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.MassEmailRecipient" } } } } } } }, "/api/MassEmailRecipient/GetAllGraphByValue": { "post": { "tags": [ "MassEmailRecipient" ], "summary": "MassEmailRecipient: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MassEmailRecipient-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MassEmailRecipient_GetAllGraphByValue_94CBFAB4A4BB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.MassEmailRecipient" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.MassEmailRecipient" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.MassEmailRecipient" } } } } } } }, "/api/MassEmailRecipient/GetByValue": { "post": { "tags": [ "MassEmailRecipient" ], "summary": "MassEmailRecipient: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MassEmailRecipient-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MassEmailRecipient_GetByValue_E728901EC83D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.MassEmailRecipient" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.MassEmailRecipient" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.MassEmailRecipient" } } } } } } }, "/api/MassEmailRecipient/GetLookup": { "post": { "tags": [ "MassEmailRecipient" ], "summary": "MassEmailRecipient: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MassEmailRecipient-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MassEmailRecipient_GetLookup_7CA72798A4D2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/MassEmailRecipient/GetLookupByValue": { "post": { "tags": [ "MassEmailRecipient" ], "summary": "MassEmailRecipient: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MassEmailRecipient-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MassEmailRecipient_GetLookupByValue_34C6155FD462", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/MassEmailRecipient/Page": { "get": { "tags": [ "MassEmailRecipient" ], "summary": "MassEmailRecipient: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MassEmailRecipient-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MassEmailRecipient_GetPage_40C4A64A7639", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/MassEmailRecipient/PageAsc": { "get": { "tags": [ "MassEmailRecipient" ], "summary": "MassEmailRecipient: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MassEmailRecipient-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MassEmailRecipient_GetPageAsc_9294E878E87C", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/MassEmailRecipient/SearchByValue": { "post": { "tags": [ "MassEmailRecipient" ], "summary": "MassEmailRecipient: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MassEmailRecipient-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MassEmailRecipient_SearchByValue_9513DA13F304", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.MassEmailRecipient" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.MassEmailRecipient" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.MassEmailRecipient" } } } } } } }, "/api/MassEmailRecipient/TryGetByValue": { "post": { "tags": [ "MassEmailRecipient" ], "summary": "MassEmailRecipient: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MassEmailRecipient-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MassEmailRecipient_TryGetByValue_A5F29CCAE741", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.MassEmailRecipient" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.MassEmailRecipient" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.MassEmailRecipient" } } } } } } }, "/api/MassEmailRecipient/UpsertGraph": { "put": { "tags": [ "MassEmailRecipient" ], "summary": "MassEmailRecipient: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MassEmailRecipient-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MassEmailRecipient_UpsertGraph_56289519D9B1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.MassEmailRecipient" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.MassEmailRecipient" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.MassEmailRecipient" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.MassEmailRecipient" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.MassEmailRecipient" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.MassEmailRecipient" } } } } } } }, "/api/MassEmailRecipient/UpsertGraphWithExtraFields": { "put": { "tags": [ "MassEmailRecipient" ], "summary": "MassEmailRecipient: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: MassEmailRecipient-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "MassEmailRecipient_UpsertGraphWithExtraFields_971C7A619364", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.MassEmailRecipient" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.MassEmailRecipient" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.MassEmailRecipient" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.MassEmailRecipient" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.MassEmailRecipient" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.MassEmailRecipient" } } } } } } }, "/api/OutputControlButton": { "get": { "tags": [ "OutputControlButton" ], "summary": "OutputControlButton: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: OutputControlButton-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "OutputControlButton_GetAll_CF609B705D81", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.OutputControlButton" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.OutputControlButton" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.OutputControlButton" } } } } } }, "post": { "tags": [ "OutputControlButton" ], "summary": "OutputControlButton: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: OutputControlButton-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "OutputControlButton_Post_C58DCE28DF0A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.OutputControlButton" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.OutputControlButton" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.OutputControlButton" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.OutputControlButton" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.OutputControlButton" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.OutputControlButton" } } } } } }, "put": { "tags": [ "OutputControlButton" ], "summary": "OutputControlButton: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: OutputControlButton-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "OutputControlButton_Put_77745D660605", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.OutputControlButton" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.OutputControlButton" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.OutputControlButton" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.OutputControlButton" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.OutputControlButton" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.OutputControlButton" } } } } } } }, "/api/OutputControlButton/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "OutputControlButton" ], "summary": "OutputControlButton: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: OutputControlButton-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "OutputControlButton_GetPageByValue_4D60B0EC65C9", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/OutputControlButton/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "OutputControlButton" ], "summary": "OutputControlButton: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: OutputControlButton-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "OutputControlButton_GetPageByValue2_490A08C1347C", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/OutputControlButton/DeleteByFilter": { "post": { "tags": [ "OutputControlButton" ], "summary": "OutputControlButton: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: OutputControlButton-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "OutputControlButton_DeleteByFilter_8D4D6A4D86F4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/OutputControlButton/GetAllByValue": { "post": { "tags": [ "OutputControlButton" ], "summary": "OutputControlButton: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: OutputControlButton-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "OutputControlButton_GetAllByValue_350F816FD2AA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.OutputControlButton" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.OutputControlButton" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.OutputControlButton" } } } } } } }, "/api/OutputControlButton/GetAllGraphByValue": { "post": { "tags": [ "OutputControlButton" ], "summary": "OutputControlButton: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: OutputControlButton-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "OutputControlButton_GetAllGraphByValue_A0657263B40D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.OutputControlButton" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.OutputControlButton" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.OutputControlButton" } } } } } } }, "/api/OutputControlButton/GetByValue": { "post": { "tags": [ "OutputControlButton" ], "summary": "OutputControlButton: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: OutputControlButton-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "OutputControlButton_GetByValue_E9783F44D95E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.OutputControlButton" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.OutputControlButton" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.OutputControlButton" } } } } } } }, "/api/OutputControlButton/GetLookup": { "post": { "tags": [ "OutputControlButton" ], "summary": "OutputControlButton: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: OutputControlButton-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "OutputControlButton_GetLookup_D73F9D54756C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/OutputControlButton/GetLookupByValue": { "post": { "tags": [ "OutputControlButton" ], "summary": "OutputControlButton: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: OutputControlButton-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "OutputControlButton_GetLookupByValue_EDD72DEF5697", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/OutputControlButton/Page": { "get": { "tags": [ "OutputControlButton" ], "summary": "OutputControlButton: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: OutputControlButton-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "OutputControlButton_GetPage_AC1220ABAA7A", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/OutputControlButton/PageAsc": { "get": { "tags": [ "OutputControlButton" ], "summary": "OutputControlButton: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: OutputControlButton-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "OutputControlButton_GetPageAsc_F5581CBBE685", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/OutputControlButton/SearchByValue": { "post": { "tags": [ "OutputControlButton" ], "summary": "OutputControlButton: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: OutputControlButton-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "OutputControlButton_SearchByValue_61BE07DC92C7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.OutputControlButton" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.OutputControlButton" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.OutputControlButton" } } } } } } }, "/api/OutputControlButton/TryGetByValue": { "post": { "tags": [ "OutputControlButton" ], "summary": "OutputControlButton: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: OutputControlButton-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "OutputControlButton_TryGetByValue_711BFF84A5E2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.OutputControlButton" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.OutputControlButton" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.OutputControlButton" } } } } } } }, "/api/OutputControlButton/UpsertGraph": { "put": { "tags": [ "OutputControlButton" ], "summary": "OutputControlButton: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: OutputControlButton-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "OutputControlButton_UpsertGraph_BA121DE65981", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.OutputControlButton" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.OutputControlButton" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.OutputControlButton" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.OutputControlButton" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.OutputControlButton" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.OutputControlButton" } } } } } } }, "/api/OutputControlButton/UpsertGraphWithExtraFields": { "put": { "tags": [ "OutputControlButton" ], "summary": "OutputControlButton: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: OutputControlButton-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "OutputControlButton_UpsertGraphWithExtraFields_FD005891E15C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.OutputControlButton" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.OutputControlButton" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.OutputControlButton" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.OutputControlButton" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.OutputControlButton" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.OutputControlButton" } } } } } } }, "/api/OutputControlFormat": { "get": { "tags": [ "OutputControlFormat" ], "summary": "OutputControlFormat: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: OutputControlFormat-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "OutputControlFormat_GetAll_AEC5A62BC3E0", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.OutputControlFormat" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.OutputControlFormat" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.OutputControlFormat" } } } } } }, "post": { "tags": [ "OutputControlFormat" ], "summary": "OutputControlFormat: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: OutputControlFormat-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "OutputControlFormat_Post_11EAB7697EF4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.OutputControlFormat" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.OutputControlFormat" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.OutputControlFormat" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.OutputControlFormat" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.OutputControlFormat" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.OutputControlFormat" } } } } } }, "put": { "tags": [ "OutputControlFormat" ], "summary": "OutputControlFormat: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: OutputControlFormat-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "OutputControlFormat_Put_E9DA06D60633", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.OutputControlFormat" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.OutputControlFormat" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.OutputControlFormat" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.OutputControlFormat" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.OutputControlFormat" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.OutputControlFormat" } } } } } } }, "/api/OutputControlFormat/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "OutputControlFormat" ], "summary": "OutputControlFormat: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: OutputControlFormat-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "OutputControlFormat_GetPageByValue_DC28F1AF2DDE", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/OutputControlFormat/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "OutputControlFormat" ], "summary": "OutputControlFormat: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: OutputControlFormat-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "OutputControlFormat_GetPageByValue2_E093E91786B4", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/OutputControlFormat/DeleteByFilter": { "post": { "tags": [ "OutputControlFormat" ], "summary": "OutputControlFormat: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: OutputControlFormat-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "OutputControlFormat_DeleteByFilter_FABD77EEBD9C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/OutputControlFormat/GetAllByValue": { "post": { "tags": [ "OutputControlFormat" ], "summary": "OutputControlFormat: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: OutputControlFormat-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "OutputControlFormat_GetAllByValue_3C6EA18144D3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.OutputControlFormat" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.OutputControlFormat" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.OutputControlFormat" } } } } } } }, "/api/OutputControlFormat/GetAllGraphByValue": { "post": { "tags": [ "OutputControlFormat" ], "summary": "OutputControlFormat: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: OutputControlFormat-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "OutputControlFormat_GetAllGraphByValue_F3D1D6EF4859", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.OutputControlFormat" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.OutputControlFormat" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.OutputControlFormat" } } } } } } }, "/api/OutputControlFormat/GetByValue": { "post": { "tags": [ "OutputControlFormat" ], "summary": "OutputControlFormat: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: OutputControlFormat-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "OutputControlFormat_GetByValue_FC5759593FC0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.OutputControlFormat" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.OutputControlFormat" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.OutputControlFormat" } } } } } } }, "/api/OutputControlFormat/GetLookup": { "post": { "tags": [ "OutputControlFormat" ], "summary": "OutputControlFormat: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: OutputControlFormat-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "OutputControlFormat_GetLookup_28AB74DD0A56", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/OutputControlFormat/GetLookupByValue": { "post": { "tags": [ "OutputControlFormat" ], "summary": "OutputControlFormat: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: OutputControlFormat-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "OutputControlFormat_GetLookupByValue_3149ABFF3644", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/OutputControlFormat/Page": { "get": { "tags": [ "OutputControlFormat" ], "summary": "OutputControlFormat: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: OutputControlFormat-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "OutputControlFormat_GetPage_D7BCDCF67693", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/OutputControlFormat/PageAsc": { "get": { "tags": [ "OutputControlFormat" ], "summary": "OutputControlFormat: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: OutputControlFormat-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "OutputControlFormat_GetPageAsc_48570693F500", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/OutputControlFormat/SearchByValue": { "post": { "tags": [ "OutputControlFormat" ], "summary": "OutputControlFormat: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: OutputControlFormat-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "OutputControlFormat_SearchByValue_BA9C900445D3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.OutputControlFormat" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.OutputControlFormat" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.OutputControlFormat" } } } } } } }, "/api/OutputControlFormat/TryGetByValue": { "post": { "tags": [ "OutputControlFormat" ], "summary": "OutputControlFormat: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: OutputControlFormat-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "OutputControlFormat_TryGetByValue_C3BC658DAC00", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.OutputControlFormat" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.OutputControlFormat" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.OutputControlFormat" } } } } } } }, "/api/OutputControlFormat/UpsertGraph": { "put": { "tags": [ "OutputControlFormat" ], "summary": "OutputControlFormat: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: OutputControlFormat-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "OutputControlFormat_UpsertGraph_7209A7C2E5F2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.OutputControlFormat" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.OutputControlFormat" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.OutputControlFormat" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.OutputControlFormat" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.OutputControlFormat" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.OutputControlFormat" } } } } } } }, "/api/OutputControlFormat/UpsertGraphWithExtraFields": { "put": { "tags": [ "OutputControlFormat" ], "summary": "OutputControlFormat: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: OutputControlFormat-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "OutputControlFormat_UpsertGraphWithExtraFields_E48592764DCE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.OutputControlFormat" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.OutputControlFormat" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.OutputControlFormat" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.OutputControlFormat" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.OutputControlFormat" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.OutputControlFormat" } } } } } } }, "/api/OutputControlMedium": { "get": { "tags": [ "OutputControlMedium" ], "summary": "OutputControlMedium: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: OutputControlMedium-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "OutputControlMedium_GetAll_E58FA8B4C28F", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.OutputControlMedium" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.OutputControlMedium" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.OutputControlMedium" } } } } } }, "post": { "tags": [ "OutputControlMedium" ], "summary": "OutputControlMedium: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: OutputControlMedium-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "OutputControlMedium_Post_68008FF459E9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.OutputControlMedium" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.OutputControlMedium" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.OutputControlMedium" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.OutputControlMedium" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.OutputControlMedium" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.OutputControlMedium" } } } } } }, "put": { "tags": [ "OutputControlMedium" ], "summary": "OutputControlMedium: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: OutputControlMedium-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "OutputControlMedium_Put_1BE6CF6BD642", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.OutputControlMedium" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.OutputControlMedium" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.OutputControlMedium" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.OutputControlMedium" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.OutputControlMedium" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.OutputControlMedium" } } } } } } }, "/api/OutputControlMedium/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "OutputControlMedium" ], "summary": "OutputControlMedium: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: OutputControlMedium-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "OutputControlMedium_GetPageByValue_F6F2D6AE2D50", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/OutputControlMedium/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "OutputControlMedium" ], "summary": "OutputControlMedium: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: OutputControlMedium-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "OutputControlMedium_GetPageByValue2_29478B638670", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/OutputControlMedium/DeleteByFilter": { "post": { "tags": [ "OutputControlMedium" ], "summary": "OutputControlMedium: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: OutputControlMedium-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "OutputControlMedium_DeleteByFilter_0A1B170D3754", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/OutputControlMedium/GetAllByValue": { "post": { "tags": [ "OutputControlMedium" ], "summary": "OutputControlMedium: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: OutputControlMedium-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "OutputControlMedium_GetAllByValue_0221E474013D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.OutputControlMedium" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.OutputControlMedium" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.OutputControlMedium" } } } } } } }, "/api/OutputControlMedium/GetAllGraphByValue": { "post": { "tags": [ "OutputControlMedium" ], "summary": "OutputControlMedium: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: OutputControlMedium-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "OutputControlMedium_GetAllGraphByValue_093004D496B9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.OutputControlMedium" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.OutputControlMedium" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.OutputControlMedium" } } } } } } }, "/api/OutputControlMedium/GetByValue": { "post": { "tags": [ "OutputControlMedium" ], "summary": "OutputControlMedium: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: OutputControlMedium-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "OutputControlMedium_GetByValue_1556B9891E77", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.OutputControlMedium" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.OutputControlMedium" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.OutputControlMedium" } } } } } } }, "/api/OutputControlMedium/GetLookup": { "post": { "tags": [ "OutputControlMedium" ], "summary": "OutputControlMedium: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: OutputControlMedium-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "OutputControlMedium_GetLookup_A70A8C1341A8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/OutputControlMedium/GetLookupByValue": { "post": { "tags": [ "OutputControlMedium" ], "summary": "OutputControlMedium: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: OutputControlMedium-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "OutputControlMedium_GetLookupByValue_E2591BDDD38C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/OutputControlMedium/Page": { "get": { "tags": [ "OutputControlMedium" ], "summary": "OutputControlMedium: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: OutputControlMedium-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "OutputControlMedium_GetPage_19A2D86CA53D", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/OutputControlMedium/PageAsc": { "get": { "tags": [ "OutputControlMedium" ], "summary": "OutputControlMedium: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: OutputControlMedium-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "OutputControlMedium_GetPageAsc_B633FE83B917", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/OutputControlMedium/SearchByValue": { "post": { "tags": [ "OutputControlMedium" ], "summary": "OutputControlMedium: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: OutputControlMedium-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "OutputControlMedium_SearchByValue_7D2342BBAF46", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.OutputControlMedium" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.OutputControlMedium" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.OutputControlMedium" } } } } } } }, "/api/OutputControlMedium/TryGetByValue": { "post": { "tags": [ "OutputControlMedium" ], "summary": "OutputControlMedium: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: OutputControlMedium-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "OutputControlMedium_TryGetByValue_561EA4051A01", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.OutputControlMedium" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.OutputControlMedium" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.OutputControlMedium" } } } } } } }, "/api/OutputControlMedium/UpsertGraph": { "put": { "tags": [ "OutputControlMedium" ], "summary": "OutputControlMedium: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: OutputControlMedium-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "OutputControlMedium_UpsertGraph_EC445DFC49FA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.OutputControlMedium" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.OutputControlMedium" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.OutputControlMedium" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.OutputControlMedium" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.OutputControlMedium" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.OutputControlMedium" } } } } } } }, "/api/OutputControlMedium/UpsertGraphWithExtraFields": { "put": { "tags": [ "OutputControlMedium" ], "summary": "OutputControlMedium: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: OutputControlMedium-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "OutputControlMedium_UpsertGraphWithExtraFields_5E491544EDA1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.OutputControlMedium" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.OutputControlMedium" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.OutputControlMedium" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.OutputControlMedium" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.OutputControlMedium" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.OutputControlMedium" } } } } } } }, "/api/OutputControlPrinterConfiguration": { "get": { "tags": [ "OutputControlPrinterConfiguration" ], "summary": "OutputControlPrinterConfiguration: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: OutputControlPrinterConfiguration-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "OutputControlPrinterConfiguration_GetAll_08A94EC3D466", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.OutputControlPrinterConfiguration" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.OutputControlPrinterConfiguration" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.OutputControlPrinterConfiguration" } } } } } }, "post": { "tags": [ "OutputControlPrinterConfiguration" ], "summary": "OutputControlPrinterConfiguration: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: OutputControlPrinterConfiguration-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "OutputControlPrinterConfiguration_Post_0FED996A4ED8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.OutputControlPrinterConfiguration" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.OutputControlPrinterConfiguration" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.OutputControlPrinterConfiguration" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.OutputControlPrinterConfiguration" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.OutputControlPrinterConfiguration" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.OutputControlPrinterConfiguration" } } } } } }, "put": { "tags": [ "OutputControlPrinterConfiguration" ], "summary": "OutputControlPrinterConfiguration: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: OutputControlPrinterConfiguration-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "OutputControlPrinterConfiguration_Put_4AADB9ACFB93", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.OutputControlPrinterConfiguration" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.OutputControlPrinterConfiguration" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.OutputControlPrinterConfiguration" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.OutputControlPrinterConfiguration" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.OutputControlPrinterConfiguration" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.OutputControlPrinterConfiguration" } } } } } } }, "/api/OutputControlPrinterConfiguration/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "OutputControlPrinterConfiguration" ], "summary": "OutputControlPrinterConfiguration: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: OutputControlPrinterConfiguration-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "OutputControlPrinterConfiguration_GetPageByValue_34C40C6700FD", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/OutputControlPrinterConfiguration/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "OutputControlPrinterConfiguration" ], "summary": "OutputControlPrinterConfiguration: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: OutputControlPrinterConfiguration-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "OutputControlPrinterConfiguration_GetPageByValue2_C1B8EFC68C60", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/OutputControlPrinterConfiguration/DeleteByFilter": { "post": { "tags": [ "OutputControlPrinterConfiguration" ], "summary": "OutputControlPrinterConfiguration: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: OutputControlPrinterConfiguration-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "OutputControlPrinterConfiguration_DeleteByFilter_44E608157A4D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/OutputControlPrinterConfiguration/GetAllByValue": { "post": { "tags": [ "OutputControlPrinterConfiguration" ], "summary": "OutputControlPrinterConfiguration: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: OutputControlPrinterConfiguration-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "OutputControlPrinterConfiguration_GetAllByValue_3FC4A28E7EE1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.OutputControlPrinterConfiguration" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.OutputControlPrinterConfiguration" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.OutputControlPrinterConfiguration" } } } } } } }, "/api/OutputControlPrinterConfiguration/GetAllGraphByValue": { "post": { "tags": [ "OutputControlPrinterConfiguration" ], "summary": "OutputControlPrinterConfiguration: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: OutputControlPrinterConfiguration-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "OutputControlPrinterConfiguration_GetAllGraphByValue_7857A2AA4849", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.OutputControlPrinterConfiguration" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.OutputControlPrinterConfiguration" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.OutputControlPrinterConfiguration" } } } } } } }, "/api/OutputControlPrinterConfiguration/GetByValue": { "post": { "tags": [ "OutputControlPrinterConfiguration" ], "summary": "OutputControlPrinterConfiguration: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: OutputControlPrinterConfiguration-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "OutputControlPrinterConfiguration_GetByValue_288F3CC8C846", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.OutputControlPrinterConfiguration" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.OutputControlPrinterConfiguration" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.OutputControlPrinterConfiguration" } } } } } } }, "/api/OutputControlPrinterConfiguration/GetLookup": { "post": { "tags": [ "OutputControlPrinterConfiguration" ], "summary": "OutputControlPrinterConfiguration: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: OutputControlPrinterConfiguration-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "OutputControlPrinterConfiguration_GetLookup_13367AF9DAEE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/OutputControlPrinterConfiguration/GetLookupByValue": { "post": { "tags": [ "OutputControlPrinterConfiguration" ], "summary": "OutputControlPrinterConfiguration: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: OutputControlPrinterConfiguration-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "OutputControlPrinterConfiguration_GetLookupByValue_439B384DA4A9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/OutputControlPrinterConfiguration/Page": { "get": { "tags": [ "OutputControlPrinterConfiguration" ], "summary": "OutputControlPrinterConfiguration: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: OutputControlPrinterConfiguration-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "OutputControlPrinterConfiguration_GetPage_3A85D567C9C6", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/OutputControlPrinterConfiguration/PageAsc": { "get": { "tags": [ "OutputControlPrinterConfiguration" ], "summary": "OutputControlPrinterConfiguration: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: OutputControlPrinterConfiguration-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "OutputControlPrinterConfiguration_GetPageAsc_CC680C522560", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/OutputControlPrinterConfiguration/SearchByValue": { "post": { "tags": [ "OutputControlPrinterConfiguration" ], "summary": "OutputControlPrinterConfiguration: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: OutputControlPrinterConfiguration-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "OutputControlPrinterConfiguration_SearchByValue_B23115CD146B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.OutputControlPrinterConfiguration" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.OutputControlPrinterConfiguration" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.OutputControlPrinterConfiguration" } } } } } } }, "/api/OutputControlPrinterConfiguration/TryGetByValue": { "post": { "tags": [ "OutputControlPrinterConfiguration" ], "summary": "OutputControlPrinterConfiguration: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: OutputControlPrinterConfiguration-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "OutputControlPrinterConfiguration_TryGetByValue_9363FA0D2FC9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.OutputControlPrinterConfiguration" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.OutputControlPrinterConfiguration" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.OutputControlPrinterConfiguration" } } } } } } }, "/api/OutputControlPrinterConfiguration/UpsertGraph": { "put": { "tags": [ "OutputControlPrinterConfiguration" ], "summary": "OutputControlPrinterConfiguration: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: OutputControlPrinterConfiguration-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "OutputControlPrinterConfiguration_UpsertGraph_F28E4E00CDFC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.OutputControlPrinterConfiguration" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.OutputControlPrinterConfiguration" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.OutputControlPrinterConfiguration" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.OutputControlPrinterConfiguration" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.OutputControlPrinterConfiguration" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.OutputControlPrinterConfiguration" } } } } } } }, "/api/OutputControlPrinterConfiguration/UpsertGraphWithExtraFields": { "put": { "tags": [ "OutputControlPrinterConfiguration" ], "summary": "OutputControlPrinterConfiguration: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: OutputControlPrinterConfiguration-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "OutputControlPrinterConfiguration_UpsertGraphWithExtraFields_006D75C8D8C2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.OutputControlPrinterConfiguration" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.OutputControlPrinterConfiguration" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.OutputControlPrinterConfiguration" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.OutputControlPrinterConfiguration" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.OutputControlPrinterConfiguration" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.OutputControlPrinterConfiguration" } } } } } } }, "/api/PackingListBox": { "get": { "tags": [ "PackingListBox" ], "summary": "PackingListBox: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PackingListBox-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PackingListBox_GetAll_8ACB5BAEBB26", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PackingListBox" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PackingListBox" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PackingListBox" } } } } } }, "post": { "tags": [ "PackingListBox" ], "summary": "PackingListBox: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PackingListBox-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PackingListBox_Post_8BF8CEDF9783", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PackingListBox" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PackingListBox" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PackingListBox" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PackingListBox" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PackingListBox" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PackingListBox" } } } } } }, "put": { "tags": [ "PackingListBox" ], "summary": "PackingListBox: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PackingListBox-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PackingListBox_Put_ECC0F2019823", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PackingListBox" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PackingListBox" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PackingListBox" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PackingListBox" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PackingListBox" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PackingListBox" } } } } } } }, "/api/PackingListBox/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "PackingListBox" ], "summary": "PackingListBox: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PackingListBox-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PackingListBox_GetPageByValue_A5DC6A4A8C66", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PackingListBox/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "PackingListBox" ], "summary": "PackingListBox: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PackingListBox-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PackingListBox_GetPageByValue2_1C33163C4E6B", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PackingListBox/DeleteByFilter": { "post": { "tags": [ "PackingListBox" ], "summary": "PackingListBox: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PackingListBox-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PackingListBox_DeleteByFilter_0087B306CCED", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/PackingListBox/GetAllByValue": { "post": { "tags": [ "PackingListBox" ], "summary": "PackingListBox: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PackingListBox-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PackingListBox_GetAllByValue_4EDF201E3FC2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PackingListBox" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PackingListBox" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PackingListBox" } } } } } } }, "/api/PackingListBox/GetAllGraphByValue": { "post": { "tags": [ "PackingListBox" ], "summary": "PackingListBox: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PackingListBox-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PackingListBox_GetAllGraphByValue_EA338CF50ACC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PackingListBox" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PackingListBox" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PackingListBox" } } } } } } }, "/api/PackingListBox/GetByValue": { "post": { "tags": [ "PackingListBox" ], "summary": "PackingListBox: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PackingListBox-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PackingListBox_GetByValue_CF87F3181B84", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PackingListBox" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PackingListBox" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PackingListBox" } } } } } } }, "/api/PackingListBox/GetLookup": { "post": { "tags": [ "PackingListBox" ], "summary": "PackingListBox: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PackingListBox-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PackingListBox_GetLookup_BACA3D1001DB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/PackingListBox/GetLookupByValue": { "post": { "tags": [ "PackingListBox" ], "summary": "PackingListBox: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PackingListBox-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PackingListBox_GetLookupByValue_8D4E0C06CF75", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/PackingListBox/Page": { "get": { "tags": [ "PackingListBox" ], "summary": "PackingListBox: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PackingListBox-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PackingListBox_GetPage_C951F4CD06DE", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PackingListBox/PageAsc": { "get": { "tags": [ "PackingListBox" ], "summary": "PackingListBox: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PackingListBox-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PackingListBox_GetPageAsc_FFDC39A3857B", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PackingListBox/PageFromView": { "get": { "tags": [ "PackingListBox" ], "summary": "PackingListBox: GetPageFromView", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PackingListBox-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PackingListBox_GetPageFromView_30CE82A4A384", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PackingListBox/SearchByValue": { "post": { "tags": [ "PackingListBox" ], "summary": "PackingListBox: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PackingListBox-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PackingListBox_SearchByValue_4E6B59E2E5E4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PackingListBox" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PackingListBox" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PackingListBox" } } } } } } }, "/api/PackingListBox/TryGetByValue": { "post": { "tags": [ "PackingListBox" ], "summary": "PackingListBox: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PackingListBox-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PackingListBox_TryGetByValue_BCEB93B55589", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PackingListBox" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PackingListBox" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PackingListBox" } } } } } } }, "/api/PackingListBox/UpsertGraph": { "put": { "tags": [ "PackingListBox" ], "summary": "PackingListBox: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PackingListBox-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PackingListBox_UpsertGraph_C944CDBC6023", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PackingListBox" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PackingListBox" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PackingListBox" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PackingListBox" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PackingListBox" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PackingListBox" } } } } } } }, "/api/PackingListBox/UpsertGraphWithExtraFields": { "put": { "tags": [ "PackingListBox" ], "summary": "PackingListBox: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PackingListBox-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PackingListBox_UpsertGraphWithExtraFields_4D7A3E426D78", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PackingListBox" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PackingListBox" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PackingListBox" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PackingListBox" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PackingListBox" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PackingListBox" } } } } } } }, "/api/PackingListBoxPosition": { "get": { "tags": [ "PackingListBoxPosition" ], "summary": "PackingListBoxPosition: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PackingListBoxPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PackingListBoxPosition_GetAll_7EB1B8E5DD3D", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PackingListBoxPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PackingListBoxPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PackingListBoxPosition" } } } } } }, "post": { "tags": [ "PackingListBoxPosition" ], "summary": "PackingListBoxPosition: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PackingListBoxPosition-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PackingListBoxPosition_Post_4D20AD84F6FC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PackingListBoxPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PackingListBoxPosition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PackingListBoxPosition" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PackingListBoxPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PackingListBoxPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PackingListBoxPosition" } } } } } }, "put": { "tags": [ "PackingListBoxPosition" ], "summary": "PackingListBoxPosition: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PackingListBoxPosition-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PackingListBoxPosition_Put_787663D93A69", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PackingListBoxPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PackingListBoxPosition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PackingListBoxPosition" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PackingListBoxPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PackingListBoxPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PackingListBoxPosition" } } } } } } }, "/api/PackingListBoxPosition/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "PackingListBoxPosition" ], "summary": "PackingListBoxPosition: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PackingListBoxPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PackingListBoxPosition_GetPageByValue_D110507EECA7", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PackingListBoxPosition/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "PackingListBoxPosition" ], "summary": "PackingListBoxPosition: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PackingListBoxPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PackingListBoxPosition_GetPageByValue2_C01847D2BA34", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PackingListBoxPosition/DeleteByFilter": { "post": { "tags": [ "PackingListBoxPosition" ], "summary": "PackingListBoxPosition: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PackingListBoxPosition-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PackingListBoxPosition_DeleteByFilter_F3AB8E55257C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/PackingListBoxPosition/GetAllByValue": { "post": { "tags": [ "PackingListBoxPosition" ], "summary": "PackingListBoxPosition: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PackingListBoxPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PackingListBoxPosition_GetAllByValue_BCCCA27C0A3B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PackingListBoxPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PackingListBoxPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PackingListBoxPosition" } } } } } } }, "/api/PackingListBoxPosition/GetAllGraphByValue": { "post": { "tags": [ "PackingListBoxPosition" ], "summary": "PackingListBoxPosition: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PackingListBoxPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PackingListBoxPosition_GetAllGraphByValue_C2F97C94C500", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PackingListBoxPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PackingListBoxPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PackingListBoxPosition" } } } } } } }, "/api/PackingListBoxPosition/GetByValue": { "post": { "tags": [ "PackingListBoxPosition" ], "summary": "PackingListBoxPosition: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PackingListBoxPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PackingListBoxPosition_GetByValue_696873247F5E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PackingListBoxPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PackingListBoxPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PackingListBoxPosition" } } } } } } }, "/api/PackingListBoxPosition/GetLookup": { "post": { "tags": [ "PackingListBoxPosition" ], "summary": "PackingListBoxPosition: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PackingListBoxPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PackingListBoxPosition_GetLookup_B4D3640D415C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/PackingListBoxPosition/GetLookupByValue": { "post": { "tags": [ "PackingListBoxPosition" ], "summary": "PackingListBoxPosition: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PackingListBoxPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PackingListBoxPosition_GetLookupByValue_82C2653DCED7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/PackingListBoxPosition/Page": { "get": { "tags": [ "PackingListBoxPosition" ], "summary": "PackingListBoxPosition: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PackingListBoxPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PackingListBoxPosition_GetPage_5CD285599595", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PackingListBoxPosition/PageAsc": { "get": { "tags": [ "PackingListBoxPosition" ], "summary": "PackingListBoxPosition: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PackingListBoxPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PackingListBoxPosition_GetPageAsc_3A29848BE42F", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PackingListBoxPosition/PageFromView": { "get": { "tags": [ "PackingListBoxPosition" ], "summary": "PackingListBoxPosition: GetPageFromView", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PackingListBoxPosition-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PackingListBoxPosition_GetPageFromView_09DC1796A41B", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PackingListBoxPosition/SearchByValue": { "post": { "tags": [ "PackingListBoxPosition" ], "summary": "PackingListBoxPosition: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PackingListBoxPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PackingListBoxPosition_SearchByValue_9338D3111D77", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PackingListBoxPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PackingListBoxPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PackingListBoxPosition" } } } } } } }, "/api/PackingListBoxPosition/TryGetByValue": { "post": { "tags": [ "PackingListBoxPosition" ], "summary": "PackingListBoxPosition: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PackingListBoxPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PackingListBoxPosition_TryGetByValue_86451E795AE4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PackingListBoxPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PackingListBoxPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PackingListBoxPosition" } } } } } } }, "/api/PackingListBoxPosition/UpsertGraph": { "put": { "tags": [ "PackingListBoxPosition" ], "summary": "PackingListBoxPosition: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PackingListBoxPosition-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PackingListBoxPosition_UpsertGraph_3877DEBD7429", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PackingListBoxPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PackingListBoxPosition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PackingListBoxPosition" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PackingListBoxPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PackingListBoxPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PackingListBoxPosition" } } } } } } }, "/api/PackingListBoxPosition/UpsertGraphWithExtraFields": { "put": { "tags": [ "PackingListBoxPosition" ], "summary": "PackingListBoxPosition: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PackingListBoxPosition-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PackingListBoxPosition_UpsertGraphWithExtraFields_F99664127CD0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PackingListBoxPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PackingListBoxPosition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PackingListBoxPosition" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PackingListBoxPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PackingListBoxPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PackingListBoxPosition" } } } } } } }, "/api/PackingListBoxType": { "get": { "tags": [ "PackingListBoxType" ], "summary": "PackingListBoxType: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PackingListBoxType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PackingListBoxType_GetAll_5A17EF16770D", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PackingListBoxType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PackingListBoxType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PackingListBoxType" } } } } } }, "post": { "tags": [ "PackingListBoxType" ], "summary": "PackingListBoxType: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PackingListBoxType-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PackingListBoxType_Post_FFCB4FC916C5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PackingListBoxType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PackingListBoxType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PackingListBoxType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PackingListBoxType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PackingListBoxType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PackingListBoxType" } } } } } }, "put": { "tags": [ "PackingListBoxType" ], "summary": "PackingListBoxType: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PackingListBoxType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PackingListBoxType_Put_F1FAE28E4FC8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PackingListBoxType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PackingListBoxType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PackingListBoxType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PackingListBoxType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PackingListBoxType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PackingListBoxType" } } } } } } }, "/api/PackingListBoxType/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "PackingListBoxType" ], "summary": "PackingListBoxType: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PackingListBoxType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PackingListBoxType_GetPageByValue_B74D6F68EE82", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PackingListBoxType/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "PackingListBoxType" ], "summary": "PackingListBoxType: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PackingListBoxType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PackingListBoxType_GetPageByValue2_731AA83972C0", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PackingListBoxType/DeleteByFilter": { "post": { "tags": [ "PackingListBoxType" ], "summary": "PackingListBoxType: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PackingListBoxType-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PackingListBoxType_DeleteByFilter_D78212165A27", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/PackingListBoxType/GetAllByValue": { "post": { "tags": [ "PackingListBoxType" ], "summary": "PackingListBoxType: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PackingListBoxType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PackingListBoxType_GetAllByValue_CB49F9F94769", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PackingListBoxType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PackingListBoxType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PackingListBoxType" } } } } } } }, "/api/PackingListBoxType/GetAllGraphByValue": { "post": { "tags": [ "PackingListBoxType" ], "summary": "PackingListBoxType: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PackingListBoxType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PackingListBoxType_GetAllGraphByValue_EA0E73889218", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PackingListBoxType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PackingListBoxType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PackingListBoxType" } } } } } } }, "/api/PackingListBoxType/GetByValue": { "post": { "tags": [ "PackingListBoxType" ], "summary": "PackingListBoxType: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PackingListBoxType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PackingListBoxType_GetByValue_305AE5E53417", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PackingListBoxType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PackingListBoxType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PackingListBoxType" } } } } } } }, "/api/PackingListBoxType/GetLookup": { "post": { "tags": [ "PackingListBoxType" ], "summary": "PackingListBoxType: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PackingListBoxType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PackingListBoxType_GetLookup_FEDCE3224333", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/PackingListBoxType/GetLookupByValue": { "post": { "tags": [ "PackingListBoxType" ], "summary": "PackingListBoxType: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PackingListBoxType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PackingListBoxType_GetLookupByValue_C79227F641AB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/PackingListBoxType/Page": { "get": { "tags": [ "PackingListBoxType" ], "summary": "PackingListBoxType: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PackingListBoxType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PackingListBoxType_GetPage_2FE3E390B28D", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PackingListBoxType/PageAsc": { "get": { "tags": [ "PackingListBoxType" ], "summary": "PackingListBoxType: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PackingListBoxType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PackingListBoxType_GetPageAsc_7C433C42BF43", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PackingListBoxType/SearchByValue": { "post": { "tags": [ "PackingListBoxType" ], "summary": "PackingListBoxType: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PackingListBoxType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PackingListBoxType_SearchByValue_7E88A657DF15", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PackingListBoxType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PackingListBoxType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PackingListBoxType" } } } } } } }, "/api/PackingListBoxType/TryGetByValue": { "post": { "tags": [ "PackingListBoxType" ], "summary": "PackingListBoxType: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PackingListBoxType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PackingListBoxType_TryGetByValue_0A7D2B28ED7F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PackingListBoxType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PackingListBoxType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PackingListBoxType" } } } } } } }, "/api/PackingListBoxType/UpsertGraph": { "put": { "tags": [ "PackingListBoxType" ], "summary": "PackingListBoxType: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PackingListBoxType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PackingListBoxType_UpsertGraph_F56B61C85634", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PackingListBoxType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PackingListBoxType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PackingListBoxType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PackingListBoxType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PackingListBoxType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PackingListBoxType" } } } } } } }, "/api/PackingListBoxType/UpsertGraphWithExtraFields": { "put": { "tags": [ "PackingListBoxType" ], "summary": "PackingListBoxType: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PackingListBoxType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PackingListBoxType_UpsertGraphWithExtraFields_FB834BA1302A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PackingListBoxType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PackingListBoxType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PackingListBoxType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PackingListBoxType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PackingListBoxType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PackingListBoxType" } } } } } } }, "/api/Partner": { "get": { "tags": [ "Partner" ], "summary": "Partner: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Partner-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Partner_GetAll_A6FF8A4E362C", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Partner" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Partner" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Partner" } } } } } }, "post": { "tags": [ "Partner" ], "summary": "Partner: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Partner-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Partner_Post_7D8B89753A9D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Partner" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Partner" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Partner" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Partner" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Partner" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Partner" } } } } } }, "put": { "tags": [ "Partner" ], "summary": "Partner: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Partner-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Partner_Put_8BBE0FE36447", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Partner" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Partner" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Partner" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Partner" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Partner" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Partner" } } } } } } }, "/api/Partner/{DiscountGroupNameId}/{PartnerDetailId}/UpdateDiscountGroup": { "get": { "tags": [ "Partner" ], "summary": "Partner: UpdateDiscountGroup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Partner-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Partner_UpdateDiscountGroup_012BB6C535E4", "parameters": [ { "name": "DiscountGroupNameId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PartnerDetailId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/Partner/{FirstCustomerNumber}/SetFirstCustomerNumber": { "get": { "tags": [ "Partner" ], "summary": "Partner: SetFirstCustomerNumber", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Partner-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Partner_SetFirstCustomerNumber_26ACB2C50928", "parameters": [ { "name": "FirstCustomerNumber", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/Partner/{FirstPartnerNumber}/SetFirstPartnerNumber": { "get": { "tags": [ "Partner" ], "summary": "Partner: SetFirstPartnerNumber", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Partner-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Partner_SetFirstPartnerNumber_2F9C85CA5790", "parameters": [ { "name": "FirstPartnerNumber", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/Partner/{FirstSupplierNumber}/SetFirstSupplierNumber": { "get": { "tags": [ "Partner" ], "summary": "Partner: SetFirstSupplierNumber", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Partner-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Partner_SetFirstSupplierNumber_1439696DC60C", "parameters": [ { "name": "FirstSupplierNumber", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/Partner/{Id}/GetDocHistory": { "get": { "tags": [ "Partner" ], "summary": "Partner: GetDocHistory", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Partner-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Partner_GetDocHistory_35840876CF85", "parameters": [ { "name": "Id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Partner/{Id}/GetPositionHistory": { "get": { "tags": [ "Partner" ], "summary": "Partner: GetPositionHistory", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Partner-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Partner_GetPositionHistory_0F75A377BB15", "parameters": [ { "name": "Id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Partner/{Id}/GetRevenueMonthly": { "get": { "tags": [ "Partner" ], "summary": "Partner: GetRevenueMonthly", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Partner-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Partner_GetRevenueMonthly_A6E6A40D428C", "parameters": [ { "name": "Id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Partner/{PartnerId}/{Matchcode}/TakeBillingAddress": { "get": { "tags": [ "Partner" ], "summary": "Partner: TakeBillingAddress", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Partner-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Partner_TakeBillingAddress_BBC1AD5CD060", "parameters": [ { "name": "PartnerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Matchcode", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Nullable_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Nullable_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Nullable_Of_System.Int32" } } } } } } }, "/api/Partner/{PartnerId}/{Matchcode}/TakeDeliveryAddress": { "get": { "tags": [ "Partner" ], "summary": "Partner: TakeDeliveryAddress", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Partner-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Partner_TakeDeliveryAddress_046EC657418B", "parameters": [ { "name": "PartnerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Matchcode", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Nullable_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Nullable_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Nullable_Of_System.Int32" } } } } } } }, "/api/Partner/{PartnerId}/{PartnerTypeId}/GetPagePartnerDetailChangeLog": { "get": { "tags": [ "Partner" ], "summary": "Partner: GetPagePartnerDetailChangeLog", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Partner-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Partner_GetPagePartnerDetailChangeLog_445C9BF0E024", "parameters": [ { "name": "PartnerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PartnerTypeId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Partner/{PartnerId}/GetPagePartnerChangeLog": { "get": { "tags": [ "Partner" ], "summary": "Partner: GetPagePartnerChangeLog", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Partner-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Partner_GetPagePartnerChangeLog_B4865563D3D1", "parameters": [ { "name": "PartnerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Partner/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "Partner" ], "summary": "Partner: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Partner-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Partner_GetPageByValue_28A0AE857C83", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Partner/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "Partner" ], "summary": "Partner: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Partner-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Partner_GetPageByValue2_4FC01461482C", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Partner/DeleteByFilter": { "post": { "tags": [ "Partner" ], "summary": "Partner: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Partner-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Partner_DeleteByFilter_AA8C2C18C32E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/Partner/GetAllByValue": { "post": { "tags": [ "Partner" ], "summary": "Partner: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Partner-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Partner_GetAllByValue_1C6483A4E88F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Partner" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Partner" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Partner" } } } } } } }, "/api/Partner/GetAllGraphByValue": { "post": { "tags": [ "Partner" ], "summary": "Partner: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Partner-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Partner_GetAllGraphByValue_4DDBE23AB5B7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Partner" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Partner" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Partner" } } } } } } }, "/api/Partner/GetByValue": { "post": { "tags": [ "Partner" ], "summary": "Partner: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Partner-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Partner_GetByValue_3583612AAFBF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Partner" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Partner" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Partner" } } } } } } }, "/api/Partner/GetCurrentCustomerNumber": { "get": { "tags": [ "Partner" ], "summary": "Partner: GetCurrentCustomerNumber", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Partner-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Partner_GetCurrentCustomerNumber_D68BA2C0820A", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/Partner/GetCurrentPartnerNumber": { "get": { "tags": [ "Partner" ], "summary": "Partner: GetCurrentPartnerNumber", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Partner-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Partner_GetCurrentPartnerNumber_BDD7EF3A8D76", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/Partner/GetCurrentSupplierNumber": { "get": { "tags": [ "Partner" ], "summary": "Partner: GetCurrentSupplierNumber", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Partner-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Partner_GetCurrentSupplierNumber_583F071A3EAD", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/Partner/GetCustomers": { "get": { "tags": [ "Partner" ], "summary": "Partner: GetCustomers", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Partner-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Partner_GetCustomers_83E8B6CF7BDE", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Partner" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Partner" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Partner" } } } } } } }, "/api/Partner/GetDuplicateProtectionMatches/{partnerId}/{countryId}/{zip}/{street}": { "get": { "tags": [ "Partner" ], "summary": "Partner: GetDuplicateProtectionMatches", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Partner-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Partner_GetDuplicateProtectionMatches_C2DFC95913E5", "parameters": [ { "name": "partnerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "countryId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "zip", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "street", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Partner" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Partner" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Partner" } } } } } } }, "/api/Partner/GetLookup": { "post": { "tags": [ "Partner" ], "summary": "Partner: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Partner-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Partner_GetLookup_734DAF21F09D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/Partner/GetLookupByValue": { "post": { "tags": [ "Partner" ], "summary": "Partner: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Partner-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Partner_GetLookupByValue_83638DCEDB7E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/Partner/GetPartnerSession": { "get": { "tags": [ "Partner" ], "summary": "Partner: GetSession", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Partner-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Partner_GetSession_A5D5112817AF", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.String" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.String" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.String" } } } } } } }, "/api/Partner/Page": { "get": { "tags": [ "Partner" ], "summary": "Partner: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Partner-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Partner_GetPage_825E20F76731", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Partner/PageAsc": { "get": { "tags": [ "Partner" ], "summary": "Partner: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Partner-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Partner_GetPageAsc_7BC7D6C3230B", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Partner/PageFromView/{SelectedNodeId}/{IsCustomerAndSupplierOnlyMode}/{IncludeSubNodes}/{PartnerType}/{activeOnly}/{favoriteOnly}": { "get": { "tags": [ "Partner" ], "summary": "Partner: GetPageFromView", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Partner-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Partner_GetPageFromView_7CF6A03DCC78", "parameters": [ { "name": "SelectedNodeId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "IsCustomerAndSupplierOnlyMode", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "IncludeSubNodes", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "PartnerType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "activeOnly", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "favoriteOnly", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Partner/PartnersByGroup/{partnerGroupId}": { "get": { "tags": [ "Partner" ], "summary": "Partner: GetPartnersByGroup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Partner-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Partner_GetPartnersByGroup_6BF2856598E4", "parameters": [ { "name": "partnerGroupId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Partner" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Partner" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Partner" } } } } } } }, "/api/Partner/SearchByValue": { "post": { "tags": [ "Partner" ], "summary": "Partner: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Partner-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Partner_SearchByValue_E6BE395CC982", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.Partner" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.Partner" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.Partner" } } } } } } }, "/api/Partner/SendPortalInvitation": { "post": { "tags": [ "Partner" ], "summary": "Partner: SendPortalInvitation", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Partner-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Partner_SendPortalInvitation_5C8A298699CB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Dto.PartnerPortalInvitationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Dto.PartnerPortalInvitationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Dto.PartnerPortalInvitationRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dto.PartnerPortalInvitationResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dto.PartnerPortalInvitationResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dto.PartnerPortalInvitationResult" } } } } } } }, "/api/Partner/TryGetByValue": { "post": { "tags": [ "Partner" ], "summary": "Partner: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Partner-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Partner_TryGetByValue_96484A4E029A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Partner" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Partner" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Partner" } } } } } } }, "/api/Partner/UpsertGraph": { "put": { "tags": [ "Partner" ], "summary": "Partner: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Partner-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Partner_UpsertGraph_CBA5C70D8531", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Partner" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Partner" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Partner" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Partner" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Partner" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Partner" } } } } } } }, "/api/Partner/UpsertGraphWithExtraFields": { "put": { "tags": [ "Partner" ], "summary": "Partner: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Partner-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Partner_UpsertGraphWithExtraFields_E82FB3CB3064", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Partner" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Partner" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Partner" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Partner" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Partner" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Partner" } } } } } } }, "/api/Partner/ValidateCredentials": { "post": { "tags": [ "Partner" ], "summary": "Partner: ValidateCredentials", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Partner-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Partner_ValidateCredentials_0E2413CAED16", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Server.Controllers.PartnerCredentialValidationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Server.Controllers.PartnerCredentialValidationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Server.Controllers.PartnerCredentialValidationRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Server.Controllers.PartnerCredentialValidationResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Server.Controllers.PartnerCredentialValidationResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Server.Controllers.PartnerCredentialValidationResult" } } } } } } }, "/api/PartnerBankAccount": { "get": { "tags": [ "PartnerBankAccount" ], "summary": "PartnerBankAccount: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerBankAccount-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerBankAccount_GetAll_DAC2D659193F", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerBankAccount" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerBankAccount" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerBankAccount" } } } } } }, "post": { "tags": [ "PartnerBankAccount" ], "summary": "PartnerBankAccount: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerBankAccount-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerBankAccount_Post_255262A725B2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerBankAccount" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerBankAccount" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerBankAccount" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerBankAccount" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerBankAccount" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerBankAccount" } } } } } }, "put": { "tags": [ "PartnerBankAccount" ], "summary": "PartnerBankAccount: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerBankAccount-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerBankAccount_Put_CD9036CC22EA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerBankAccount" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerBankAccount" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerBankAccount" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerBankAccount" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerBankAccount" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerBankAccount" } } } } } } }, "/api/PartnerBankAccount/{PartnerId}/GetPageFromViewByPartnerId": { "get": { "tags": [ "PartnerBankAccount" ], "summary": "PartnerBankAccount: GetPageFromViewByPartnerId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerBankAccount-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerBankAccount_GetPageFromViewByPartnerId_D5BCC7CB58FE", "parameters": [ { "name": "PartnerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerBankAccount/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "PartnerBankAccount" ], "summary": "PartnerBankAccount: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerBankAccount-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerBankAccount_GetPageByValue_BC9A3D548774", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerBankAccount/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "PartnerBankAccount" ], "summary": "PartnerBankAccount: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerBankAccount-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerBankAccount_GetPageByValue2_51A05B7CD3F1", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerBankAccount/DeleteByFilter": { "post": { "tags": [ "PartnerBankAccount" ], "summary": "PartnerBankAccount: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerBankAccount-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerBankAccount_DeleteByFilter_8D6DA917BB35", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/PartnerBankAccount/GetAllByValue": { "post": { "tags": [ "PartnerBankAccount" ], "summary": "PartnerBankAccount: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerBankAccount-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerBankAccount_GetAllByValue_8DE42EB5CCE2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerBankAccount" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerBankAccount" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerBankAccount" } } } } } } }, "/api/PartnerBankAccount/GetAllGraphByValue": { "post": { "tags": [ "PartnerBankAccount" ], "summary": "PartnerBankAccount: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerBankAccount-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerBankAccount_GetAllGraphByValue_8355268E5562", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerBankAccount" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerBankAccount" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerBankAccount" } } } } } } }, "/api/PartnerBankAccount/GetByValue": { "post": { "tags": [ "PartnerBankAccount" ], "summary": "PartnerBankAccount: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerBankAccount-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerBankAccount_GetByValue_D723BE44B3ED", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerBankAccount" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerBankAccount" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerBankAccount" } } } } } } }, "/api/PartnerBankAccount/GetLookup": { "post": { "tags": [ "PartnerBankAccount" ], "summary": "PartnerBankAccount: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerBankAccount-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerBankAccount_GetLookup_6F57A185CF99", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/PartnerBankAccount/GetLookupByValue": { "post": { "tags": [ "PartnerBankAccount" ], "summary": "PartnerBankAccount: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerBankAccount-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerBankAccount_GetLookupByValue_55F4F5582B29", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/PartnerBankAccount/Page": { "get": { "tags": [ "PartnerBankAccount" ], "summary": "PartnerBankAccount: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerBankAccount-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerBankAccount_GetPage_2E20100D1D31", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerBankAccount/PageAsc": { "get": { "tags": [ "PartnerBankAccount" ], "summary": "PartnerBankAccount: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerBankAccount-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerBankAccount_GetPageAsc_163E6B88893F", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerBankAccount/SearchByValue": { "post": { "tags": [ "PartnerBankAccount" ], "summary": "PartnerBankAccount: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerBankAccount-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerBankAccount_SearchByValue_D2585A47DE45", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerBankAccount" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerBankAccount" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerBankAccount" } } } } } } }, "/api/PartnerBankAccount/TryGetByValue": { "post": { "tags": [ "PartnerBankAccount" ], "summary": "PartnerBankAccount: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerBankAccount-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerBankAccount_TryGetByValue_94DC6D14398B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerBankAccount" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerBankAccount" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerBankAccount" } } } } } } }, "/api/PartnerBankAccount/UpsertGraph": { "put": { "tags": [ "PartnerBankAccount" ], "summary": "PartnerBankAccount: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerBankAccount-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerBankAccount_UpsertGraph_1A52628D752F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerBankAccount" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerBankAccount" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerBankAccount" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerBankAccount" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerBankAccount" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerBankAccount" } } } } } } }, "/api/PartnerBankAccount/UpsertGraphWithExtraFields": { "put": { "tags": [ "PartnerBankAccount" ], "summary": "PartnerBankAccount: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerBankAccount-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerBankAccount_UpsertGraphWithExtraFields_81F9F8E6F225", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerBankAccount" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerBankAccount" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerBankAccount" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerBankAccount" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerBankAccount" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerBankAccount" } } } } } } }, "/api/PartnerBillingAddress": { "get": { "tags": [ "PartnerBillingAddress" ], "summary": "PartnerBillingAddress: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerBillingAddress-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerBillingAddress_GetAll_4020ADD10552", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerBillingAddress" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerBillingAddress" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerBillingAddress" } } } } } }, "post": { "tags": [ "PartnerBillingAddress" ], "summary": "PartnerBillingAddress: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerBillingAddress-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerBillingAddress_Post_F956A881B71C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerBillingAddress" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerBillingAddress" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerBillingAddress" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerBillingAddress" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerBillingAddress" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerBillingAddress" } } } } } }, "put": { "tags": [ "PartnerBillingAddress" ], "summary": "PartnerBillingAddress: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerBillingAddress-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerBillingAddress_Put_6C4F039B0DD3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerBillingAddress" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerBillingAddress" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerBillingAddress" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerBillingAddress" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerBillingAddress" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerBillingAddress" } } } } } } }, "/api/PartnerBillingAddress/{NewMatchcode}/{FromPartnerId}/GetPartnerBillingAddress": { "get": { "tags": [ "PartnerBillingAddress" ], "summary": "PartnerBillingAddress: GetPartnerBillingAddress", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerBillingAddress-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerBillingAddress_GetPartnerBillingAddress_6224E124B8D9", "parameters": [ { "name": "NewMatchcode", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "FromPartnerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerBillingAddress" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerBillingAddress" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerBillingAddress" } } } } } } }, "/api/PartnerBillingAddress/{PartnerId}/PageFromViewByPartnerId": { "get": { "tags": [ "PartnerBillingAddress" ], "summary": "PartnerBillingAddress: GetPageFromViewByPartnerId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerBillingAddress-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerBillingAddress_GetPageFromViewByPartnerId_181AD4B20B65", "parameters": [ { "name": "PartnerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerBillingAddress/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "PartnerBillingAddress" ], "summary": "PartnerBillingAddress: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerBillingAddress-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerBillingAddress_GetPageByValue_D3FA352F2E83", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerBillingAddress/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "PartnerBillingAddress" ], "summary": "PartnerBillingAddress: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerBillingAddress-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerBillingAddress_GetPageByValue2_D9D4AEBB3C4E", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerBillingAddress/DeleteByFilter": { "post": { "tags": [ "PartnerBillingAddress" ], "summary": "PartnerBillingAddress: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerBillingAddress-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerBillingAddress_DeleteByFilter_59371497928B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/PartnerBillingAddress/GetAllByValue": { "post": { "tags": [ "PartnerBillingAddress" ], "summary": "PartnerBillingAddress: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerBillingAddress-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerBillingAddress_GetAllByValue_055DC285E511", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerBillingAddress" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerBillingAddress" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerBillingAddress" } } } } } } }, "/api/PartnerBillingAddress/GetAllGraphByValue": { "post": { "tags": [ "PartnerBillingAddress" ], "summary": "PartnerBillingAddress: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerBillingAddress-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerBillingAddress_GetAllGraphByValue_1A6F77340F45", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerBillingAddress" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerBillingAddress" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerBillingAddress" } } } } } } }, "/api/PartnerBillingAddress/GetByValue": { "post": { "tags": [ "PartnerBillingAddress" ], "summary": "PartnerBillingAddress: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerBillingAddress-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerBillingAddress_GetByValue_AF25E9FF5FDF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerBillingAddress" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerBillingAddress" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerBillingAddress" } } } } } } }, "/api/PartnerBillingAddress/GetLookup": { "post": { "tags": [ "PartnerBillingAddress" ], "summary": "PartnerBillingAddress: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerBillingAddress-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerBillingAddress_GetLookup_0C0EE3D874AD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/PartnerBillingAddress/GetLookupByValue": { "post": { "tags": [ "PartnerBillingAddress" ], "summary": "PartnerBillingAddress: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerBillingAddress-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerBillingAddress_GetLookupByValue_6436710B6A68", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/PartnerBillingAddress/Page": { "get": { "tags": [ "PartnerBillingAddress" ], "summary": "PartnerBillingAddress: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerBillingAddress-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerBillingAddress_GetPage_90F199D5966E", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerBillingAddress/PageAsc": { "get": { "tags": [ "PartnerBillingAddress" ], "summary": "PartnerBillingAddress: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerBillingAddress-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerBillingAddress_GetPageAsc_4CFE511BFA7C", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerBillingAddress/SearchByValue": { "post": { "tags": [ "PartnerBillingAddress" ], "summary": "PartnerBillingAddress: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerBillingAddress-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerBillingAddress_SearchByValue_DC7C4E686C29", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerBillingAddress" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerBillingAddress" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerBillingAddress" } } } } } } }, "/api/PartnerBillingAddress/TryGetByValue": { "post": { "tags": [ "PartnerBillingAddress" ], "summary": "PartnerBillingAddress: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerBillingAddress-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerBillingAddress_TryGetByValue_C29A9FE11341", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerBillingAddress" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerBillingAddress" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerBillingAddress" } } } } } } }, "/api/PartnerBillingAddress/UpsertGraph": { "put": { "tags": [ "PartnerBillingAddress" ], "summary": "PartnerBillingAddress: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerBillingAddress-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerBillingAddress_UpsertGraph_F232F76550FC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerBillingAddress" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerBillingAddress" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerBillingAddress" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerBillingAddress" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerBillingAddress" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerBillingAddress" } } } } } } }, "/api/PartnerBillingAddress/UpsertGraphWithExtraFields": { "put": { "tags": [ "PartnerBillingAddress" ], "summary": "PartnerBillingAddress: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerBillingAddress-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerBillingAddress_UpsertGraphWithExtraFields_F1D55C6AFA31", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerBillingAddress" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerBillingAddress" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerBillingAddress" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerBillingAddress" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerBillingAddress" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerBillingAddress" } } } } } } }, "/api/PartnerCatalogNumber": { "get": { "tags": [ "PartnerCatalogNumber" ], "summary": "PartnerCatalogNumber: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerCatalogNumber-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerCatalogNumber_GetAll_38B39CC61564", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerCatalogNumber" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerCatalogNumber" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerCatalogNumber" } } } } } }, "post": { "tags": [ "PartnerCatalogNumber" ], "summary": "PartnerCatalogNumber: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerCatalogNumber-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerCatalogNumber_Post_7411394EFA7A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerCatalogNumber" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerCatalogNumber" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerCatalogNumber" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerCatalogNumber" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerCatalogNumber" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerCatalogNumber" } } } } } }, "put": { "tags": [ "PartnerCatalogNumber" ], "summary": "PartnerCatalogNumber: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerCatalogNumber-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerCatalogNumber_Put_7A029146B02E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerCatalogNumber" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerCatalogNumber" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerCatalogNumber" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerCatalogNumber" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerCatalogNumber" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerCatalogNumber" } } } } } } }, "/api/PartnerCatalogNumber/{ArticleId}/PageFromViewByArticleId": { "get": { "tags": [ "PartnerCatalogNumber" ], "summary": "PartnerCatalogNumber: GetPageFromViewByArticleId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerCatalogNumber-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerCatalogNumber_GetPageFromViewByArticleId_A10D648FF27F", "parameters": [ { "name": "ArticleId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerCatalogNumber/{PartnerId}/PageFromViewByPartnerId": { "get": { "tags": [ "PartnerCatalogNumber" ], "summary": "PartnerCatalogNumber: GetPageFromViewByArticleId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerCatalogNumber-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerCatalogNumber_GetPageFromViewByArticleId_A3743387AB93", "parameters": [ { "name": "PartnerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerCatalogNumber/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "PartnerCatalogNumber" ], "summary": "PartnerCatalogNumber: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerCatalogNumber-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerCatalogNumber_GetPageByValue_33C8B1300468", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerCatalogNumber/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "PartnerCatalogNumber" ], "summary": "PartnerCatalogNumber: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerCatalogNumber-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerCatalogNumber_GetPageByValue2_13426D3CEC72", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerCatalogNumber/DeleteByFilter": { "post": { "tags": [ "PartnerCatalogNumber" ], "summary": "PartnerCatalogNumber: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerCatalogNumber-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerCatalogNumber_DeleteByFilter_D43E23BE1232", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/PartnerCatalogNumber/GetAllByValue": { "post": { "tags": [ "PartnerCatalogNumber" ], "summary": "PartnerCatalogNumber: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerCatalogNumber-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerCatalogNumber_GetAllByValue_C0780C7C2CF3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerCatalogNumber" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerCatalogNumber" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerCatalogNumber" } } } } } } }, "/api/PartnerCatalogNumber/GetAllGraphByValue": { "post": { "tags": [ "PartnerCatalogNumber" ], "summary": "PartnerCatalogNumber: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerCatalogNumber-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerCatalogNumber_GetAllGraphByValue_1E73D89DE989", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerCatalogNumber" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerCatalogNumber" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerCatalogNumber" } } } } } } }, "/api/PartnerCatalogNumber/GetByValue": { "post": { "tags": [ "PartnerCatalogNumber" ], "summary": "PartnerCatalogNumber: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerCatalogNumber-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerCatalogNumber_GetByValue_51D22D430EBA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerCatalogNumber" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerCatalogNumber" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerCatalogNumber" } } } } } } }, "/api/PartnerCatalogNumber/GetLookup": { "post": { "tags": [ "PartnerCatalogNumber" ], "summary": "PartnerCatalogNumber: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerCatalogNumber-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerCatalogNumber_GetLookup_2901B51E8D65", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/PartnerCatalogNumber/GetLookupByValue": { "post": { "tags": [ "PartnerCatalogNumber" ], "summary": "PartnerCatalogNumber: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerCatalogNumber-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerCatalogNumber_GetLookupByValue_7A95A5B730FE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/PartnerCatalogNumber/Page": { "get": { "tags": [ "PartnerCatalogNumber" ], "summary": "PartnerCatalogNumber: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerCatalogNumber-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerCatalogNumber_GetPage_8E7EB0504C32", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerCatalogNumber/PageAsc": { "get": { "tags": [ "PartnerCatalogNumber" ], "summary": "PartnerCatalogNumber: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerCatalogNumber-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerCatalogNumber_GetPageAsc_E5D176D03106", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerCatalogNumber/SearchByValue": { "post": { "tags": [ "PartnerCatalogNumber" ], "summary": "PartnerCatalogNumber: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerCatalogNumber-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerCatalogNumber_SearchByValue_5D7C87CB667C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerCatalogNumber" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerCatalogNumber" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerCatalogNumber" } } } } } } }, "/api/PartnerCatalogNumber/TryGetByValue": { "post": { "tags": [ "PartnerCatalogNumber" ], "summary": "PartnerCatalogNumber: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerCatalogNumber-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerCatalogNumber_TryGetByValue_01176842A652", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerCatalogNumber" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerCatalogNumber" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerCatalogNumber" } } } } } } }, "/api/PartnerCatalogNumber/UpsertGraph": { "put": { "tags": [ "PartnerCatalogNumber" ], "summary": "PartnerCatalogNumber: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerCatalogNumber-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerCatalogNumber_UpsertGraph_E4DE3886D004", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerCatalogNumber" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerCatalogNumber" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerCatalogNumber" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerCatalogNumber" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerCatalogNumber" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerCatalogNumber" } } } } } } }, "/api/PartnerCatalogNumber/UpsertGraphWithExtraFields": { "put": { "tags": [ "PartnerCatalogNumber" ], "summary": "PartnerCatalogNumber: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerCatalogNumber-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerCatalogNumber_UpsertGraphWithExtraFields_A7BF9E3AC8A4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerCatalogNumber" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerCatalogNumber" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerCatalogNumber" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerCatalogNumber" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerCatalogNumber" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerCatalogNumber" } } } } } } }, "/api/PartnerCategory": { "get": { "tags": [ "PartnerCategory" ], "summary": "PartnerCategory: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerCategory_GetAll_F6585F798130", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerCategory" } } } } } }, "post": { "tags": [ "PartnerCategory" ], "summary": "PartnerCategory: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerCategory-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerCategory_Post_B8C909C253D0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerCategory" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerCategory" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerCategory" } } } } } }, "put": { "tags": [ "PartnerCategory" ], "summary": "PartnerCategory: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerCategory-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerCategory_Put_50EAA6F64BC1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerCategory" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerCategory" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerCategory" } } } } } } }, "/api/PartnerCategory/{CategoryId}/PageFromViewByCategoryId": { "get": { "tags": [ "PartnerCategory" ], "summary": "PartnerCategory: GetPageFromViewByPartnerCategoryNameId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerCategory-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerCategory_GetPageFromViewByPartnerCategoryNameId_7232AE95DA1E", "parameters": [ { "name": "CategoryId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerCategory/{PartnerId}/PageFromViewByPartnerId": { "get": { "tags": [ "PartnerCategory" ], "summary": "PartnerCategory: GetPageFromViewByPartnerId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerCategory-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerCategory_GetPageFromViewByPartnerId_4BB2F0A7157A", "parameters": [ { "name": "PartnerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerCategory/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "PartnerCategory" ], "summary": "PartnerCategory: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerCategory_GetPageByValue_D53B051CB75E", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerCategory/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "PartnerCategory" ], "summary": "PartnerCategory: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerCategory_GetPageByValue2_C0445563AD1A", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerCategory/DeleteByFilter": { "post": { "tags": [ "PartnerCategory" ], "summary": "PartnerCategory: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerCategory-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerCategory_DeleteByFilter_8CBC221116A4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/PartnerCategory/GetAllByValue": { "post": { "tags": [ "PartnerCategory" ], "summary": "PartnerCategory: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerCategory_GetAllByValue_64EF5E54299A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerCategory" } } } } } } }, "/api/PartnerCategory/GetAllGraphByValue": { "post": { "tags": [ "PartnerCategory" ], "summary": "PartnerCategory: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerCategory_GetAllGraphByValue_D7B5CECE4631", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerCategory" } } } } } } }, "/api/PartnerCategory/GetByValue": { "post": { "tags": [ "PartnerCategory" ], "summary": "PartnerCategory: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerCategory_GetByValue_BFE00F827429", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerCategory" } } } } } } }, "/api/PartnerCategory/GetLookup": { "post": { "tags": [ "PartnerCategory" ], "summary": "PartnerCategory: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerCategory_GetLookup_ED0352CA0426", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/PartnerCategory/GetLookupByValue": { "post": { "tags": [ "PartnerCategory" ], "summary": "PartnerCategory: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerCategory_GetLookupByValue_DEA5F5D8802B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/PartnerCategory/Page": { "get": { "tags": [ "PartnerCategory" ], "summary": "PartnerCategory: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerCategory_GetPage_4850905A6C6B", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerCategory/PageAsc": { "get": { "tags": [ "PartnerCategory" ], "summary": "PartnerCategory: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerCategory_GetPageAsc_BA9953672BCA", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerCategory/SearchByValue": { "post": { "tags": [ "PartnerCategory" ], "summary": "PartnerCategory: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerCategory_SearchByValue_44ADCCC6ABDC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerCategory" } } } } } } }, "/api/PartnerCategory/TryGetByValue": { "post": { "tags": [ "PartnerCategory" ], "summary": "PartnerCategory: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerCategory_TryGetByValue_65DF2BB35726", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerCategory" } } } } } } }, "/api/PartnerCategory/UpsertGraph": { "put": { "tags": [ "PartnerCategory" ], "summary": "PartnerCategory: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerCategory-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerCategory_UpsertGraph_F85751A2D96A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerCategory" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerCategory" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerCategory" } } } } } } }, "/api/PartnerCategory/UpsertGraphWithExtraFields": { "put": { "tags": [ "PartnerCategory" ], "summary": "PartnerCategory: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerCategory-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerCategory_UpsertGraphWithExtraFields_EA6B28CE6771", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerCategory" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerCategory" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerCategory" } } } } } } }, "/api/PartnerCategoryName": { "get": { "tags": [ "PartnerCategoryName" ], "summary": "PartnerCategoryName: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerCategoryName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerCategoryName_GetAll_BD838BBB2ED5", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerCategoryName" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerCategoryName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerCategoryName" } } } } } }, "post": { "tags": [ "PartnerCategoryName" ], "summary": "PartnerCategoryName: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerCategoryName-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerCategoryName_Post_DD4853FB6A44", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerCategoryName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerCategoryName" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerCategoryName" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerCategoryName" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerCategoryName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerCategoryName" } } } } } }, "put": { "tags": [ "PartnerCategoryName" ], "summary": "PartnerCategoryName: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerCategoryName-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerCategoryName_Put_72FD41AEBEC3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerCategoryName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerCategoryName" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerCategoryName" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerCategoryName" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerCategoryName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerCategoryName" } } } } } } }, "/api/PartnerCategoryName/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "PartnerCategoryName" ], "summary": "PartnerCategoryName: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerCategoryName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerCategoryName_GetPageByValue_4FDF64E5118E", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerCategoryName/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "PartnerCategoryName" ], "summary": "PartnerCategoryName: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerCategoryName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerCategoryName_GetPageByValue2_7BCDB92309AD", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerCategoryName/DeleteByFilter": { "post": { "tags": [ "PartnerCategoryName" ], "summary": "PartnerCategoryName: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerCategoryName-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerCategoryName_DeleteByFilter_4AF8038A3DB6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/PartnerCategoryName/GetAllByValue": { "post": { "tags": [ "PartnerCategoryName" ], "summary": "PartnerCategoryName: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerCategoryName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerCategoryName_GetAllByValue_AA448F2C9199", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerCategoryName" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerCategoryName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerCategoryName" } } } } } } }, "/api/PartnerCategoryName/GetAllGraphByValue": { "post": { "tags": [ "PartnerCategoryName" ], "summary": "PartnerCategoryName: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerCategoryName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerCategoryName_GetAllGraphByValue_E98DAE7BBD27", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerCategoryName" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerCategoryName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerCategoryName" } } } } } } }, "/api/PartnerCategoryName/GetByValue": { "post": { "tags": [ "PartnerCategoryName" ], "summary": "PartnerCategoryName: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerCategoryName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerCategoryName_GetByValue_2CCA95EDF5FE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerCategoryName" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerCategoryName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerCategoryName" } } } } } } }, "/api/PartnerCategoryName/GetCategoryList": { "get": { "tags": [ "PartnerCategoryName" ], "summary": "PartnerCategoryName: GetCategoryList", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerCategoryName-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerCategoryName_GetCategoryList_8E3BE8729217", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Dto.CategoryNameDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Dto.CategoryNameDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Dto.CategoryNameDto" } } } } } } }, "/api/PartnerCategoryName/GetLookup": { "post": { "tags": [ "PartnerCategoryName" ], "summary": "PartnerCategoryName: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerCategoryName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerCategoryName_GetLookup_5F4372DF9EEC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/PartnerCategoryName/GetLookupByValue": { "post": { "tags": [ "PartnerCategoryName" ], "summary": "PartnerCategoryName: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerCategoryName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerCategoryName_GetLookupByValue_58EF1AE2E055", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/PartnerCategoryName/Page": { "get": { "tags": [ "PartnerCategoryName" ], "summary": "PartnerCategoryName: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerCategoryName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerCategoryName_GetPage_07ED495F3ADD", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerCategoryName/PageAsc": { "get": { "tags": [ "PartnerCategoryName" ], "summary": "PartnerCategoryName: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerCategoryName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerCategoryName_GetPageAsc_84284AC1D446", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerCategoryName/PagePartnerCategoryNamesByParent/{ParentId}/{IncludeSubNodes}/{TopParentsOnly}": { "get": { "tags": [ "PartnerCategoryName" ], "summary": "PartnerCategoryName: GetPagePartnerCategoryNamesByParent", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerCategoryName-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerCategoryName_GetPagePartnerCategoryNamesByParent_5349E0A4873F", "parameters": [ { "name": "ParentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "IncludeSubNodes", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "TopParentsOnly", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerCategoryName/SearchByValue": { "post": { "tags": [ "PartnerCategoryName" ], "summary": "PartnerCategoryName: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerCategoryName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerCategoryName_SearchByValue_893AA70C4319", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerCategoryName" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerCategoryName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerCategoryName" } } } } } } }, "/api/PartnerCategoryName/TryGetByValue": { "post": { "tags": [ "PartnerCategoryName" ], "summary": "PartnerCategoryName: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerCategoryName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerCategoryName_TryGetByValue_32576856FE8C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerCategoryName" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerCategoryName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerCategoryName" } } } } } } }, "/api/PartnerCategoryName/UpsertGraph": { "put": { "tags": [ "PartnerCategoryName" ], "summary": "PartnerCategoryName: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerCategoryName-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerCategoryName_UpsertGraph_7E29B294BCAD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerCategoryName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerCategoryName" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerCategoryName" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerCategoryName" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerCategoryName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerCategoryName" } } } } } } }, "/api/PartnerCategoryName/UpsertGraphWithExtraFields": { "put": { "tags": [ "PartnerCategoryName" ], "summary": "PartnerCategoryName: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerCategoryName-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerCategoryName_UpsertGraphWithExtraFields_3AD80B6E0666", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerCategoryName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerCategoryName" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerCategoryName" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerCategoryName" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerCategoryName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerCategoryName" } } } } } } }, "/api/PartnerContactPerson": { "get": { "tags": [ "PartnerContactPerson" ], "summary": "PartnerContactPerson: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerContactPerson-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerContactPerson_GetAll_2A48AC6512A8", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerContactPerson" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerContactPerson" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerContactPerson" } } } } } }, "post": { "tags": [ "PartnerContactPerson" ], "summary": "PartnerContactPerson: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerContactPerson-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerContactPerson_Post_90152DFF4E79", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerContactPerson" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerContactPerson" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerContactPerson" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerContactPerson" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerContactPerson" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerContactPerson" } } } } } }, "put": { "tags": [ "PartnerContactPerson" ], "summary": "PartnerContactPerson: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerContactPerson-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerContactPerson_Put_1ECEF067B33A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerContactPerson" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerContactPerson" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerContactPerson" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerContactPerson" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerContactPerson" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerContactPerson" } } } } } } }, "/api/PartnerContactPerson/{NewMatchcode}/{FromPartnerId}/GetPartnerContactPerson": { "get": { "tags": [ "PartnerContactPerson" ], "summary": "PartnerContactPerson: GetPartnerContactPerson", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerContactPerson-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerContactPerson_GetPartnerContactPerson_1E994AE34E31", "parameters": [ { "name": "NewMatchcode", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "FromPartnerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerContactPerson" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerContactPerson" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerContactPerson" } } } } } } }, "/api/PartnerContactPerson/{PartnerId}/PageFromViewByPartnerId": { "get": { "tags": [ "PartnerContactPerson" ], "summary": "PartnerContactPerson: GetPageFromViewByPartnerId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerContactPerson-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerContactPerson_GetPageFromViewByPartnerId_F7D4B6E6D57C", "parameters": [ { "name": "PartnerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerContactPerson/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "PartnerContactPerson" ], "summary": "PartnerContactPerson: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerContactPerson-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerContactPerson_GetPageByValue_9DB6DC6A768F", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerContactPerson/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "PartnerContactPerson" ], "summary": "PartnerContactPerson: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerContactPerson-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerContactPerson_GetPageByValue2_47BA1E6B1623", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerContactPerson/DeleteByFilter": { "post": { "tags": [ "PartnerContactPerson" ], "summary": "PartnerContactPerson: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerContactPerson-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerContactPerson_DeleteByFilter_67BF8B439CF3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/PartnerContactPerson/GetAllByValue": { "post": { "tags": [ "PartnerContactPerson" ], "summary": "PartnerContactPerson: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerContactPerson-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerContactPerson_GetAllByValue_D76C47C3CC7E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerContactPerson" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerContactPerson" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerContactPerson" } } } } } } }, "/api/PartnerContactPerson/GetAllGraphByValue": { "post": { "tags": [ "PartnerContactPerson" ], "summary": "PartnerContactPerson: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerContactPerson-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerContactPerson_GetAllGraphByValue_52E08F48D87D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerContactPerson" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerContactPerson" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerContactPerson" } } } } } } }, "/api/PartnerContactPerson/GetByValue": { "post": { "tags": [ "PartnerContactPerson" ], "summary": "PartnerContactPerson: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerContactPerson-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerContactPerson_GetByValue_CC7E1B605095", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerContactPerson" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerContactPerson" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerContactPerson" } } } } } } }, "/api/PartnerContactPerson/GetLookup": { "post": { "tags": [ "PartnerContactPerson" ], "summary": "PartnerContactPerson: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerContactPerson-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerContactPerson_GetLookup_8ACAF416EB67", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/PartnerContactPerson/GetLookupByValue": { "post": { "tags": [ "PartnerContactPerson" ], "summary": "PartnerContactPerson: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerContactPerson-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerContactPerson_GetLookupByValue_74FE42483D92", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/PartnerContactPerson/Page": { "get": { "tags": [ "PartnerContactPerson" ], "summary": "PartnerContactPerson: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerContactPerson-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerContactPerson_GetPage_63FCA5442BE8", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerContactPerson/PageAsc": { "get": { "tags": [ "PartnerContactPerson" ], "summary": "PartnerContactPerson: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerContactPerson-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerContactPerson_GetPageAsc_EEB787F23586", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerContactPerson/PageFromView": { "get": { "tags": [ "PartnerContactPerson" ], "summary": "PartnerContactPerson: GetPageFromView", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerContactPerson-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerContactPerson_GetPageFromView_A2F3FFCF0826", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerContactPerson/SearchByValue": { "post": { "tags": [ "PartnerContactPerson" ], "summary": "PartnerContactPerson: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerContactPerson-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerContactPerson_SearchByValue_BAA82EB23FD8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerContactPerson" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerContactPerson" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerContactPerson" } } } } } } }, "/api/PartnerContactPerson/TryGetByValue": { "post": { "tags": [ "PartnerContactPerson" ], "summary": "PartnerContactPerson: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerContactPerson-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerContactPerson_TryGetByValue_92C84B98652C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerContactPerson" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerContactPerson" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerContactPerson" } } } } } } }, "/api/PartnerContactPerson/UpsertGraph": { "put": { "tags": [ "PartnerContactPerson" ], "summary": "PartnerContactPerson: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerContactPerson-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerContactPerson_UpsertGraph_641A05F5A464", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerContactPerson" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerContactPerson" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerContactPerson" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerContactPerson" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerContactPerson" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerContactPerson" } } } } } } }, "/api/PartnerContactPerson/UpsertGraphWithExtraFields": { "put": { "tags": [ "PartnerContactPerson" ], "summary": "PartnerContactPerson: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerContactPerson-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerContactPerson_UpsertGraphWithExtraFields_E2ECFB1630F1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerContactPerson" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerContactPerson" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerContactPerson" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerContactPerson" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerContactPerson" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerContactPerson" } } } } } } }, "/api/PartnerContactPersonEmailCategoryContactPerson": { "get": { "tags": [ "PartnerContactPersonEmailCategoryContactPerson" ], "summary": "PartnerContactPersonEmailCategoryContactPerson: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerContactPersonEmailCategoryContactPerson-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerContactPersonEmailCategoryContactPerson_GetAll_5C3695C21950", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryContactPerson" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryContactPerson" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryContactPerson" } } } } } }, "post": { "tags": [ "PartnerContactPersonEmailCategoryContactPerson" ], "summary": "PartnerContactPersonEmailCategoryContactPerson: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerContactPersonEmailCategoryContactPerson-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerContactPersonEmailCategoryContactPerson_Post_11E9CA245437", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerContactPersonEmailCategoryContactPerson" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerContactPersonEmailCategoryContactPerson" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerContactPersonEmailCategoryContactPerson" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryContactPerson" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryContactPerson" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryContactPerson" } } } } } }, "put": { "tags": [ "PartnerContactPersonEmailCategoryContactPerson" ], "summary": "PartnerContactPersonEmailCategoryContactPerson: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerContactPersonEmailCategoryContactPerson-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerContactPersonEmailCategoryContactPerson_Put_C2C6CD28972A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerContactPersonEmailCategoryContactPerson" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerContactPersonEmailCategoryContactPerson" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerContactPersonEmailCategoryContactPerson" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryContactPerson" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryContactPerson" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryContactPerson" } } } } } } }, "/api/PartnerContactPersonEmailCategoryContactPerson/{PartnerContactPersonId}/GetPageFromViewByPartnerContactPersonId": { "get": { "tags": [ "PartnerContactPersonEmailCategoryContactPerson" ], "summary": "PartnerContactPersonEmailCategoryContactPerson: GetPageFromViewByPartnerContactPersonId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerContactPersonEmailCategoryContactPerson-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerContactPersonEmailCategoryContactPerson_GetPageFromViewByPartnerContactPersonId_269CCFE82565", "parameters": [ { "name": "PartnerContactPersonId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerContactPersonEmailCategoryContactPerson/{PartnerId}/{DocTypeId}/GetPartnerContactPersonEmail": { "get": { "tags": [ "PartnerContactPersonEmailCategoryContactPerson" ], "summary": "PartnerContactPersonEmailCategoryContactPerson: GetPartnerOutputControlFormat", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerContactPersonEmailCategoryContactPerson-Read.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerContactPersonEmailCategoryContactPerson_GetPartnerOutputControlFormat_12FAB7488548", "parameters": [ { "name": "PartnerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "DocTypeId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerContactPersonEmailCategoryContactPerson/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "PartnerContactPersonEmailCategoryContactPerson" ], "summary": "PartnerContactPersonEmailCategoryContactPerson: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerContactPersonEmailCategoryContactPerson-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerContactPersonEmailCategoryContactPerson_GetPageByValue_A8A342348539", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerContactPersonEmailCategoryContactPerson/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "PartnerContactPersonEmailCategoryContactPerson" ], "summary": "PartnerContactPersonEmailCategoryContactPerson: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerContactPersonEmailCategoryContactPerson-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerContactPersonEmailCategoryContactPerson_GetPageByValue2_468AAC397E07", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerContactPersonEmailCategoryContactPerson/DeleteByFilter": { "post": { "tags": [ "PartnerContactPersonEmailCategoryContactPerson" ], "summary": "PartnerContactPersonEmailCategoryContactPerson: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerContactPersonEmailCategoryContactPerson-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerContactPersonEmailCategoryContactPerson_DeleteByFilter_B980EF35904F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/PartnerContactPersonEmailCategoryContactPerson/GetAllByValue": { "post": { "tags": [ "PartnerContactPersonEmailCategoryContactPerson" ], "summary": "PartnerContactPersonEmailCategoryContactPerson: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerContactPersonEmailCategoryContactPerson-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerContactPersonEmailCategoryContactPerson_GetAllByValue_AA1A7067DBE7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryContactPerson" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryContactPerson" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryContactPerson" } } } } } } }, "/api/PartnerContactPersonEmailCategoryContactPerson/GetAllGraphByValue": { "post": { "tags": [ "PartnerContactPersonEmailCategoryContactPerson" ], "summary": "PartnerContactPersonEmailCategoryContactPerson: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerContactPersonEmailCategoryContactPerson-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerContactPersonEmailCategoryContactPerson_GetAllGraphByValue_E32C82855CA0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryContactPerson" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryContactPerson" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryContactPerson" } } } } } } }, "/api/PartnerContactPersonEmailCategoryContactPerson/GetByValue": { "post": { "tags": [ "PartnerContactPersonEmailCategoryContactPerson" ], "summary": "PartnerContactPersonEmailCategoryContactPerson: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerContactPersonEmailCategoryContactPerson-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerContactPersonEmailCategoryContactPerson_GetByValue_E286EDD96F50", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryContactPerson" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryContactPerson" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryContactPerson" } } } } } } }, "/api/PartnerContactPersonEmailCategoryContactPerson/GetLookup": { "post": { "tags": [ "PartnerContactPersonEmailCategoryContactPerson" ], "summary": "PartnerContactPersonEmailCategoryContactPerson: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerContactPersonEmailCategoryContactPerson-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerContactPersonEmailCategoryContactPerson_GetLookup_C62F627E2C19", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/PartnerContactPersonEmailCategoryContactPerson/GetLookupByValue": { "post": { "tags": [ "PartnerContactPersonEmailCategoryContactPerson" ], "summary": "PartnerContactPersonEmailCategoryContactPerson: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerContactPersonEmailCategoryContactPerson-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerContactPersonEmailCategoryContactPerson_GetLookupByValue_29E0D2CE2CFB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/PartnerContactPersonEmailCategoryContactPerson/Page": { "get": { "tags": [ "PartnerContactPersonEmailCategoryContactPerson" ], "summary": "PartnerContactPersonEmailCategoryContactPerson: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerContactPersonEmailCategoryContactPerson-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerContactPersonEmailCategoryContactPerson_GetPage_1564CA3DF0E3", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerContactPersonEmailCategoryContactPerson/PageAsc": { "get": { "tags": [ "PartnerContactPersonEmailCategoryContactPerson" ], "summary": "PartnerContactPersonEmailCategoryContactPerson: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerContactPersonEmailCategoryContactPerson-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerContactPersonEmailCategoryContactPerson_GetPageAsc_F8957116A06D", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerContactPersonEmailCategoryContactPerson/SearchByValue": { "post": { "tags": [ "PartnerContactPersonEmailCategoryContactPerson" ], "summary": "PartnerContactPersonEmailCategoryContactPerson: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerContactPersonEmailCategoryContactPerson-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerContactPersonEmailCategoryContactPerson_SearchByValue_88B940EC85A5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryContactPerson" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryContactPerson" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryContactPerson" } } } } } } }, "/api/PartnerContactPersonEmailCategoryContactPerson/TryGetByValue": { "post": { "tags": [ "PartnerContactPersonEmailCategoryContactPerson" ], "summary": "PartnerContactPersonEmailCategoryContactPerson: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerContactPersonEmailCategoryContactPerson-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerContactPersonEmailCategoryContactPerson_TryGetByValue_1D91C572FD5C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryContactPerson" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryContactPerson" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryContactPerson" } } } } } } }, "/api/PartnerContactPersonEmailCategoryContactPerson/UpsertGraph": { "put": { "tags": [ "PartnerContactPersonEmailCategoryContactPerson" ], "summary": "PartnerContactPersonEmailCategoryContactPerson: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerContactPersonEmailCategoryContactPerson-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerContactPersonEmailCategoryContactPerson_UpsertGraph_F94E16E2967F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerContactPersonEmailCategoryContactPerson" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerContactPersonEmailCategoryContactPerson" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerContactPersonEmailCategoryContactPerson" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryContactPerson" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryContactPerson" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryContactPerson" } } } } } } }, "/api/PartnerContactPersonEmailCategoryContactPerson/UpsertGraphWithExtraFields": { "put": { "tags": [ "PartnerContactPersonEmailCategoryContactPerson" ], "summary": "PartnerContactPersonEmailCategoryContactPerson: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerContactPersonEmailCategoryContactPerson-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerContactPersonEmailCategoryContactPerson_UpsertGraphWithExtraFields_B584F78320D9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryContactPerson" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryContactPerson" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryContactPerson" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryContactPerson" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryContactPerson" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryContactPerson" } } } } } } }, "/api/PartnerContactPersonEmailCategoryDocType": { "get": { "tags": [ "PartnerContactPersonEmailCategoryDocType" ], "summary": "PartnerContactPersonEmailCategoryDocType: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerContactPersonEmailCategoryDocType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerContactPersonEmailCategoryDocType_GetAll_705B9B665AF1", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryDocType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryDocType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryDocType" } } } } } }, "post": { "tags": [ "PartnerContactPersonEmailCategoryDocType" ], "summary": "PartnerContactPersonEmailCategoryDocType: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerContactPersonEmailCategoryDocType-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerContactPersonEmailCategoryDocType_Post_417AAC111FA8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerContactPersonEmailCategoryDocType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerContactPersonEmailCategoryDocType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerContactPersonEmailCategoryDocType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryDocType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryDocType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryDocType" } } } } } }, "put": { "tags": [ "PartnerContactPersonEmailCategoryDocType" ], "summary": "PartnerContactPersonEmailCategoryDocType: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerContactPersonEmailCategoryDocType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerContactPersonEmailCategoryDocType_Put_AFB25E6F9E6F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerContactPersonEmailCategoryDocType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerContactPersonEmailCategoryDocType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerContactPersonEmailCategoryDocType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryDocType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryDocType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryDocType" } } } } } } }, "/api/PartnerContactPersonEmailCategoryDocType/{PartnerContactPersonEmailCategoryDocTypeNameId}/GetPageFromViewByPartnerContactPersonEmailCategoryDocTypeNameId": { "get": { "tags": [ "PartnerContactPersonEmailCategoryDocType" ], "summary": "PartnerContactPersonEmailCategoryDocType: GetPageFromViewByPartnerContactPersonEmailCategoryDocTypeNameId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerContactPersonEmailCategoryDocType-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerContactPersonEmailCategoryDocType_GetPageFromViewByPartnerContactPersonEmailCategoryDocTypeNameId_B185BA6D9F4B", "parameters": [ { "name": "PartnerContactPersonEmailCategoryDocTypeNameId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerContactPersonEmailCategoryDocType/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "PartnerContactPersonEmailCategoryDocType" ], "summary": "PartnerContactPersonEmailCategoryDocType: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerContactPersonEmailCategoryDocType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerContactPersonEmailCategoryDocType_GetPageByValue_0199A98AE432", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerContactPersonEmailCategoryDocType/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "PartnerContactPersonEmailCategoryDocType" ], "summary": "PartnerContactPersonEmailCategoryDocType: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerContactPersonEmailCategoryDocType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerContactPersonEmailCategoryDocType_GetPageByValue2_AB46B572475F", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerContactPersonEmailCategoryDocType/DeleteByFilter": { "post": { "tags": [ "PartnerContactPersonEmailCategoryDocType" ], "summary": "PartnerContactPersonEmailCategoryDocType: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerContactPersonEmailCategoryDocType-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerContactPersonEmailCategoryDocType_DeleteByFilter_F1501D712541", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/PartnerContactPersonEmailCategoryDocType/FullPage": { "get": { "tags": [ "PartnerContactPersonEmailCategoryDocType" ], "summary": "PartnerContactPersonEmailCategoryDocType: GetFullPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerContactPersonEmailCategoryDocType-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerContactPersonEmailCategoryDocType_GetFullPage_CF09B455EA76", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerContactPersonEmailCategoryDocType/GetAllByValue": { "post": { "tags": [ "PartnerContactPersonEmailCategoryDocType" ], "summary": "PartnerContactPersonEmailCategoryDocType: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerContactPersonEmailCategoryDocType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerContactPersonEmailCategoryDocType_GetAllByValue_9ED95FD6E0B8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryDocType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryDocType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryDocType" } } } } } } }, "/api/PartnerContactPersonEmailCategoryDocType/GetAllGraphByValue": { "post": { "tags": [ "PartnerContactPersonEmailCategoryDocType" ], "summary": "PartnerContactPersonEmailCategoryDocType: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerContactPersonEmailCategoryDocType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerContactPersonEmailCategoryDocType_GetAllGraphByValue_5FB65FCA57D2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryDocType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryDocType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryDocType" } } } } } } }, "/api/PartnerContactPersonEmailCategoryDocType/GetByValue": { "post": { "tags": [ "PartnerContactPersonEmailCategoryDocType" ], "summary": "PartnerContactPersonEmailCategoryDocType: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerContactPersonEmailCategoryDocType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerContactPersonEmailCategoryDocType_GetByValue_48F90F639B6F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryDocType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryDocType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryDocType" } } } } } } }, "/api/PartnerContactPersonEmailCategoryDocType/GetLookup": { "post": { "tags": [ "PartnerContactPersonEmailCategoryDocType" ], "summary": "PartnerContactPersonEmailCategoryDocType: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerContactPersonEmailCategoryDocType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerContactPersonEmailCategoryDocType_GetLookup_C48F2BCD83B4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/PartnerContactPersonEmailCategoryDocType/GetLookupByValue": { "post": { "tags": [ "PartnerContactPersonEmailCategoryDocType" ], "summary": "PartnerContactPersonEmailCategoryDocType: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerContactPersonEmailCategoryDocType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerContactPersonEmailCategoryDocType_GetLookupByValue_7C6FE29BEB53", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/PartnerContactPersonEmailCategoryDocType/Page": { "get": { "tags": [ "PartnerContactPersonEmailCategoryDocType" ], "summary": "PartnerContactPersonEmailCategoryDocType: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerContactPersonEmailCategoryDocType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerContactPersonEmailCategoryDocType_GetPage_32933688EADB", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerContactPersonEmailCategoryDocType/PageAsc": { "get": { "tags": [ "PartnerContactPersonEmailCategoryDocType" ], "summary": "PartnerContactPersonEmailCategoryDocType: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerContactPersonEmailCategoryDocType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerContactPersonEmailCategoryDocType_GetPageAsc_89349223C102", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerContactPersonEmailCategoryDocType/SearchByValue": { "post": { "tags": [ "PartnerContactPersonEmailCategoryDocType" ], "summary": "PartnerContactPersonEmailCategoryDocType: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerContactPersonEmailCategoryDocType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerContactPersonEmailCategoryDocType_SearchByValue_0C97E3A005BF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryDocType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryDocType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryDocType" } } } } } } }, "/api/PartnerContactPersonEmailCategoryDocType/TryGetByValue": { "post": { "tags": [ "PartnerContactPersonEmailCategoryDocType" ], "summary": "PartnerContactPersonEmailCategoryDocType: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerContactPersonEmailCategoryDocType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerContactPersonEmailCategoryDocType_TryGetByValue_5D1A3F5DB85C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryDocType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryDocType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryDocType" } } } } } } }, "/api/PartnerContactPersonEmailCategoryDocType/UpsertGraph": { "put": { "tags": [ "PartnerContactPersonEmailCategoryDocType" ], "summary": "PartnerContactPersonEmailCategoryDocType: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerContactPersonEmailCategoryDocType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerContactPersonEmailCategoryDocType_UpsertGraph_57D30303153B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerContactPersonEmailCategoryDocType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerContactPersonEmailCategoryDocType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerContactPersonEmailCategoryDocType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryDocType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryDocType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryDocType" } } } } } } }, "/api/PartnerContactPersonEmailCategoryDocType/UpsertGraphWithExtraFields": { "put": { "tags": [ "PartnerContactPersonEmailCategoryDocType" ], "summary": "PartnerContactPersonEmailCategoryDocType: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerContactPersonEmailCategoryDocType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerContactPersonEmailCategoryDocType_UpsertGraphWithExtraFields_827714FE0B46", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryDocType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryDocType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryDocType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryDocType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryDocType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryDocType" } } } } } } }, "/api/PartnerContactPersonEmailCategoryName": { "get": { "tags": [ "PartnerContactPersonEmailCategoryName" ], "summary": "PartnerContactPersonEmailCategoryName: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerContactPersonEmailCategoryName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerContactPersonEmailCategoryName_GetAll_63C8EBC79F4A", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryName" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryName" } } } } } }, "post": { "tags": [ "PartnerContactPersonEmailCategoryName" ], "summary": "PartnerContactPersonEmailCategoryName: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerContactPersonEmailCategoryName-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerContactPersonEmailCategoryName_Post_9D0E4BAD3446", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerContactPersonEmailCategoryName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerContactPersonEmailCategoryName" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerContactPersonEmailCategoryName" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryName" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryName" } } } } } }, "put": { "tags": [ "PartnerContactPersonEmailCategoryName" ], "summary": "PartnerContactPersonEmailCategoryName: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerContactPersonEmailCategoryName-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerContactPersonEmailCategoryName_Put_066EA8D6B3D1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerContactPersonEmailCategoryName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerContactPersonEmailCategoryName" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerContactPersonEmailCategoryName" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryName" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryName" } } } } } } }, "/api/PartnerContactPersonEmailCategoryName/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "PartnerContactPersonEmailCategoryName" ], "summary": "PartnerContactPersonEmailCategoryName: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerContactPersonEmailCategoryName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerContactPersonEmailCategoryName_GetPageByValue_F3537D45CA9F", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerContactPersonEmailCategoryName/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "PartnerContactPersonEmailCategoryName" ], "summary": "PartnerContactPersonEmailCategoryName: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerContactPersonEmailCategoryName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerContactPersonEmailCategoryName_GetPageByValue2_2298673D0D02", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerContactPersonEmailCategoryName/DeleteByFilter": { "post": { "tags": [ "PartnerContactPersonEmailCategoryName" ], "summary": "PartnerContactPersonEmailCategoryName: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerContactPersonEmailCategoryName-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerContactPersonEmailCategoryName_DeleteByFilter_94679455AD00", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/PartnerContactPersonEmailCategoryName/GetAllByValue": { "post": { "tags": [ "PartnerContactPersonEmailCategoryName" ], "summary": "PartnerContactPersonEmailCategoryName: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerContactPersonEmailCategoryName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerContactPersonEmailCategoryName_GetAllByValue_0641DC867344", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryName" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryName" } } } } } } }, "/api/PartnerContactPersonEmailCategoryName/GetAllGraphByValue": { "post": { "tags": [ "PartnerContactPersonEmailCategoryName" ], "summary": "PartnerContactPersonEmailCategoryName: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerContactPersonEmailCategoryName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerContactPersonEmailCategoryName_GetAllGraphByValue_ED29C9476E46", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryName" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryName" } } } } } } }, "/api/PartnerContactPersonEmailCategoryName/GetByValue": { "post": { "tags": [ "PartnerContactPersonEmailCategoryName" ], "summary": "PartnerContactPersonEmailCategoryName: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerContactPersonEmailCategoryName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerContactPersonEmailCategoryName_GetByValue_541389DE059D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryName" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryName" } } } } } } }, "/api/PartnerContactPersonEmailCategoryName/GetLookup": { "post": { "tags": [ "PartnerContactPersonEmailCategoryName" ], "summary": "PartnerContactPersonEmailCategoryName: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerContactPersonEmailCategoryName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerContactPersonEmailCategoryName_GetLookup_65A5E0E4EBF4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/PartnerContactPersonEmailCategoryName/GetLookupByValue": { "post": { "tags": [ "PartnerContactPersonEmailCategoryName" ], "summary": "PartnerContactPersonEmailCategoryName: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerContactPersonEmailCategoryName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerContactPersonEmailCategoryName_GetLookupByValue_A0BC26BA836B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/PartnerContactPersonEmailCategoryName/Page": { "get": { "tags": [ "PartnerContactPersonEmailCategoryName" ], "summary": "PartnerContactPersonEmailCategoryName: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerContactPersonEmailCategoryName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerContactPersonEmailCategoryName_GetPage_5FF314F8983B", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerContactPersonEmailCategoryName/PageAsc": { "get": { "tags": [ "PartnerContactPersonEmailCategoryName" ], "summary": "PartnerContactPersonEmailCategoryName: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerContactPersonEmailCategoryName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerContactPersonEmailCategoryName_GetPageAsc_5C5CBEF426B5", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerContactPersonEmailCategoryName/SearchByValue": { "post": { "tags": [ "PartnerContactPersonEmailCategoryName" ], "summary": "PartnerContactPersonEmailCategoryName: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerContactPersonEmailCategoryName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerContactPersonEmailCategoryName_SearchByValue_5F0BDDACD718", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryName" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryName" } } } } } } }, "/api/PartnerContactPersonEmailCategoryName/TryGetByValue": { "post": { "tags": [ "PartnerContactPersonEmailCategoryName" ], "summary": "PartnerContactPersonEmailCategoryName: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerContactPersonEmailCategoryName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerContactPersonEmailCategoryName_TryGetByValue_07F10001F725", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryName" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryName" } } } } } } }, "/api/PartnerContactPersonEmailCategoryName/UpsertGraph": { "put": { "tags": [ "PartnerContactPersonEmailCategoryName" ], "summary": "PartnerContactPersonEmailCategoryName: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerContactPersonEmailCategoryName-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerContactPersonEmailCategoryName_UpsertGraph_9050F52E0F40", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerContactPersonEmailCategoryName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerContactPersonEmailCategoryName" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerContactPersonEmailCategoryName" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryName" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryName" } } } } } } }, "/api/PartnerContactPersonEmailCategoryName/UpsertGraphWithExtraFields": { "put": { "tags": [ "PartnerContactPersonEmailCategoryName" ], "summary": "PartnerContactPersonEmailCategoryName: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerContactPersonEmailCategoryName-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerContactPersonEmailCategoryName_UpsertGraphWithExtraFields_A896D2956060", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryName" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryName" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryName" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryName" } } } } } } }, "/api/PartnerDeliveryAddress": { "get": { "tags": [ "PartnerDeliveryAddress" ], "summary": "PartnerDeliveryAddress: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDeliveryAddress-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDeliveryAddress_GetAll_1E3D834938BF", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerDeliveryAddress" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerDeliveryAddress" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerDeliveryAddress" } } } } } }, "post": { "tags": [ "PartnerDeliveryAddress" ], "summary": "PartnerDeliveryAddress: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDeliveryAddress-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDeliveryAddress_Post_747A1E754771", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDeliveryAddress" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDeliveryAddress" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDeliveryAddress" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDeliveryAddress" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDeliveryAddress" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDeliveryAddress" } } } } } }, "put": { "tags": [ "PartnerDeliveryAddress" ], "summary": "PartnerDeliveryAddress: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDeliveryAddress-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDeliveryAddress_Put_3D87CF493C26", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDeliveryAddress" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDeliveryAddress" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDeliveryAddress" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDeliveryAddress" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDeliveryAddress" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDeliveryAddress" } } } } } } }, "/api/PartnerDeliveryAddress/{NewMatchcode}/{FromPartnerId}/GetPartnerDeliveryAddress": { "get": { "tags": [ "PartnerDeliveryAddress" ], "summary": "PartnerDeliveryAddress: GetPartnerDeliveryAddress", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDeliveryAddress-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDeliveryAddress_GetPartnerDeliveryAddress_A732E0326A3E", "parameters": [ { "name": "NewMatchcode", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "FromPartnerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDeliveryAddress" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDeliveryAddress" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDeliveryAddress" } } } } } } }, "/api/PartnerDeliveryAddress/{PartnerId}/PageFromViewByPartnerId": { "get": { "tags": [ "PartnerDeliveryAddress" ], "summary": "PartnerDeliveryAddress: GetPageFromViewByArticleId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDeliveryAddress-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDeliveryAddress_GetPageFromViewByArticleId_9FA52113A2AC", "parameters": [ { "name": "PartnerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerDeliveryAddress/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "PartnerDeliveryAddress" ], "summary": "PartnerDeliveryAddress: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDeliveryAddress-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDeliveryAddress_GetPageByValue_7A35E07045BC", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerDeliveryAddress/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "PartnerDeliveryAddress" ], "summary": "PartnerDeliveryAddress: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDeliveryAddress-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDeliveryAddress_GetPageByValue2_26E43747AC7E", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerDeliveryAddress/DeleteByFilter": { "post": { "tags": [ "PartnerDeliveryAddress" ], "summary": "PartnerDeliveryAddress: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDeliveryAddress-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDeliveryAddress_DeleteByFilter_64F33AE4C015", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/PartnerDeliveryAddress/GetAllByValue": { "post": { "tags": [ "PartnerDeliveryAddress" ], "summary": "PartnerDeliveryAddress: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDeliveryAddress-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDeliveryAddress_GetAllByValue_873AE6D6454C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerDeliveryAddress" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerDeliveryAddress" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerDeliveryAddress" } } } } } } }, "/api/PartnerDeliveryAddress/GetAllGraphByValue": { "post": { "tags": [ "PartnerDeliveryAddress" ], "summary": "PartnerDeliveryAddress: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDeliveryAddress-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDeliveryAddress_GetAllGraphByValue_C2BFCDF6A96D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerDeliveryAddress" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerDeliveryAddress" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerDeliveryAddress" } } } } } } }, "/api/PartnerDeliveryAddress/GetByValue": { "post": { "tags": [ "PartnerDeliveryAddress" ], "summary": "PartnerDeliveryAddress: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDeliveryAddress-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDeliveryAddress_GetByValue_368F0603997D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDeliveryAddress" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDeliveryAddress" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDeliveryAddress" } } } } } } }, "/api/PartnerDeliveryAddress/GetLookup": { "post": { "tags": [ "PartnerDeliveryAddress" ], "summary": "PartnerDeliveryAddress: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDeliveryAddress-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDeliveryAddress_GetLookup_F55E97BA75F5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/PartnerDeliveryAddress/GetLookupByValue": { "post": { "tags": [ "PartnerDeliveryAddress" ], "summary": "PartnerDeliveryAddress: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDeliveryAddress-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDeliveryAddress_GetLookupByValue_3329DAB5041A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/PartnerDeliveryAddress/Page": { "get": { "tags": [ "PartnerDeliveryAddress" ], "summary": "PartnerDeliveryAddress: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDeliveryAddress-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDeliveryAddress_GetPage_26CCFDE80FED", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerDeliveryAddress/PageAsc": { "get": { "tags": [ "PartnerDeliveryAddress" ], "summary": "PartnerDeliveryAddress: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDeliveryAddress-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDeliveryAddress_GetPageAsc_AF8482019821", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerDeliveryAddress/SearchByValue": { "post": { "tags": [ "PartnerDeliveryAddress" ], "summary": "PartnerDeliveryAddress: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDeliveryAddress-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDeliveryAddress_SearchByValue_70FAC58F556F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerDeliveryAddress" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerDeliveryAddress" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerDeliveryAddress" } } } } } } }, "/api/PartnerDeliveryAddress/TryGetByValue": { "post": { "tags": [ "PartnerDeliveryAddress" ], "summary": "PartnerDeliveryAddress: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDeliveryAddress-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDeliveryAddress_TryGetByValue_EFE10877472A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDeliveryAddress" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDeliveryAddress" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDeliveryAddress" } } } } } } }, "/api/PartnerDeliveryAddress/UpsertGraph": { "put": { "tags": [ "PartnerDeliveryAddress" ], "summary": "PartnerDeliveryAddress: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDeliveryAddress-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDeliveryAddress_UpsertGraph_37862A9BCCF4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDeliveryAddress" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDeliveryAddress" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDeliveryAddress" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDeliveryAddress" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDeliveryAddress" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDeliveryAddress" } } } } } } }, "/api/PartnerDeliveryAddress/UpsertGraphWithExtraFields": { "put": { "tags": [ "PartnerDeliveryAddress" ], "summary": "PartnerDeliveryAddress: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDeliveryAddress-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDeliveryAddress_UpsertGraphWithExtraFields_D7A98138A642", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerDeliveryAddress" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerDeliveryAddress" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerDeliveryAddress" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerDeliveryAddress" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerDeliveryAddress" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerDeliveryAddress" } } } } } } }, "/api/PartnerDetail": { "get": { "tags": [ "PartnerDetail" ], "summary": "PartnerDetail: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDetail-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDetail_GetAll_2BE7AE49D36D", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerDetail" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerDetail" } } } } } }, "post": { "tags": [ "PartnerDetail" ], "summary": "PartnerDetail: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDetail-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDetail_Post_354883536909", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDetail" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDetail" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDetail" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDetail" } } } } } }, "put": { "tags": [ "PartnerDetail" ], "summary": "PartnerDetail: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDetail-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDetail_Put_9432A44B0DEE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDetail" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDetail" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDetail" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDetail" } } } } } } }, "/api/PartnerDetail/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "PartnerDetail" ], "summary": "PartnerDetail: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDetail-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDetail_GetPageByValue_8CB4B818DE91", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerDetail/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "PartnerDetail" ], "summary": "PartnerDetail: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDetail-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDetail_GetPageByValue2_85F51A17DA64", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerDetail/DeleteByFilter": { "post": { "tags": [ "PartnerDetail" ], "summary": "PartnerDetail: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDetail-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDetail_DeleteByFilter_652A12C2529C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/PartnerDetail/GetAllByValue": { "post": { "tags": [ "PartnerDetail" ], "summary": "PartnerDetail: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDetail-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDetail_GetAllByValue_A2D680124733", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerDetail" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerDetail" } } } } } } }, "/api/PartnerDetail/GetAllGraphByValue": { "post": { "tags": [ "PartnerDetail" ], "summary": "PartnerDetail: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDetail-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDetail_GetAllGraphByValue_22A1C2EAC510", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerDetail" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerDetail" } } } } } } }, "/api/PartnerDetail/GetByValue": { "post": { "tags": [ "PartnerDetail" ], "summary": "PartnerDetail: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDetail-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDetail_GetByValue_80A43A97D346", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDetail" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDetail" } } } } } } }, "/api/PartnerDetail/GetLookup": { "post": { "tags": [ "PartnerDetail" ], "summary": "PartnerDetail: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDetail-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDetail_GetLookup_2BD6D40109C3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/PartnerDetail/GetLookupByValue": { "post": { "tags": [ "PartnerDetail" ], "summary": "PartnerDetail: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDetail-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDetail_GetLookupByValue_8FEBEC8EC546", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/PartnerDetail/Page": { "get": { "tags": [ "PartnerDetail" ], "summary": "PartnerDetail: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDetail-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDetail_GetPage_43C9CDF87575", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerDetail/PageAsc": { "get": { "tags": [ "PartnerDetail" ], "summary": "PartnerDetail: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDetail-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDetail_GetPageAsc_EA546946EEAE", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerDetail/SearchByValue": { "post": { "tags": [ "PartnerDetail" ], "summary": "PartnerDetail: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDetail-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDetail_SearchByValue_17B23BB6527E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerDetail" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerDetail" } } } } } } }, "/api/PartnerDetail/TryGetByValue": { "post": { "tags": [ "PartnerDetail" ], "summary": "PartnerDetail: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDetail-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDetail_TryGetByValue_5CCF529D8651", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDetail" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDetail" } } } } } } }, "/api/PartnerDetail/UpsertGraph": { "put": { "tags": [ "PartnerDetail" ], "summary": "PartnerDetail: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDetail-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDetail_UpsertGraph_8DA8C36E94B0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDetail" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDetail" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDetail" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDetail" } } } } } } }, "/api/PartnerDetail/UpsertGraphWithExtraFields": { "put": { "tags": [ "PartnerDetail" ], "summary": "PartnerDetail: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDetail-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDetail_UpsertGraphWithExtraFields_69CB978A2A09", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerDetail" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerDetail" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerDetail" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerDetail" } } } } } } }, "/api/PartnerDetailBanking": { "get": { "tags": [ "PartnerDetailBanking" ], "summary": "PartnerDetailBanking: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDetailBanking-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDetailBanking_GetAll_B51DB42029D3", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerDetailBanking" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerDetailBanking" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerDetailBanking" } } } } } }, "post": { "tags": [ "PartnerDetailBanking" ], "summary": "PartnerDetailBanking: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDetailBanking-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDetailBanking_Post_C250C58AF5D0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDetailBanking" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDetailBanking" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDetailBanking" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDetailBanking" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDetailBanking" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDetailBanking" } } } } } }, "put": { "tags": [ "PartnerDetailBanking" ], "summary": "PartnerDetailBanking: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDetailBanking-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDetailBanking_Put_3538EDB119C6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDetailBanking" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDetailBanking" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDetailBanking" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDetailBanking" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDetailBanking" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDetailBanking" } } } } } } }, "/api/PartnerDetailBanking/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "PartnerDetailBanking" ], "summary": "PartnerDetailBanking: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDetailBanking-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDetailBanking_GetPageByValue_F7BCC25DDE14", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerDetailBanking/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "PartnerDetailBanking" ], "summary": "PartnerDetailBanking: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDetailBanking-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDetailBanking_GetPageByValue2_D2B09A713258", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerDetailBanking/DeleteByFilter": { "post": { "tags": [ "PartnerDetailBanking" ], "summary": "PartnerDetailBanking: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDetailBanking-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDetailBanking_DeleteByFilter_05F6CBBCA9EA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/PartnerDetailBanking/GetAllByValue": { "post": { "tags": [ "PartnerDetailBanking" ], "summary": "PartnerDetailBanking: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDetailBanking-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDetailBanking_GetAllByValue_2F7B52079445", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerDetailBanking" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerDetailBanking" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerDetailBanking" } } } } } } }, "/api/PartnerDetailBanking/GetAllGraphByValue": { "post": { "tags": [ "PartnerDetailBanking" ], "summary": "PartnerDetailBanking: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDetailBanking-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDetailBanking_GetAllGraphByValue_C8454AD012CE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerDetailBanking" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerDetailBanking" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerDetailBanking" } } } } } } }, "/api/PartnerDetailBanking/GetByValue": { "post": { "tags": [ "PartnerDetailBanking" ], "summary": "PartnerDetailBanking: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDetailBanking-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDetailBanking_GetByValue_34A55BE59061", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDetailBanking" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDetailBanking" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDetailBanking" } } } } } } }, "/api/PartnerDetailBanking/GetLookup": { "post": { "tags": [ "PartnerDetailBanking" ], "summary": "PartnerDetailBanking: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDetailBanking-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDetailBanking_GetLookup_2727A5258D45", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/PartnerDetailBanking/GetLookupByValue": { "post": { "tags": [ "PartnerDetailBanking" ], "summary": "PartnerDetailBanking: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDetailBanking-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDetailBanking_GetLookupByValue_17FCAD0F2A7A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/PartnerDetailBanking/Page": { "get": { "tags": [ "PartnerDetailBanking" ], "summary": "PartnerDetailBanking: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDetailBanking-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDetailBanking_GetPage_4AF6C8835E86", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerDetailBanking/PageAsc": { "get": { "tags": [ "PartnerDetailBanking" ], "summary": "PartnerDetailBanking: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDetailBanking-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDetailBanking_GetPageAsc_7861A761AC5D", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerDetailBanking/SearchByValue": { "post": { "tags": [ "PartnerDetailBanking" ], "summary": "PartnerDetailBanking: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDetailBanking-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDetailBanking_SearchByValue_F4F321119203", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerDetailBanking" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerDetailBanking" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerDetailBanking" } } } } } } }, "/api/PartnerDetailBanking/TryGetByValue": { "post": { "tags": [ "PartnerDetailBanking" ], "summary": "PartnerDetailBanking: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDetailBanking-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDetailBanking_TryGetByValue_B2FC8C45182B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDetailBanking" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDetailBanking" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDetailBanking" } } } } } } }, "/api/PartnerDetailBanking/UpsertGraph": { "put": { "tags": [ "PartnerDetailBanking" ], "summary": "PartnerDetailBanking: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDetailBanking-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDetailBanking_UpsertGraph_434A93C4A1B6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDetailBanking" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDetailBanking" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDetailBanking" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDetailBanking" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDetailBanking" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDetailBanking" } } } } } } }, "/api/PartnerDetailBanking/UpsertGraphWithExtraFields": { "put": { "tags": [ "PartnerDetailBanking" ], "summary": "PartnerDetailBanking: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDetailBanking-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDetailBanking_UpsertGraphWithExtraFields_1DBAA2E42256", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerDetailBanking" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerDetailBanking" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerDetailBanking" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerDetailBanking" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerDetailBanking" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerDetailBanking" } } } } } } }, "/api/PartnerDetailOutput": { "get": { "tags": [ "PartnerDetailOutput" ], "summary": "PartnerDetailOutput: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDetailOutput-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDetailOutput_GetAll_2424BCA803F9", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerDetailOutput" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerDetailOutput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerDetailOutput" } } } } } }, "post": { "tags": [ "PartnerDetailOutput" ], "summary": "PartnerDetailOutput: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDetailOutput-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDetailOutput_Post_33B001690641", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDetailOutput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDetailOutput" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDetailOutput" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDetailOutput" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDetailOutput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDetailOutput" } } } } } }, "put": { "tags": [ "PartnerDetailOutput" ], "summary": "PartnerDetailOutput: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDetailOutput-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDetailOutput_Put_84F8ECBF7B32", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDetailOutput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDetailOutput" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDetailOutput" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDetailOutput" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDetailOutput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDetailOutput" } } } } } } }, "/api/PartnerDetailOutput/{PartnerDetailId}/{DocTypeId}/GetPartnerOutputControlFormat": { "get": { "tags": [ "PartnerDetailOutput" ], "summary": "PartnerDetailOutput: GetPartnerOutputControlFormat", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDetailOutput-Read.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDetailOutput_GetPartnerOutputControlFormat_E9E09E10FE95", "parameters": [ { "name": "PartnerDetailId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "DocTypeId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerDetailOutput/{PartnerDetailId}/GetPageFromViewByPartnerDetailId": { "get": { "tags": [ "PartnerDetailOutput" ], "summary": "PartnerDetailOutput: GetPageFromViewByPartnerDetailId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDetailOutput-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDetailOutput_GetPageFromViewByPartnerDetailId_F5F9599D10F5", "parameters": [ { "name": "PartnerDetailId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerDetailOutput/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "PartnerDetailOutput" ], "summary": "PartnerDetailOutput: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDetailOutput-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDetailOutput_GetPageByValue_63B37AEC59CE", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerDetailOutput/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "PartnerDetailOutput" ], "summary": "PartnerDetailOutput: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDetailOutput-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDetailOutput_GetPageByValue2_B1A8B9E08E58", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerDetailOutput/DeleteByFilter": { "post": { "tags": [ "PartnerDetailOutput" ], "summary": "PartnerDetailOutput: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDetailOutput-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDetailOutput_DeleteByFilter_D1B3F3A7506F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/PartnerDetailOutput/GetAllByValue": { "post": { "tags": [ "PartnerDetailOutput" ], "summary": "PartnerDetailOutput: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDetailOutput-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDetailOutput_GetAllByValue_7B714257EFB9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerDetailOutput" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerDetailOutput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerDetailOutput" } } } } } } }, "/api/PartnerDetailOutput/GetAllGraphByValue": { "post": { "tags": [ "PartnerDetailOutput" ], "summary": "PartnerDetailOutput: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDetailOutput-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDetailOutput_GetAllGraphByValue_8ED9A071C4A5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerDetailOutput" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerDetailOutput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerDetailOutput" } } } } } } }, "/api/PartnerDetailOutput/GetByValue": { "post": { "tags": [ "PartnerDetailOutput" ], "summary": "PartnerDetailOutput: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDetailOutput-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDetailOutput_GetByValue_2F1D90B5AED2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDetailOutput" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDetailOutput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDetailOutput" } } } } } } }, "/api/PartnerDetailOutput/GetLookup": { "post": { "tags": [ "PartnerDetailOutput" ], "summary": "PartnerDetailOutput: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDetailOutput-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDetailOutput_GetLookup_DCEA01E074B4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/PartnerDetailOutput/GetLookupByValue": { "post": { "tags": [ "PartnerDetailOutput" ], "summary": "PartnerDetailOutput: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDetailOutput-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDetailOutput_GetLookupByValue_7554C9388204", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/PartnerDetailOutput/Page": { "get": { "tags": [ "PartnerDetailOutput" ], "summary": "PartnerDetailOutput: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDetailOutput-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDetailOutput_GetPage_F1B32D98A647", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerDetailOutput/PageAsc": { "get": { "tags": [ "PartnerDetailOutput" ], "summary": "PartnerDetailOutput: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDetailOutput-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDetailOutput_GetPageAsc_588B3AAB26BC", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerDetailOutput/SearchByValue": { "post": { "tags": [ "PartnerDetailOutput" ], "summary": "PartnerDetailOutput: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDetailOutput-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDetailOutput_SearchByValue_E5B61EC622F1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerDetailOutput" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerDetailOutput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerDetailOutput" } } } } } } }, "/api/PartnerDetailOutput/TryGetByValue": { "post": { "tags": [ "PartnerDetailOutput" ], "summary": "PartnerDetailOutput: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDetailOutput-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDetailOutput_TryGetByValue_5FF76F39AFDE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDetailOutput" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDetailOutput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDetailOutput" } } } } } } }, "/api/PartnerDetailOutput/UpsertGraph": { "put": { "tags": [ "PartnerDetailOutput" ], "summary": "PartnerDetailOutput: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDetailOutput-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDetailOutput_UpsertGraph_8EEEBB9C7C83", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDetailOutput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDetailOutput" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDetailOutput" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDetailOutput" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDetailOutput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDetailOutput" } } } } } } }, "/api/PartnerDetailOutput/UpsertGraphWithExtraFields": { "put": { "tags": [ "PartnerDetailOutput" ], "summary": "PartnerDetailOutput: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDetailOutput-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDetailOutput_UpsertGraphWithExtraFields_E23F6D83F322", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerDetailOutput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerDetailOutput" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerDetailOutput" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerDetailOutput" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerDetailOutput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerDetailOutput" } } } } } } }, "/api/PartnerDirectDebitType": { "get": { "tags": [ "PartnerDirectDebitType" ], "summary": "PartnerDirectDebitType: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDirectDebitType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDirectDebitType_GetAll_48F4D0DDE5C4", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerDirectDebitType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerDirectDebitType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerDirectDebitType" } } } } } }, "post": { "tags": [ "PartnerDirectDebitType" ], "summary": "PartnerDirectDebitType: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDirectDebitType-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDirectDebitType_Post_123808484536", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDirectDebitType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDirectDebitType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDirectDebitType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDirectDebitType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDirectDebitType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDirectDebitType" } } } } } }, "put": { "tags": [ "PartnerDirectDebitType" ], "summary": "PartnerDirectDebitType: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDirectDebitType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDirectDebitType_Put_F47FDF65C466", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDirectDebitType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDirectDebitType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDirectDebitType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDirectDebitType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDirectDebitType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDirectDebitType" } } } } } } }, "/api/PartnerDirectDebitType/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "PartnerDirectDebitType" ], "summary": "PartnerDirectDebitType: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDirectDebitType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDirectDebitType_GetPageByValue_D5B1D359BB19", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerDirectDebitType/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "PartnerDirectDebitType" ], "summary": "PartnerDirectDebitType: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDirectDebitType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDirectDebitType_GetPageByValue2_30D6AEB79E71", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerDirectDebitType/DeleteByFilter": { "post": { "tags": [ "PartnerDirectDebitType" ], "summary": "PartnerDirectDebitType: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDirectDebitType-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDirectDebitType_DeleteByFilter_412C1ACBB718", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/PartnerDirectDebitType/GetAllByValue": { "post": { "tags": [ "PartnerDirectDebitType" ], "summary": "PartnerDirectDebitType: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDirectDebitType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDirectDebitType_GetAllByValue_72FD35E0902E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerDirectDebitType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerDirectDebitType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerDirectDebitType" } } } } } } }, "/api/PartnerDirectDebitType/GetAllGraphByValue": { "post": { "tags": [ "PartnerDirectDebitType" ], "summary": "PartnerDirectDebitType: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDirectDebitType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDirectDebitType_GetAllGraphByValue_16995C03FC05", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerDirectDebitType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerDirectDebitType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerDirectDebitType" } } } } } } }, "/api/PartnerDirectDebitType/GetByValue": { "post": { "tags": [ "PartnerDirectDebitType" ], "summary": "PartnerDirectDebitType: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDirectDebitType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDirectDebitType_GetByValue_163C391C874B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDirectDebitType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDirectDebitType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDirectDebitType" } } } } } } }, "/api/PartnerDirectDebitType/GetLookup": { "post": { "tags": [ "PartnerDirectDebitType" ], "summary": "PartnerDirectDebitType: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDirectDebitType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDirectDebitType_GetLookup_6C5C941D7593", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/PartnerDirectDebitType/GetLookupByValue": { "post": { "tags": [ "PartnerDirectDebitType" ], "summary": "PartnerDirectDebitType: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDirectDebitType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDirectDebitType_GetLookupByValue_040DD5FD9F41", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/PartnerDirectDebitType/Page": { "get": { "tags": [ "PartnerDirectDebitType" ], "summary": "PartnerDirectDebitType: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDirectDebitType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDirectDebitType_GetPage_346DD1030394", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerDirectDebitType/PageAsc": { "get": { "tags": [ "PartnerDirectDebitType" ], "summary": "PartnerDirectDebitType: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDirectDebitType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDirectDebitType_GetPageAsc_DDCC663B649B", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerDirectDebitType/SearchByValue": { "post": { "tags": [ "PartnerDirectDebitType" ], "summary": "PartnerDirectDebitType: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDirectDebitType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDirectDebitType_SearchByValue_19A7B6F94FB9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerDirectDebitType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerDirectDebitType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerDirectDebitType" } } } } } } }, "/api/PartnerDirectDebitType/TryGetByValue": { "post": { "tags": [ "PartnerDirectDebitType" ], "summary": "PartnerDirectDebitType: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDirectDebitType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDirectDebitType_TryGetByValue_748C8C2ADC02", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDirectDebitType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDirectDebitType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDirectDebitType" } } } } } } }, "/api/PartnerDirectDebitType/UpsertGraph": { "put": { "tags": [ "PartnerDirectDebitType" ], "summary": "PartnerDirectDebitType: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDirectDebitType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDirectDebitType_UpsertGraph_CDB847BE142A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDirectDebitType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDirectDebitType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDirectDebitType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDirectDebitType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDirectDebitType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDirectDebitType" } } } } } } }, "/api/PartnerDirectDebitType/UpsertGraphWithExtraFields": { "put": { "tags": [ "PartnerDirectDebitType" ], "summary": "PartnerDirectDebitType: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDirectDebitType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDirectDebitType_UpsertGraphWithExtraFields_8AEE11529B49", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerDirectDebitType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerDirectDebitType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerDirectDebitType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerDirectDebitType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerDirectDebitType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerDirectDebitType" } } } } } } }, "/api/PartnerDiscountGroup": { "get": { "tags": [ "PartnerDiscountGroup" ], "summary": "PartnerDiscountGroup: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDiscountGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDiscountGroup_GetAll_58730075EE6C", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerDiscountGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerDiscountGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerDiscountGroup" } } } } } }, "post": { "tags": [ "PartnerDiscountGroup" ], "summary": "PartnerDiscountGroup: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDiscountGroup-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDiscountGroup_Post_4ABAFD1E8E8C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDiscountGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDiscountGroup" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDiscountGroup" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDiscountGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDiscountGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDiscountGroup" } } } } } }, "put": { "tags": [ "PartnerDiscountGroup" ], "summary": "PartnerDiscountGroup: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDiscountGroup-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDiscountGroup_Put_E1791D9C0945", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDiscountGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDiscountGroup" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDiscountGroup" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDiscountGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDiscountGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDiscountGroup" } } } } } } }, "/api/PartnerDiscountGroup/{DiscountGroupId}/{DiscountPercent}/UpdateDiscountPercent": { "get": { "tags": [ "PartnerDiscountGroup" ], "summary": "PartnerDiscountGroup: UpdateDiscountPercent", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDiscountGroup-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDiscountGroup_UpdateDiscountPercent_C82AFF485ACC", "parameters": [ { "name": "DiscountGroupId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "DiscountPercent", "in": "path", "required": true, "schema": { "type": "number", "format": "double" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/PartnerDiscountGroup/{PartnerDiscountGroupNameId}/GetPageFromViewByPartnerDiscountGroupNameId": { "get": { "tags": [ "PartnerDiscountGroup" ], "summary": "PartnerDiscountGroup: GetPageFromViewByArticleId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDiscountGroup-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDiscountGroup_GetPageFromViewByArticleId_875C9D5E827A", "parameters": [ { "name": "PartnerDiscountGroupNameId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerDiscountGroup/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "PartnerDiscountGroup" ], "summary": "PartnerDiscountGroup: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDiscountGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDiscountGroup_GetPageByValue_AA115AFADB20", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerDiscountGroup/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "PartnerDiscountGroup" ], "summary": "PartnerDiscountGroup: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDiscountGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDiscountGroup_GetPageByValue2_1DF92A46C742", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerDiscountGroup/DeleteByFilter": { "post": { "tags": [ "PartnerDiscountGroup" ], "summary": "PartnerDiscountGroup: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDiscountGroup-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDiscountGroup_DeleteByFilter_013FC21D4E1E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/PartnerDiscountGroup/GetAllByValue": { "post": { "tags": [ "PartnerDiscountGroup" ], "summary": "PartnerDiscountGroup: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDiscountGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDiscountGroup_GetAllByValue_07159F1913B0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerDiscountGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerDiscountGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerDiscountGroup" } } } } } } }, "/api/PartnerDiscountGroup/GetAllGraphByValue": { "post": { "tags": [ "PartnerDiscountGroup" ], "summary": "PartnerDiscountGroup: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDiscountGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDiscountGroup_GetAllGraphByValue_F5D18B371E80", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerDiscountGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerDiscountGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerDiscountGroup" } } } } } } }, "/api/PartnerDiscountGroup/GetByValue": { "post": { "tags": [ "PartnerDiscountGroup" ], "summary": "PartnerDiscountGroup: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDiscountGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDiscountGroup_GetByValue_32F582BB65BA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDiscountGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDiscountGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDiscountGroup" } } } } } } }, "/api/PartnerDiscountGroup/GetLookup": { "post": { "tags": [ "PartnerDiscountGroup" ], "summary": "PartnerDiscountGroup: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDiscountGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDiscountGroup_GetLookup_724F8C0AEBEF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/PartnerDiscountGroup/GetLookupByValue": { "post": { "tags": [ "PartnerDiscountGroup" ], "summary": "PartnerDiscountGroup: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDiscountGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDiscountGroup_GetLookupByValue_6051CD968F1B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/PartnerDiscountGroup/Page": { "get": { "tags": [ "PartnerDiscountGroup" ], "summary": "PartnerDiscountGroup: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDiscountGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDiscountGroup_GetPage_2C5580F234EE", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerDiscountGroup/PageAsc": { "get": { "tags": [ "PartnerDiscountGroup" ], "summary": "PartnerDiscountGroup: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDiscountGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDiscountGroup_GetPageAsc_34B4F9C5346B", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerDiscountGroup/SearchByValue": { "post": { "tags": [ "PartnerDiscountGroup" ], "summary": "PartnerDiscountGroup: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDiscountGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDiscountGroup_SearchByValue_59E04A5E423A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerDiscountGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerDiscountGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerDiscountGroup" } } } } } } }, "/api/PartnerDiscountGroup/TryGetByValue": { "post": { "tags": [ "PartnerDiscountGroup" ], "summary": "PartnerDiscountGroup: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDiscountGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDiscountGroup_TryGetByValue_5820E2FAA320", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDiscountGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDiscountGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDiscountGroup" } } } } } } }, "/api/PartnerDiscountGroup/UpsertGraph": { "put": { "tags": [ "PartnerDiscountGroup" ], "summary": "PartnerDiscountGroup: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDiscountGroup-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDiscountGroup_UpsertGraph_D0841E0BCADB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDiscountGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDiscountGroup" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDiscountGroup" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDiscountGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDiscountGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDiscountGroup" } } } } } } }, "/api/PartnerDiscountGroup/UpsertGraphWithExtraFields": { "put": { "tags": [ "PartnerDiscountGroup" ], "summary": "PartnerDiscountGroup: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDiscountGroup-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDiscountGroup_UpsertGraphWithExtraFields_F5F532E5F6CB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerDiscountGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerDiscountGroup" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerDiscountGroup" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerDiscountGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerDiscountGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerDiscountGroup" } } } } } } }, "/api/PartnerDiscountGroupName": { "get": { "tags": [ "PartnerDiscountGroupName" ], "summary": "PartnerDiscountGroupName: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDiscountGroupName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDiscountGroupName_GetAll_D7C9C3CC199B", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerDiscountGroupName" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerDiscountGroupName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerDiscountGroupName" } } } } } }, "post": { "tags": [ "PartnerDiscountGroupName" ], "summary": "PartnerDiscountGroupName: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDiscountGroupName-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDiscountGroupName_Post_621065A07830", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDiscountGroupName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDiscountGroupName" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDiscountGroupName" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDiscountGroupName" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDiscountGroupName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDiscountGroupName" } } } } } }, "put": { "tags": [ "PartnerDiscountGroupName" ], "summary": "PartnerDiscountGroupName: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDiscountGroupName-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDiscountGroupName_Put_0BB5CDEEFF7B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDiscountGroupName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDiscountGroupName" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDiscountGroupName" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDiscountGroupName" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDiscountGroupName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDiscountGroupName" } } } } } } }, "/api/PartnerDiscountGroupName/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "PartnerDiscountGroupName" ], "summary": "PartnerDiscountGroupName: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDiscountGroupName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDiscountGroupName_GetPageByValue_64DBDB1E0D17", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerDiscountGroupName/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "PartnerDiscountGroupName" ], "summary": "PartnerDiscountGroupName: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDiscountGroupName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDiscountGroupName_GetPageByValue2_582795B096B4", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerDiscountGroupName/DeleteByFilter": { "post": { "tags": [ "PartnerDiscountGroupName" ], "summary": "PartnerDiscountGroupName: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDiscountGroupName-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDiscountGroupName_DeleteByFilter_B60E5C6AA204", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/PartnerDiscountGroupName/GetAllByValue": { "post": { "tags": [ "PartnerDiscountGroupName" ], "summary": "PartnerDiscountGroupName: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDiscountGroupName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDiscountGroupName_GetAllByValue_7879EBD25D46", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerDiscountGroupName" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerDiscountGroupName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerDiscountGroupName" } } } } } } }, "/api/PartnerDiscountGroupName/GetAllGraphByValue": { "post": { "tags": [ "PartnerDiscountGroupName" ], "summary": "PartnerDiscountGroupName: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDiscountGroupName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDiscountGroupName_GetAllGraphByValue_A099DFF06DA4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerDiscountGroupName" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerDiscountGroupName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerDiscountGroupName" } } } } } } }, "/api/PartnerDiscountGroupName/GetByValue": { "post": { "tags": [ "PartnerDiscountGroupName" ], "summary": "PartnerDiscountGroupName: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDiscountGroupName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDiscountGroupName_GetByValue_4CD3786E9A41", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDiscountGroupName" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDiscountGroupName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDiscountGroupName" } } } } } } }, "/api/PartnerDiscountGroupName/GetLookup": { "post": { "tags": [ "PartnerDiscountGroupName" ], "summary": "PartnerDiscountGroupName: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDiscountGroupName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDiscountGroupName_GetLookup_EC8D5303BAB6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/PartnerDiscountGroupName/GetLookupByValue": { "post": { "tags": [ "PartnerDiscountGroupName" ], "summary": "PartnerDiscountGroupName: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDiscountGroupName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDiscountGroupName_GetLookupByValue_3EF032CA7F9A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/PartnerDiscountGroupName/Page": { "get": { "tags": [ "PartnerDiscountGroupName" ], "summary": "PartnerDiscountGroupName: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDiscountGroupName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDiscountGroupName_GetPage_6ADCEB405EFA", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerDiscountGroupName/PageAsc": { "get": { "tags": [ "PartnerDiscountGroupName" ], "summary": "PartnerDiscountGroupName: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDiscountGroupName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDiscountGroupName_GetPageAsc_6B31DF2539E9", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerDiscountGroupName/SearchByValue": { "post": { "tags": [ "PartnerDiscountGroupName" ], "summary": "PartnerDiscountGroupName: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDiscountGroupName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDiscountGroupName_SearchByValue_F5C4DE645D80", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerDiscountGroupName" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerDiscountGroupName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerDiscountGroupName" } } } } } } }, "/api/PartnerDiscountGroupName/TryGetByValue": { "post": { "tags": [ "PartnerDiscountGroupName" ], "summary": "PartnerDiscountGroupName: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDiscountGroupName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDiscountGroupName_TryGetByValue_E56C1FD1C428", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDiscountGroupName" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDiscountGroupName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDiscountGroupName" } } } } } } }, "/api/PartnerDiscountGroupName/UpsertGraph": { "put": { "tags": [ "PartnerDiscountGroupName" ], "summary": "PartnerDiscountGroupName: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDiscountGroupName-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDiscountGroupName_UpsertGraph_0E12006FED1A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDiscountGroupName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDiscountGroupName" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDiscountGroupName" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDiscountGroupName" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDiscountGroupName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDiscountGroupName" } } } } } } }, "/api/PartnerDiscountGroupName/UpsertGraphWithExtraFields": { "put": { "tags": [ "PartnerDiscountGroupName" ], "summary": "PartnerDiscountGroupName: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerDiscountGroupName-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerDiscountGroupName_UpsertGraphWithExtraFields_BDA9D300946A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerDiscountGroupName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerDiscountGroupName" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerDiscountGroupName" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerDiscountGroupName" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerDiscountGroupName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerDiscountGroupName" } } } } } } }, "/api/PartnerGroup": { "get": { "tags": [ "PartnerGroup" ], "summary": "PartnerGroup: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerGroup_GetAll_881F16C17317", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerGroup" } } } } } }, "post": { "tags": [ "PartnerGroup" ], "summary": "PartnerGroup: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerGroup-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerGroup_Post_E52B3A9483E1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerGroup" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerGroup" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerGroup" } } } } } }, "put": { "tags": [ "PartnerGroup" ], "summary": "PartnerGroup: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerGroup-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerGroup_Put_2950D77E1581", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerGroup" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerGroup" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerGroup" } } } } } } }, "/api/PartnerGroup/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "PartnerGroup" ], "summary": "PartnerGroup: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerGroup_GetPageByValue_DF36EE2F3609", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerGroup/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "PartnerGroup" ], "summary": "PartnerGroup: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerGroup_GetPageByValue2_242355DC95A9", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerGroup/DeleteByFilter": { "post": { "tags": [ "PartnerGroup" ], "summary": "PartnerGroup: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerGroup-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerGroup_DeleteByFilter_5D071C6D5DF3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/PartnerGroup/GetAllByValue": { "post": { "tags": [ "PartnerGroup" ], "summary": "PartnerGroup: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerGroup_GetAllByValue_FF54AEF06609", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerGroup" } } } } } } }, "/api/PartnerGroup/GetAllGraphByValue": { "post": { "tags": [ "PartnerGroup" ], "summary": "PartnerGroup: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerGroup_GetAllGraphByValue_5561025677B2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerGroup" } } } } } } }, "/api/PartnerGroup/GetByValue": { "post": { "tags": [ "PartnerGroup" ], "summary": "PartnerGroup: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerGroup_GetByValue_97C93F054856", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerGroup" } } } } } } }, "/api/PartnerGroup/GetChildPartnerGroups/{ParentId}/{PartnerTypeId}": { "get": { "tags": [ "PartnerGroup" ], "summary": "PartnerGroup: GetChildPartnerGroups", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerGroup-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerGroup_GetChildPartnerGroups_57A70C49D34C", "parameters": [ { "name": "ParentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PartnerTypeId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerGroup" } } } } } } }, "/api/PartnerGroup/GetLookup": { "post": { "tags": [ "PartnerGroup" ], "summary": "PartnerGroup: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerGroup_GetLookup_C7E270932668", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/PartnerGroup/GetLookupByValue": { "post": { "tags": [ "PartnerGroup" ], "summary": "PartnerGroup: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerGroup_GetLookupByValue_3F9DC3C3E69E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/PartnerGroup/GetRootPartnerGroups/{PartnerTypeId}": { "get": { "tags": [ "PartnerGroup" ], "summary": "PartnerGroup: GetRootPartnerGroups", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerGroup-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerGroup_GetRootPartnerGroups_20D485D6F9CA", "parameters": [ { "name": "PartnerTypeId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerGroup" } } } } } } }, "/api/PartnerGroup/Page": { "get": { "tags": [ "PartnerGroup" ], "summary": "PartnerGroup: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerGroup_GetPage_7BA75BF68BF0", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerGroup/PageAsc": { "get": { "tags": [ "PartnerGroup" ], "summary": "PartnerGroup: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerGroup_GetPageAsc_239AE5DC6B84", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerGroup/PagePartnerGroupsByParent/{ParentId}/{IncludeSubNodes}/{TopParentsOnly}": { "get": { "tags": [ "PartnerGroup" ], "summary": "PartnerGroup: GetPagePartnerGroupsByParent", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerGroup-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerGroup_GetPagePartnerGroupsByParent_C6790C6F1FC8", "parameters": [ { "name": "ParentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "IncludeSubNodes", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "TopParentsOnly", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerGroup/SearchByValue": { "post": { "tags": [ "PartnerGroup" ], "summary": "PartnerGroup: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerGroup_SearchByValue_0A1A29D61BB8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerGroup" } } } } } } }, "/api/PartnerGroup/TryGetByValue": { "post": { "tags": [ "PartnerGroup" ], "summary": "PartnerGroup: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerGroup_TryGetByValue_8DE42C4575AE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerGroup" } } } } } } }, "/api/PartnerGroup/UpsertGraph": { "put": { "tags": [ "PartnerGroup" ], "summary": "PartnerGroup: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerGroup-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerGroup_UpsertGraph_B8853D53D4DD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerGroup" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerGroup" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerGroup" } } } } } } }, "/api/PartnerGroup/UpsertGraphWithExtraFields": { "put": { "tags": [ "PartnerGroup" ], "summary": "PartnerGroup: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerGroup-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerGroup_UpsertGraphWithExtraFields_CD18722C8DAC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerGroup" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerGroup" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerGroup" } } } } } } }, "/api/PartnerInfo": { "get": { "tags": [ "PartnerInfo" ], "summary": "PartnerInfo: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerInfo-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerInfo_GetAll_092D55542C05", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerInfo" } } } } } }, "post": { "tags": [ "PartnerInfo" ], "summary": "PartnerInfo: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerInfo-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerInfo_Post_A0AD776EDA6E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerInfo" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerInfo" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerInfo" } } } } } }, "put": { "tags": [ "PartnerInfo" ], "summary": "PartnerInfo: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerInfo-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerInfo_Put_C9BFCECD5D2F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerInfo" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerInfo" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerInfo" } } } } } } }, "/api/PartnerInfo/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "PartnerInfo" ], "summary": "PartnerInfo: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerInfo-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerInfo_GetPageByValue_832C752CCAB0", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerInfo/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "PartnerInfo" ], "summary": "PartnerInfo: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerInfo-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerInfo_GetPageByValue2_54B50D5A6E62", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerInfo/DeleteByFilter": { "post": { "tags": [ "PartnerInfo" ], "summary": "PartnerInfo: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerInfo-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerInfo_DeleteByFilter_1C67D14CFBC0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/PartnerInfo/GetAllByValue": { "post": { "tags": [ "PartnerInfo" ], "summary": "PartnerInfo: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerInfo-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerInfo_GetAllByValue_8141DB4B9F9E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerInfo" } } } } } } }, "/api/PartnerInfo/GetAllGraphByValue": { "post": { "tags": [ "PartnerInfo" ], "summary": "PartnerInfo: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerInfo-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerInfo_GetAllGraphByValue_052D06C9BF24", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerInfo" } } } } } } }, "/api/PartnerInfo/GetByValue": { "post": { "tags": [ "PartnerInfo" ], "summary": "PartnerInfo: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerInfo-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerInfo_GetByValue_AA3DA09075F4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerInfo" } } } } } } }, "/api/PartnerInfo/GetLookup": { "post": { "tags": [ "PartnerInfo" ], "summary": "PartnerInfo: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerInfo-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerInfo_GetLookup_BB04B8EF2380", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/PartnerInfo/GetLookupByValue": { "post": { "tags": [ "PartnerInfo" ], "summary": "PartnerInfo: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerInfo-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerInfo_GetLookupByValue_A82BC92AEEB0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/PartnerInfo/Page": { "get": { "tags": [ "PartnerInfo" ], "summary": "PartnerInfo: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerInfo-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerInfo_GetPage_58E59931F775", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerInfo/PageAsc": { "get": { "tags": [ "PartnerInfo" ], "summary": "PartnerInfo: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerInfo-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerInfo_GetPageAsc_C9E3EA4DF00E", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerInfo/SearchByValue": { "post": { "tags": [ "PartnerInfo" ], "summary": "PartnerInfo: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerInfo-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerInfo_SearchByValue_A38A90F34D86", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerInfo" } } } } } } }, "/api/PartnerInfo/TryGetByValue": { "post": { "tags": [ "PartnerInfo" ], "summary": "PartnerInfo: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerInfo-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerInfo_TryGetByValue_D4346D9EC0CE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerInfo" } } } } } } }, "/api/PartnerInfo/UpsertGraph": { "put": { "tags": [ "PartnerInfo" ], "summary": "PartnerInfo: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerInfo-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerInfo_UpsertGraph_161D58EECCCF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerInfo" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerInfo" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerInfo" } } } } } } }, "/api/PartnerInfo/UpsertGraphWithExtraFields": { "put": { "tags": [ "PartnerInfo" ], "summary": "PartnerInfo: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerInfo-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerInfo_UpsertGraphWithExtraFields_C91C69AA3608", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerInfo" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerInfo" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerInfo" } } } } } } }, "/api/PartnerPasskey": { "get": { "tags": [ "PartnerPasskey" ], "summary": "PartnerPasskey: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerPasskey-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerPasskey_GetAll_61650E7F68C3", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerPasskey" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerPasskey" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerPasskey" } } } } } }, "post": { "tags": [ "PartnerPasskey" ], "summary": "PartnerPasskey: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerPasskey-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerPasskey_Post_34826E6FD68B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerPasskey" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerPasskey" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerPasskey" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerPasskey" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerPasskey" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerPasskey" } } } } } }, "put": { "tags": [ "PartnerPasskey" ], "summary": "PartnerPasskey: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerPasskey-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerPasskey_Put_574173AD8AC2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerPasskey" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerPasskey" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerPasskey" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerPasskey" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerPasskey" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerPasskey" } } } } } } }, "/api/PartnerPasskey/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "PartnerPasskey" ], "summary": "PartnerPasskey: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerPasskey-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerPasskey_GetPageByValue_072D08708525", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerPasskey/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "PartnerPasskey" ], "summary": "PartnerPasskey: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerPasskey-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerPasskey_GetPageByValue2_C05217BA66F2", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerPasskey/DeleteByFilter": { "post": { "tags": [ "PartnerPasskey" ], "summary": "PartnerPasskey: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerPasskey-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerPasskey_DeleteByFilter_2C0386B0FFD3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/PartnerPasskey/FindByCredentialId": { "post": { "tags": [ "PartnerPasskey" ], "summary": "PartnerPasskey: FindByCredentialId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerPasskey-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerPasskey_FindByCredentialId_1AF007CF31AC", "requestBody": { "content": { "application/json": { "schema": { "type": "string", "format": "byte" } }, "text/json": { "schema": { "type": "string", "format": "byte" } }, "application/*+json": { "schema": { "type": "string", "format": "byte" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerPasskey" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerPasskey" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerPasskey" } } } } } } }, "/api/PartnerPasskey/FindPasskeyWithPartner": { "post": { "tags": [ "PartnerPasskey" ], "summary": "PartnerPasskey: FindPasskeyWithPartner", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerPasskey-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerPasskey_FindPasskeyWithPartner_B9B1620755DE", "requestBody": { "content": { "application/json": { "schema": { "type": "string", "format": "byte" } }, "text/json": { "schema": { "type": "string", "format": "byte" } }, "application/*+json": { "schema": { "type": "string", "format": "byte" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Server.Controllers.PasskeyWithPartnerResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Server.Controllers.PasskeyWithPartnerResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Server.Controllers.PasskeyWithPartnerResult" } } } } } } }, "/api/PartnerPasskey/GetAllByValue": { "post": { "tags": [ "PartnerPasskey" ], "summary": "PartnerPasskey: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerPasskey-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerPasskey_GetAllByValue_5D14025EAAA9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerPasskey" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerPasskey" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerPasskey" } } } } } } }, "/api/PartnerPasskey/GetAllGraphByValue": { "post": { "tags": [ "PartnerPasskey" ], "summary": "PartnerPasskey: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerPasskey-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerPasskey_GetAllGraphByValue_BA9EC1D52DA2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerPasskey" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerPasskey" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerPasskey" } } } } } } }, "/api/PartnerPasskey/GetByValue": { "post": { "tags": [ "PartnerPasskey" ], "summary": "PartnerPasskey: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerPasskey-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerPasskey_GetByValue_82F7B3A39B66", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerPasskey" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerPasskey" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerPasskey" } } } } } } }, "/api/PartnerPasskey/GetLookup": { "post": { "tags": [ "PartnerPasskey" ], "summary": "PartnerPasskey: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerPasskey-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerPasskey_GetLookup_882E4930161E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/PartnerPasskey/GetLookupByValue": { "post": { "tags": [ "PartnerPasskey" ], "summary": "PartnerPasskey: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerPasskey-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerPasskey_GetLookupByValue_75515F49C5C5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/PartnerPasskey/Page": { "get": { "tags": [ "PartnerPasskey" ], "summary": "PartnerPasskey: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerPasskey-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerPasskey_GetPage_163942AFBE5C", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerPasskey/PageAsc": { "get": { "tags": [ "PartnerPasskey" ], "summary": "PartnerPasskey: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerPasskey-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerPasskey_GetPageAsc_1C256F38C286", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerPasskey/RemoveByCredentialId": { "post": { "tags": [ "PartnerPasskey" ], "summary": "PartnerPasskey: RemoveByCredentialId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerPasskey-Delete.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerPasskey_RemoveByCredentialId_92CA35FB9091", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Server.Controllers.RemovePasskeyRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Server.Controllers.RemovePasskeyRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Server.Controllers.RemovePasskeyRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/PartnerPasskey/SearchByValue": { "post": { "tags": [ "PartnerPasskey" ], "summary": "PartnerPasskey: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerPasskey-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerPasskey_SearchByValue_9717ED2441AC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerPasskey" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerPasskey" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerPasskey" } } } } } } }, "/api/PartnerPasskey/TryGetByValue": { "post": { "tags": [ "PartnerPasskey" ], "summary": "PartnerPasskey: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerPasskey-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerPasskey_TryGetByValue_73D21BE6F615", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerPasskey" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerPasskey" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerPasskey" } } } } } } }, "/api/PartnerPasskey/UpsertGraph": { "put": { "tags": [ "PartnerPasskey" ], "summary": "PartnerPasskey: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerPasskey-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerPasskey_UpsertGraph_908D669AC4AA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerPasskey" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerPasskey" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerPasskey" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerPasskey" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerPasskey" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerPasskey" } } } } } } }, "/api/PartnerPasskey/UpsertGraphWithExtraFields": { "put": { "tags": [ "PartnerPasskey" ], "summary": "PartnerPasskey: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerPasskey-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerPasskey_UpsertGraphWithExtraFields_969EEEFA4A6D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerPasskey" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerPasskey" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerPasskey" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerPasskey" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerPasskey" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerPasskey" } } } } } } }, "/api/PartnerPaymentType": { "get": { "tags": [ "PartnerPaymentType" ], "summary": "PartnerPaymentType: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerPaymentType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerPaymentType_GetAll_BD87DFE4E056", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerPaymentType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerPaymentType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerPaymentType" } } } } } }, "post": { "tags": [ "PartnerPaymentType" ], "summary": "PartnerPaymentType: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerPaymentType-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerPaymentType_Post_8FC6CABD6A66", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerPaymentType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerPaymentType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerPaymentType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerPaymentType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerPaymentType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerPaymentType" } } } } } }, "put": { "tags": [ "PartnerPaymentType" ], "summary": "PartnerPaymentType: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerPaymentType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerPaymentType_Put_37CE8BD09E68", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerPaymentType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerPaymentType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerPaymentType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerPaymentType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerPaymentType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerPaymentType" } } } } } } }, "/api/PartnerPaymentType/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "PartnerPaymentType" ], "summary": "PartnerPaymentType: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerPaymentType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerPaymentType_GetPageByValue_ADE99AFF99F9", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerPaymentType/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "PartnerPaymentType" ], "summary": "PartnerPaymentType: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerPaymentType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerPaymentType_GetPageByValue2_ED9063D56F38", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerPaymentType/DeleteByFilter": { "post": { "tags": [ "PartnerPaymentType" ], "summary": "PartnerPaymentType: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerPaymentType-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerPaymentType_DeleteByFilter_4B468F245F80", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/PartnerPaymentType/GetAllByValue": { "post": { "tags": [ "PartnerPaymentType" ], "summary": "PartnerPaymentType: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerPaymentType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerPaymentType_GetAllByValue_E99B3DA2BF46", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerPaymentType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerPaymentType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerPaymentType" } } } } } } }, "/api/PartnerPaymentType/GetAllGraphByValue": { "post": { "tags": [ "PartnerPaymentType" ], "summary": "PartnerPaymentType: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerPaymentType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerPaymentType_GetAllGraphByValue_0404814155E3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerPaymentType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerPaymentType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerPaymentType" } } } } } } }, "/api/PartnerPaymentType/GetByValue": { "post": { "tags": [ "PartnerPaymentType" ], "summary": "PartnerPaymentType: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerPaymentType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerPaymentType_GetByValue_C25A052ECE5F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerPaymentType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerPaymentType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerPaymentType" } } } } } } }, "/api/PartnerPaymentType/GetLookup": { "post": { "tags": [ "PartnerPaymentType" ], "summary": "PartnerPaymentType: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerPaymentType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerPaymentType_GetLookup_518888DFB22E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/PartnerPaymentType/GetLookupByValue": { "post": { "tags": [ "PartnerPaymentType" ], "summary": "PartnerPaymentType: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerPaymentType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerPaymentType_GetLookupByValue_FC13FB8DC605", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/PartnerPaymentType/Page": { "get": { "tags": [ "PartnerPaymentType" ], "summary": "PartnerPaymentType: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerPaymentType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerPaymentType_GetPage_EDAF37D9191E", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerPaymentType/PageAsc": { "get": { "tags": [ "PartnerPaymentType" ], "summary": "PartnerPaymentType: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerPaymentType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerPaymentType_GetPageAsc_6905E4FCA2C0", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerPaymentType/SearchByValue": { "post": { "tags": [ "PartnerPaymentType" ], "summary": "PartnerPaymentType: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerPaymentType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerPaymentType_SearchByValue_849A8DEF9CE6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerPaymentType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerPaymentType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerPaymentType" } } } } } } }, "/api/PartnerPaymentType/TryGetByValue": { "post": { "tags": [ "PartnerPaymentType" ], "summary": "PartnerPaymentType: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerPaymentType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerPaymentType_TryGetByValue_CDB1A75175A3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerPaymentType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerPaymentType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerPaymentType" } } } } } } }, "/api/PartnerPaymentType/UpsertGraph": { "put": { "tags": [ "PartnerPaymentType" ], "summary": "PartnerPaymentType: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerPaymentType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerPaymentType_UpsertGraph_23C3FCE851A3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerPaymentType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerPaymentType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerPaymentType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerPaymentType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerPaymentType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerPaymentType" } } } } } } }, "/api/PartnerPaymentType/UpsertGraphWithExtraFields": { "put": { "tags": [ "PartnerPaymentType" ], "summary": "PartnerPaymentType: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerPaymentType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerPaymentType_UpsertGraphWithExtraFields_54F1390008B6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerPaymentType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerPaymentType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerPaymentType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerPaymentType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerPaymentType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerPaymentType" } } } } } } }, "/api/PartnerPicture": { "get": { "tags": [ "PartnerPicture" ], "summary": "PartnerPicture: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerPicture-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerPicture_GetAll_DFDA20F145DC", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerPicture" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerPicture" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerPicture" } } } } } }, "post": { "tags": [ "PartnerPicture" ], "summary": "PartnerPicture: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerPicture-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerPicture_Post_8F77114B7EDE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerPicture" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerPicture" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerPicture" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerPicture" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerPicture" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerPicture" } } } } } }, "put": { "tags": [ "PartnerPicture" ], "summary": "PartnerPicture: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerPicture-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerPicture_Put_94A9BDCCF27A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerPicture" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerPicture" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerPicture" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerPicture" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerPicture" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerPicture" } } } } } } }, "/api/PartnerPicture/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "PartnerPicture" ], "summary": "PartnerPicture: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerPicture-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerPicture_GetPageByValue_91267CAA6984", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerPicture/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "PartnerPicture" ], "summary": "PartnerPicture: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerPicture-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerPicture_GetPageByValue2_3834B0E92A33", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerPicture/DeleteByFilter": { "post": { "tags": [ "PartnerPicture" ], "summary": "PartnerPicture: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerPicture-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerPicture_DeleteByFilter_A261149EA644", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/PartnerPicture/GetAllByValue": { "post": { "tags": [ "PartnerPicture" ], "summary": "PartnerPicture: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerPicture-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerPicture_GetAllByValue_3BC7278D6CFE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerPicture" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerPicture" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerPicture" } } } } } } }, "/api/PartnerPicture/GetAllGraphByValue": { "post": { "tags": [ "PartnerPicture" ], "summary": "PartnerPicture: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerPicture-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerPicture_GetAllGraphByValue_9D1D1CA3AA70", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerPicture" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerPicture" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerPicture" } } } } } } }, "/api/PartnerPicture/GetByValue": { "post": { "tags": [ "PartnerPicture" ], "summary": "PartnerPicture: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerPicture-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerPicture_GetByValue_9B78811C98E2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerPicture" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerPicture" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerPicture" } } } } } } }, "/api/PartnerPicture/GetLookup": { "post": { "tags": [ "PartnerPicture" ], "summary": "PartnerPicture: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerPicture-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerPicture_GetLookup_B64F8FCC3999", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/PartnerPicture/GetLookupByValue": { "post": { "tags": [ "PartnerPicture" ], "summary": "PartnerPicture: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerPicture-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerPicture_GetLookupByValue_BB1A4C4E8C7A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/PartnerPicture/Page": { "get": { "tags": [ "PartnerPicture" ], "summary": "PartnerPicture: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerPicture-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerPicture_GetPage_2AADAD1441A5", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerPicture/PageAsc": { "get": { "tags": [ "PartnerPicture" ], "summary": "PartnerPicture: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerPicture-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerPicture_GetPageAsc_2959884E4A39", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerPicture/SearchByValue": { "post": { "tags": [ "PartnerPicture" ], "summary": "PartnerPicture: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerPicture-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerPicture_SearchByValue_C7566AC6E0D6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerPicture" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerPicture" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerPicture" } } } } } } }, "/api/PartnerPicture/TryGetByValue": { "post": { "tags": [ "PartnerPicture" ], "summary": "PartnerPicture: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerPicture-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerPicture_TryGetByValue_1437B73BD148", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerPicture" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerPicture" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerPicture" } } } } } } }, "/api/PartnerPicture/UpsertGraph": { "put": { "tags": [ "PartnerPicture" ], "summary": "PartnerPicture: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerPicture-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerPicture_UpsertGraph_6BCFD093587F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerPicture" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerPicture" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerPicture" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerPicture" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerPicture" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerPicture" } } } } } } }, "/api/PartnerPicture/UpsertGraphWithExtraFields": { "put": { "tags": [ "PartnerPicture" ], "summary": "PartnerPicture: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerPicture-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerPicture_UpsertGraphWithExtraFields_5B30B7416B4C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerPicture" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerPicture" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerPicture" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerPicture" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerPicture" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerPicture" } } } } } } }, "/api/PartnerPurchasePriceList": { "get": { "tags": [ "PartnerPurchasePriceList" ], "summary": "PartnerPurchasePriceList: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerPurchasePriceList-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerPurchasePriceList_GetAll_EA6C578362CF", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerPurchasePriceList" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerPurchasePriceList" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerPurchasePriceList" } } } } } }, "post": { "tags": [ "PartnerPurchasePriceList" ], "summary": "PartnerPurchasePriceList: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerPurchasePriceList-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerPurchasePriceList_Post_CC26FFE3A8B5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerPurchasePriceList" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerPurchasePriceList" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerPurchasePriceList" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerPurchasePriceList" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerPurchasePriceList" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerPurchasePriceList" } } } } } }, "put": { "tags": [ "PartnerPurchasePriceList" ], "summary": "PartnerPurchasePriceList: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerPurchasePriceList-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerPurchasePriceList_Put_DB9EB3BD4981", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerPurchasePriceList" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerPurchasePriceList" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerPurchasePriceList" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerPurchasePriceList" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerPurchasePriceList" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerPurchasePriceList" } } } } } } }, "/api/PartnerPurchasePriceList/{ArticleId}/GetPageByArticle": { "get": { "tags": [ "PartnerPurchasePriceList" ], "summary": "PartnerPurchasePriceList: GetPageByArticle", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerPurchasePriceList-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerPurchasePriceList_GetPageByArticle_826DF90189C8", "parameters": [ { "name": "ArticleId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerPurchasePriceList/{ArticleId}/PageFromViewByArticleId": { "get": { "tags": [ "PartnerPurchasePriceList" ], "summary": "PartnerPurchasePriceList: GetPageFromViewByArticleId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerPurchasePriceList-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerPurchasePriceList_GetPageFromViewByArticleId_D20FE711D7A7", "parameters": [ { "name": "ArticleId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerPurchasePriceList/{PartnerId}/PageFromViewByPartnerId": { "get": { "tags": [ "PartnerPurchasePriceList" ], "summary": "PartnerPurchasePriceList: GetPageFromViewByPartnerId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerPurchasePriceList-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerPurchasePriceList_GetPageFromViewByPartnerId_F9E1D0E4549B", "parameters": [ { "name": "PartnerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerPurchasePriceList/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "PartnerPurchasePriceList" ], "summary": "PartnerPurchasePriceList: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerPurchasePriceList-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerPurchasePriceList_GetPageByValue_FEF054E0C6A5", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerPurchasePriceList/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "PartnerPurchasePriceList" ], "summary": "PartnerPurchasePriceList: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerPurchasePriceList-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerPurchasePriceList_GetPageByValue2_3B9EE37BDB11", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerPurchasePriceList/DeleteByFilter": { "post": { "tags": [ "PartnerPurchasePriceList" ], "summary": "PartnerPurchasePriceList: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerPurchasePriceList-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerPurchasePriceList_DeleteByFilter_8677A51980AE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/PartnerPurchasePriceList/FullPage": { "get": { "tags": [ "PartnerPurchasePriceList" ], "summary": "PartnerPurchasePriceList: GetFullPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerPurchasePriceList-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerPurchasePriceList_GetFullPage_0C4D66DBF318", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerPurchasePriceList/GetAllByValue": { "post": { "tags": [ "PartnerPurchasePriceList" ], "summary": "PartnerPurchasePriceList: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerPurchasePriceList-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerPurchasePriceList_GetAllByValue_59673FF93526", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerPurchasePriceList" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerPurchasePriceList" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerPurchasePriceList" } } } } } } }, "/api/PartnerPurchasePriceList/GetAllGraphByValue": { "post": { "tags": [ "PartnerPurchasePriceList" ], "summary": "PartnerPurchasePriceList: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerPurchasePriceList-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerPurchasePriceList_GetAllGraphByValue_C8D01BF7973F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerPurchasePriceList" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerPurchasePriceList" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerPurchasePriceList" } } } } } } }, "/api/PartnerPurchasePriceList/GetByValue": { "post": { "tags": [ "PartnerPurchasePriceList" ], "summary": "PartnerPurchasePriceList: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerPurchasePriceList-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerPurchasePriceList_GetByValue_AA2B35F4D35C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerPurchasePriceList" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerPurchasePriceList" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerPurchasePriceList" } } } } } } }, "/api/PartnerPurchasePriceList/GetLookup": { "post": { "tags": [ "PartnerPurchasePriceList" ], "summary": "PartnerPurchasePriceList: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerPurchasePriceList-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerPurchasePriceList_GetLookup_E7DD11414896", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/PartnerPurchasePriceList/GetLookupByValue": { "post": { "tags": [ "PartnerPurchasePriceList" ], "summary": "PartnerPurchasePriceList: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerPurchasePriceList-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerPurchasePriceList_GetLookupByValue_B2D9515EEB5E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/PartnerPurchasePriceList/Page": { "get": { "tags": [ "PartnerPurchasePriceList" ], "summary": "PartnerPurchasePriceList: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerPurchasePriceList-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerPurchasePriceList_GetPage_6DD4E8F66741", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerPurchasePriceList/PageAsc": { "get": { "tags": [ "PartnerPurchasePriceList" ], "summary": "PartnerPurchasePriceList: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerPurchasePriceList-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerPurchasePriceList_GetPageAsc_84102498AE76", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerPurchasePriceList/SearchByValue": { "post": { "tags": [ "PartnerPurchasePriceList" ], "summary": "PartnerPurchasePriceList: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerPurchasePriceList-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerPurchasePriceList_SearchByValue_F31C17F85566", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerPurchasePriceList" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerPurchasePriceList" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerPurchasePriceList" } } } } } } }, "/api/PartnerPurchasePriceList/TryGetByValue": { "post": { "tags": [ "PartnerPurchasePriceList" ], "summary": "PartnerPurchasePriceList: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerPurchasePriceList-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerPurchasePriceList_TryGetByValue_FED275BE1701", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerPurchasePriceList" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerPurchasePriceList" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerPurchasePriceList" } } } } } } }, "/api/PartnerPurchasePriceList/UploadAndImport": { "post": { "tags": [ "PartnerPurchasePriceList" ], "summary": "PartnerPurchasePriceList: UploadAndImport", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerPurchasePriceList-Create.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerPurchasePriceList_UploadAndImport_A2D30E99D90F", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "fileChunk": { "type": "string", "format": "binary" } } }, "encoding": { "fileChunk": { "style": "form" } } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/PartnerPurchasePriceList/UpsertGraph": { "put": { "tags": [ "PartnerPurchasePriceList" ], "summary": "PartnerPurchasePriceList: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerPurchasePriceList-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerPurchasePriceList_UpsertGraph_77D8A47307F7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerPurchasePriceList" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerPurchasePriceList" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerPurchasePriceList" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerPurchasePriceList" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerPurchasePriceList" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerPurchasePriceList" } } } } } } }, "/api/PartnerPurchasePriceList/UpsertGraphWithExtraFields": { "put": { "tags": [ "PartnerPurchasePriceList" ], "summary": "PartnerPurchasePriceList: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerPurchasePriceList-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerPurchasePriceList_UpsertGraphWithExtraFields_4CB8E5897C92", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerPurchasePriceList" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerPurchasePriceList" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerPurchasePriceList" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerPurchasePriceList" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerPurchasePriceList" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerPurchasePriceList" } } } } } } }, "/api/PartnerTermsOfDelivery": { "get": { "tags": [ "PartnerTermsOfDelivery" ], "summary": "PartnerTermsOfDelivery: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerTermsOfDelivery-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerTermsOfDelivery_GetAll_DD5EC48111DD", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerTermsOfDelivery" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerTermsOfDelivery" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerTermsOfDelivery" } } } } } }, "post": { "tags": [ "PartnerTermsOfDelivery" ], "summary": "PartnerTermsOfDelivery: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerTermsOfDelivery-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerTermsOfDelivery_Post_267F903268FC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerTermsOfDelivery" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerTermsOfDelivery" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerTermsOfDelivery" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerTermsOfDelivery" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerTermsOfDelivery" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerTermsOfDelivery" } } } } } }, "put": { "tags": [ "PartnerTermsOfDelivery" ], "summary": "PartnerTermsOfDelivery: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerTermsOfDelivery-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerTermsOfDelivery_Put_D471756E7324", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerTermsOfDelivery" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerTermsOfDelivery" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerTermsOfDelivery" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerTermsOfDelivery" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerTermsOfDelivery" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerTermsOfDelivery" } } } } } } }, "/api/PartnerTermsOfDelivery/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "PartnerTermsOfDelivery" ], "summary": "PartnerTermsOfDelivery: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerTermsOfDelivery-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerTermsOfDelivery_GetPageByValue_7976354249E1", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerTermsOfDelivery/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "PartnerTermsOfDelivery" ], "summary": "PartnerTermsOfDelivery: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerTermsOfDelivery-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerTermsOfDelivery_GetPageByValue2_55888634C4BF", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerTermsOfDelivery/DeleteByFilter": { "post": { "tags": [ "PartnerTermsOfDelivery" ], "summary": "PartnerTermsOfDelivery: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerTermsOfDelivery-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerTermsOfDelivery_DeleteByFilter_3C410B05E98E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/PartnerTermsOfDelivery/GetAllByValue": { "post": { "tags": [ "PartnerTermsOfDelivery" ], "summary": "PartnerTermsOfDelivery: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerTermsOfDelivery-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerTermsOfDelivery_GetAllByValue_D264ADC001E2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerTermsOfDelivery" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerTermsOfDelivery" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerTermsOfDelivery" } } } } } } }, "/api/PartnerTermsOfDelivery/GetAllGraphByValue": { "post": { "tags": [ "PartnerTermsOfDelivery" ], "summary": "PartnerTermsOfDelivery: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerTermsOfDelivery-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerTermsOfDelivery_GetAllGraphByValue_2F1CAF62DADE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerTermsOfDelivery" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerTermsOfDelivery" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerTermsOfDelivery" } } } } } } }, "/api/PartnerTermsOfDelivery/GetByValue": { "post": { "tags": [ "PartnerTermsOfDelivery" ], "summary": "PartnerTermsOfDelivery: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerTermsOfDelivery-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerTermsOfDelivery_GetByValue_B4C740DCCEA7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerTermsOfDelivery" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerTermsOfDelivery" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerTermsOfDelivery" } } } } } } }, "/api/PartnerTermsOfDelivery/GetLookup": { "post": { "tags": [ "PartnerTermsOfDelivery" ], "summary": "PartnerTermsOfDelivery: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerTermsOfDelivery-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerTermsOfDelivery_GetLookup_FE234F84CC24", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/PartnerTermsOfDelivery/GetLookupByValue": { "post": { "tags": [ "PartnerTermsOfDelivery" ], "summary": "PartnerTermsOfDelivery: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerTermsOfDelivery-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerTermsOfDelivery_GetLookupByValue_AD3DFCB934CF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/PartnerTermsOfDelivery/Page": { "get": { "tags": [ "PartnerTermsOfDelivery" ], "summary": "PartnerTermsOfDelivery: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerTermsOfDelivery-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerTermsOfDelivery_GetPage_35DE5BBEC58B", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerTermsOfDelivery/PageAsc": { "get": { "tags": [ "PartnerTermsOfDelivery" ], "summary": "PartnerTermsOfDelivery: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerTermsOfDelivery-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerTermsOfDelivery_GetPageAsc_144CE4CB79DB", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerTermsOfDelivery/SearchByValue": { "post": { "tags": [ "PartnerTermsOfDelivery" ], "summary": "PartnerTermsOfDelivery: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerTermsOfDelivery-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerTermsOfDelivery_SearchByValue_F43EF02A3BB0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerTermsOfDelivery" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerTermsOfDelivery" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerTermsOfDelivery" } } } } } } }, "/api/PartnerTermsOfDelivery/TryGetByValue": { "post": { "tags": [ "PartnerTermsOfDelivery" ], "summary": "PartnerTermsOfDelivery: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerTermsOfDelivery-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerTermsOfDelivery_TryGetByValue_414D1D3429C6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerTermsOfDelivery" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerTermsOfDelivery" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerTermsOfDelivery" } } } } } } }, "/api/PartnerTermsOfDelivery/UpsertGraph": { "put": { "tags": [ "PartnerTermsOfDelivery" ], "summary": "PartnerTermsOfDelivery: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerTermsOfDelivery-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerTermsOfDelivery_UpsertGraph_1CD286293E42", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerTermsOfDelivery" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerTermsOfDelivery" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerTermsOfDelivery" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerTermsOfDelivery" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerTermsOfDelivery" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerTermsOfDelivery" } } } } } } }, "/api/PartnerTermsOfDelivery/UpsertGraphWithExtraFields": { "put": { "tags": [ "PartnerTermsOfDelivery" ], "summary": "PartnerTermsOfDelivery: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerTermsOfDelivery-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerTermsOfDelivery_UpsertGraphWithExtraFields_E018943DEE99", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerTermsOfDelivery" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerTermsOfDelivery" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerTermsOfDelivery" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerTermsOfDelivery" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerTermsOfDelivery" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerTermsOfDelivery" } } } } } } }, "/api/PartnerTermsOfPayment": { "get": { "tags": [ "PartnerTermsOfPayment" ], "summary": "PartnerTermsOfPayment: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerTermsOfPayment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerTermsOfPayment_GetAll_12903115AC42", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerTermsOfPayment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerTermsOfPayment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerTermsOfPayment" } } } } } }, "post": { "tags": [ "PartnerTermsOfPayment" ], "summary": "PartnerTermsOfPayment: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerTermsOfPayment-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerTermsOfPayment_Post_CD4C959CE56E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerTermsOfPayment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerTermsOfPayment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerTermsOfPayment" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerTermsOfPayment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerTermsOfPayment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerTermsOfPayment" } } } } } }, "put": { "tags": [ "PartnerTermsOfPayment" ], "summary": "PartnerTermsOfPayment: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerTermsOfPayment-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerTermsOfPayment_Put_466BA74029E0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerTermsOfPayment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerTermsOfPayment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerTermsOfPayment" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerTermsOfPayment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerTermsOfPayment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerTermsOfPayment" } } } } } } }, "/api/PartnerTermsOfPayment/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "PartnerTermsOfPayment" ], "summary": "PartnerTermsOfPayment: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerTermsOfPayment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerTermsOfPayment_GetPageByValue_984A86D32032", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerTermsOfPayment/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "PartnerTermsOfPayment" ], "summary": "PartnerTermsOfPayment: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerTermsOfPayment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerTermsOfPayment_GetPageByValue2_AD258979A18F", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerTermsOfPayment/DeleteByFilter": { "post": { "tags": [ "PartnerTermsOfPayment" ], "summary": "PartnerTermsOfPayment: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerTermsOfPayment-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerTermsOfPayment_DeleteByFilter_8FD689EE3ABA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/PartnerTermsOfPayment/GetAllByValue": { "post": { "tags": [ "PartnerTermsOfPayment" ], "summary": "PartnerTermsOfPayment: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerTermsOfPayment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerTermsOfPayment_GetAllByValue_CA3FF512CE1B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerTermsOfPayment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerTermsOfPayment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerTermsOfPayment" } } } } } } }, "/api/PartnerTermsOfPayment/GetAllGraphByValue": { "post": { "tags": [ "PartnerTermsOfPayment" ], "summary": "PartnerTermsOfPayment: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerTermsOfPayment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerTermsOfPayment_GetAllGraphByValue_B991C95DD6E3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerTermsOfPayment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerTermsOfPayment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerTermsOfPayment" } } } } } } }, "/api/PartnerTermsOfPayment/GetByValue": { "post": { "tags": [ "PartnerTermsOfPayment" ], "summary": "PartnerTermsOfPayment: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerTermsOfPayment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerTermsOfPayment_GetByValue_6CBD0BE510A9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerTermsOfPayment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerTermsOfPayment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerTermsOfPayment" } } } } } } }, "/api/PartnerTermsOfPayment/GetLookup": { "post": { "tags": [ "PartnerTermsOfPayment" ], "summary": "PartnerTermsOfPayment: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerTermsOfPayment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerTermsOfPayment_GetLookup_E21E396CF996", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/PartnerTermsOfPayment/GetLookupByValue": { "post": { "tags": [ "PartnerTermsOfPayment" ], "summary": "PartnerTermsOfPayment: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerTermsOfPayment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerTermsOfPayment_GetLookupByValue_96C99EFEDCF9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/PartnerTermsOfPayment/Page": { "get": { "tags": [ "PartnerTermsOfPayment" ], "summary": "PartnerTermsOfPayment: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerTermsOfPayment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerTermsOfPayment_GetPage_CE147BEBC46B", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerTermsOfPayment/PageAsc": { "get": { "tags": [ "PartnerTermsOfPayment" ], "summary": "PartnerTermsOfPayment: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerTermsOfPayment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerTermsOfPayment_GetPageAsc_0B3267A03FF1", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerTermsOfPayment/SearchByValue": { "post": { "tags": [ "PartnerTermsOfPayment" ], "summary": "PartnerTermsOfPayment: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerTermsOfPayment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerTermsOfPayment_SearchByValue_8E6B7E50F728", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerTermsOfPayment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerTermsOfPayment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerTermsOfPayment" } } } } } } }, "/api/PartnerTermsOfPayment/TryGetByValue": { "post": { "tags": [ "PartnerTermsOfPayment" ], "summary": "PartnerTermsOfPayment: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerTermsOfPayment-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerTermsOfPayment_TryGetByValue_C978929E9DEF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerTermsOfPayment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerTermsOfPayment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerTermsOfPayment" } } } } } } }, "/api/PartnerTermsOfPayment/UpsertGraph": { "put": { "tags": [ "PartnerTermsOfPayment" ], "summary": "PartnerTermsOfPayment: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerTermsOfPayment-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerTermsOfPayment_UpsertGraph_A308F58FFB5C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerTermsOfPayment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerTermsOfPayment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerTermsOfPayment" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerTermsOfPayment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerTermsOfPayment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerTermsOfPayment" } } } } } } }, "/api/PartnerTermsOfPayment/UpsertGraphWithExtraFields": { "put": { "tags": [ "PartnerTermsOfPayment" ], "summary": "PartnerTermsOfPayment: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerTermsOfPayment-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerTermsOfPayment_UpsertGraphWithExtraFields_871D5A7211A0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerTermsOfPayment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerTermsOfPayment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerTermsOfPayment" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerTermsOfPayment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerTermsOfPayment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerTermsOfPayment" } } } } } } }, "/api/PartnerTermsOfPaymentUNTDID": { "get": { "tags": [ "PartnerTermsOfPaymentUNTDID" ], "summary": "PartnerTermsOfPaymentUNTDID: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerTermsOfPaymentUNTDID-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerTermsOfPaymentUNTDID_GetAll_007108EA4FCA", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerTermsOfPaymentUNTDID" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerTermsOfPaymentUNTDID" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerTermsOfPaymentUNTDID" } } } } } }, "post": { "tags": [ "PartnerTermsOfPaymentUNTDID" ], "summary": "PartnerTermsOfPaymentUNTDID: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerTermsOfPaymentUNTDID-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerTermsOfPaymentUNTDID_Post_1785A6CDCF87", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerTermsOfPaymentUNTDID" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerTermsOfPaymentUNTDID" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerTermsOfPaymentUNTDID" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerTermsOfPaymentUNTDID" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerTermsOfPaymentUNTDID" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerTermsOfPaymentUNTDID" } } } } } }, "put": { "tags": [ "PartnerTermsOfPaymentUNTDID" ], "summary": "PartnerTermsOfPaymentUNTDID: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerTermsOfPaymentUNTDID-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerTermsOfPaymentUNTDID_Put_6E046FEE45E5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerTermsOfPaymentUNTDID" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerTermsOfPaymentUNTDID" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerTermsOfPaymentUNTDID" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerTermsOfPaymentUNTDID" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerTermsOfPaymentUNTDID" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerTermsOfPaymentUNTDID" } } } } } } }, "/api/PartnerTermsOfPaymentUNTDID/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "PartnerTermsOfPaymentUNTDID" ], "summary": "PartnerTermsOfPaymentUNTDID: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerTermsOfPaymentUNTDID-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerTermsOfPaymentUNTDID_GetPageByValue_17F2018006A6", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerTermsOfPaymentUNTDID/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "PartnerTermsOfPaymentUNTDID" ], "summary": "PartnerTermsOfPaymentUNTDID: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerTermsOfPaymentUNTDID-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerTermsOfPaymentUNTDID_GetPageByValue2_8BEB4F788654", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerTermsOfPaymentUNTDID/DeleteByFilter": { "post": { "tags": [ "PartnerTermsOfPaymentUNTDID" ], "summary": "PartnerTermsOfPaymentUNTDID: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerTermsOfPaymentUNTDID-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerTermsOfPaymentUNTDID_DeleteByFilter_903EA2B75CEC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/PartnerTermsOfPaymentUNTDID/GetAllByValue": { "post": { "tags": [ "PartnerTermsOfPaymentUNTDID" ], "summary": "PartnerTermsOfPaymentUNTDID: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerTermsOfPaymentUNTDID-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerTermsOfPaymentUNTDID_GetAllByValue_4B92BDBD6779", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerTermsOfPaymentUNTDID" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerTermsOfPaymentUNTDID" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerTermsOfPaymentUNTDID" } } } } } } }, "/api/PartnerTermsOfPaymentUNTDID/GetAllGraphByValue": { "post": { "tags": [ "PartnerTermsOfPaymentUNTDID" ], "summary": "PartnerTermsOfPaymentUNTDID: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerTermsOfPaymentUNTDID-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerTermsOfPaymentUNTDID_GetAllGraphByValue_2482FBBA56AD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerTermsOfPaymentUNTDID" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerTermsOfPaymentUNTDID" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerTermsOfPaymentUNTDID" } } } } } } }, "/api/PartnerTermsOfPaymentUNTDID/GetByValue": { "post": { "tags": [ "PartnerTermsOfPaymentUNTDID" ], "summary": "PartnerTermsOfPaymentUNTDID: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerTermsOfPaymentUNTDID-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerTermsOfPaymentUNTDID_GetByValue_CA4D89187E16", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerTermsOfPaymentUNTDID" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerTermsOfPaymentUNTDID" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerTermsOfPaymentUNTDID" } } } } } } }, "/api/PartnerTermsOfPaymentUNTDID/GetLookup": { "post": { "tags": [ "PartnerTermsOfPaymentUNTDID" ], "summary": "PartnerTermsOfPaymentUNTDID: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerTermsOfPaymentUNTDID-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerTermsOfPaymentUNTDID_GetLookup_9D3DAB302046", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/PartnerTermsOfPaymentUNTDID/GetLookupByValue": { "post": { "tags": [ "PartnerTermsOfPaymentUNTDID" ], "summary": "PartnerTermsOfPaymentUNTDID: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerTermsOfPaymentUNTDID-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerTermsOfPaymentUNTDID_GetLookupByValue_3A0284EFB317", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/PartnerTermsOfPaymentUNTDID/Page": { "get": { "tags": [ "PartnerTermsOfPaymentUNTDID" ], "summary": "PartnerTermsOfPaymentUNTDID: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerTermsOfPaymentUNTDID-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerTermsOfPaymentUNTDID_GetPage_99254E9F230A", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerTermsOfPaymentUNTDID/PageAsc": { "get": { "tags": [ "PartnerTermsOfPaymentUNTDID" ], "summary": "PartnerTermsOfPaymentUNTDID: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerTermsOfPaymentUNTDID-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerTermsOfPaymentUNTDID_GetPageAsc_918893BA22DA", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerTermsOfPaymentUNTDID/SearchByValue": { "post": { "tags": [ "PartnerTermsOfPaymentUNTDID" ], "summary": "PartnerTermsOfPaymentUNTDID: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerTermsOfPaymentUNTDID-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerTermsOfPaymentUNTDID_SearchByValue_34846CBFD142", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerTermsOfPaymentUNTDID" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerTermsOfPaymentUNTDID" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerTermsOfPaymentUNTDID" } } } } } } }, "/api/PartnerTermsOfPaymentUNTDID/TryGetByValue": { "post": { "tags": [ "PartnerTermsOfPaymentUNTDID" ], "summary": "PartnerTermsOfPaymentUNTDID: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerTermsOfPaymentUNTDID-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerTermsOfPaymentUNTDID_TryGetByValue_4D222A6DD9E2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerTermsOfPaymentUNTDID" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerTermsOfPaymentUNTDID" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerTermsOfPaymentUNTDID" } } } } } } }, "/api/PartnerTermsOfPaymentUNTDID/UpsertGraph": { "put": { "tags": [ "PartnerTermsOfPaymentUNTDID" ], "summary": "PartnerTermsOfPaymentUNTDID: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerTermsOfPaymentUNTDID-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerTermsOfPaymentUNTDID_UpsertGraph_EABDADC57939", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerTermsOfPaymentUNTDID" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerTermsOfPaymentUNTDID" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerTermsOfPaymentUNTDID" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerTermsOfPaymentUNTDID" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerTermsOfPaymentUNTDID" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerTermsOfPaymentUNTDID" } } } } } } }, "/api/PartnerTermsOfPaymentUNTDID/UpsertGraphWithExtraFields": { "put": { "tags": [ "PartnerTermsOfPaymentUNTDID" ], "summary": "PartnerTermsOfPaymentUNTDID: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerTermsOfPaymentUNTDID-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerTermsOfPaymentUNTDID_UpsertGraphWithExtraFields_87BA21B6ACA5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerTermsOfPaymentUNTDID" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerTermsOfPaymentUNTDID" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerTermsOfPaymentUNTDID" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerTermsOfPaymentUNTDID" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerTermsOfPaymentUNTDID" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerTermsOfPaymentUNTDID" } } } } } } }, "/api/PartnerToken": { "get": { "tags": [ "PartnerToken" ], "summary": "PartnerToken: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerToken-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerToken_GetAll_62BE088449F1", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerToken" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerToken" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerToken" } } } } } }, "post": { "tags": [ "PartnerToken" ], "summary": "PartnerToken: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerToken-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerToken_Post_6A8A8D0939ED", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerToken" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerToken" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerToken" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerToken" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerToken" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerToken" } } } } } }, "put": { "tags": [ "PartnerToken" ], "summary": "PartnerToken: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerToken-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerToken_Put_12BD198DC822", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerToken" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerToken" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerToken" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerToken" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerToken" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerToken" } } } } } } }, "/api/PartnerToken/{partnerId}/{loginProvider}/GetAllByProvider": { "get": { "tags": [ "PartnerToken" ], "summary": "PartnerToken: GetAllByProvider", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerToken-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerToken_GetAllByProvider_E95A2D3259C5", "parameters": [ { "name": "partnerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "loginProvider", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerToken" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerToken" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerToken" } } } } } } }, "/api/PartnerToken/{partnerId}/{loginProvider}/RemoveAllByProvider": { "delete": { "tags": [ "PartnerToken" ], "summary": "PartnerToken: RemoveAllByProvider", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerToken-Delete.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerToken_RemoveAllByProvider_A97973037B05", "parameters": [ { "name": "partnerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "loginProvider", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/PartnerToken/{partnerId}/GetActiveSessions": { "get": { "tags": [ "PartnerToken" ], "summary": "PartnerToken: GetActiveSessions", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerToken-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerToken_GetActiveSessions_7867EB7CFB40", "parameters": [ { "name": "partnerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Server.Controllers.PartnerSessionInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Server.Controllers.PartnerSessionInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Server.Controllers.PartnerSessionInfo" } } } } } } }, "/api/PartnerToken/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "PartnerToken" ], "summary": "PartnerToken: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerToken-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerToken_GetPageByValue_AEF1856898C1", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerToken/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "PartnerToken" ], "summary": "PartnerToken: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerToken-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerToken_GetPageByValue2_5D716D515F00", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerToken/CleanupExpiredSessions": { "post": { "tags": [ "PartnerToken" ], "summary": "PartnerToken: CleanupExpiredSessions", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerToken-Delete.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerToken_CleanupExpiredSessions_D04430F63352", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/PartnerToken/CreateSession": { "post": { "tags": [ "PartnerToken" ], "summary": "PartnerToken: CreateSession", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerToken-Create.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerToken_CreateSession_00AFFEC07323", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Server.Controllers.CreateSessionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Server.Controllers.CreateSessionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Server.Controllers.CreateSessionRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerToken" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerToken" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerToken" } } } } } } }, "/api/PartnerToken/DeleteByFilter": { "post": { "tags": [ "PartnerToken" ], "summary": "PartnerToken: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerToken-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerToken_DeleteByFilter_7DA12535AA3B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/PartnerToken/GetAllByValue": { "post": { "tags": [ "PartnerToken" ], "summary": "PartnerToken: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerToken-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerToken_GetAllByValue_91F88E992470", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerToken" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerToken" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerToken" } } } } } } }, "/api/PartnerToken/GetAllGraphByValue": { "post": { "tags": [ "PartnerToken" ], "summary": "PartnerToken: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerToken-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerToken_GetAllGraphByValue_AEAC7DCA13DC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerToken" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerToken" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerToken" } } } } } } }, "/api/PartnerToken/GetByCompositeKey": { "post": { "tags": [ "PartnerToken" ], "summary": "PartnerToken: GetByCompositeKey", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerToken-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerToken_GetByCompositeKey_A8A26B25F75E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Server.Controllers.PartnerTokenKeyRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Server.Controllers.PartnerTokenKeyRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Server.Controllers.PartnerTokenKeyRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerToken" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerToken" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerToken" } } } } } } }, "/api/PartnerToken/GetByValue": { "post": { "tags": [ "PartnerToken" ], "summary": "PartnerToken: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerToken-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerToken_GetByValue_93FED62CB35E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerToken" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerToken" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerToken" } } } } } } }, "/api/PartnerToken/GetLookup": { "post": { "tags": [ "PartnerToken" ], "summary": "PartnerToken: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerToken-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerToken_GetLookup_B31DC1FD3C86", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/PartnerToken/GetLookupByValue": { "post": { "tags": [ "PartnerToken" ], "summary": "PartnerToken: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerToken-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerToken_GetLookupByValue_927C09FF85DD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/PartnerToken/Page": { "get": { "tags": [ "PartnerToken" ], "summary": "PartnerToken: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerToken-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerToken_GetPage_120246E0C91D", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerToken/PageAsc": { "get": { "tags": [ "PartnerToken" ], "summary": "PartnerToken: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerToken-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerToken_GetPageAsc_262286812E37", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerToken/RemoveByCompositeKey": { "post": { "tags": [ "PartnerToken" ], "summary": "PartnerToken: RemoveByCompositeKey", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerToken-Delete.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerToken_RemoveByCompositeKey_7F201CEA89F7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Server.Controllers.PartnerTokenKeyRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Server.Controllers.PartnerTokenKeyRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Server.Controllers.PartnerTokenKeyRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/PartnerToken/RevokeAllSessions": { "post": { "tags": [ "PartnerToken" ], "summary": "PartnerToken: RevokeAllSessions", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerToken-Delete.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerToken_RevokeAllSessions_245A4C9E8CCE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Server.Controllers.RevokeAllSessionsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Server.Controllers.RevokeAllSessionsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Server.Controllers.RevokeAllSessionsRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/PartnerToken/RevokeSession": { "post": { "tags": [ "PartnerToken" ], "summary": "PartnerToken: RevokeSession", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerToken-Delete.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerToken_RevokeSession_1B668B696F8D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Server.Controllers.ValidateSessionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Server.Controllers.ValidateSessionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Server.Controllers.ValidateSessionRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/PartnerToken/SearchByValue": { "post": { "tags": [ "PartnerToken" ], "summary": "PartnerToken: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerToken-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerToken_SearchByValue_F664662AB72F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerToken" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerToken" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerToken" } } } } } } }, "/api/PartnerToken/SetToken": { "post": { "tags": [ "PartnerToken" ], "summary": "PartnerToken: SetToken", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerToken-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerToken_SetToken_0540214982E0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerToken" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerToken" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerToken" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerToken" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerToken" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerToken" } } } } } } }, "/api/PartnerToken/TryGetByValue": { "post": { "tags": [ "PartnerToken" ], "summary": "PartnerToken: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerToken-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerToken_TryGetByValue_044CC59F6421", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerToken" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerToken" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerToken" } } } } } } }, "/api/PartnerToken/UpsertGraph": { "put": { "tags": [ "PartnerToken" ], "summary": "PartnerToken: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerToken-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerToken_UpsertGraph_7C6A9A532C69", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerToken" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerToken" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerToken" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerToken" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerToken" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerToken" } } } } } } }, "/api/PartnerToken/UpsertGraphWithExtraFields": { "put": { "tags": [ "PartnerToken" ], "summary": "PartnerToken: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerToken-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerToken_UpsertGraphWithExtraFields_855BFE28DA91", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerToken" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerToken" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerToken" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerToken" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerToken" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerToken" } } } } } } }, "/api/PartnerToken/ValidateSession": { "post": { "tags": [ "PartnerToken" ], "summary": "PartnerToken: ValidateSession", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerToken-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerToken_ValidateSession_1C7D9D8F4D67", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Server.Controllers.ValidateSessionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Server.Controllers.ValidateSessionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Server.Controllers.ValidateSessionRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerToken" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerToken" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerToken" } } } } } } }, "/api/PartnerType": { "get": { "tags": [ "PartnerType" ], "summary": "PartnerType: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerType_GetAll_56DDAAC4BBE5", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerType" } } } } } }, "post": { "tags": [ "PartnerType" ], "summary": "PartnerType: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerType-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerType_Post_B444378424C8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerType" } } } } } }, "put": { "tags": [ "PartnerType" ], "summary": "PartnerType: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerType_Put_CF7B5E6AADFB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerType" } } } } } } }, "/api/PartnerType/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "PartnerType" ], "summary": "PartnerType: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerType_GetPageByValue_A6751749E246", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerType/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "PartnerType" ], "summary": "PartnerType: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerType_GetPageByValue2_EA1C4E16302B", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerType/DeleteByFilter": { "post": { "tags": [ "PartnerType" ], "summary": "PartnerType: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerType-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerType_DeleteByFilter_5E31584E6435", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/PartnerType/GetAllByValue": { "post": { "tags": [ "PartnerType" ], "summary": "PartnerType: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerType_GetAllByValue_916FDB9D6BC4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerType" } } } } } } }, "/api/PartnerType/GetAllGraphByValue": { "post": { "tags": [ "PartnerType" ], "summary": "PartnerType: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerType_GetAllGraphByValue_C56FC76750B3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerType" } } } } } } }, "/api/PartnerType/GetByValue": { "post": { "tags": [ "PartnerType" ], "summary": "PartnerType: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerType_GetByValue_687C93AD4F24", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerType" } } } } } } }, "/api/PartnerType/GetLookup": { "post": { "tags": [ "PartnerType" ], "summary": "PartnerType: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerType_GetLookup_CDB290F68080", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/PartnerType/GetLookupByValue": { "post": { "tags": [ "PartnerType" ], "summary": "PartnerType: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerType_GetLookupByValue_C52CF8534EEA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/PartnerType/Page": { "get": { "tags": [ "PartnerType" ], "summary": "PartnerType: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerType_GetPage_66A63D56E4E3", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerType/PageAsc": { "get": { "tags": [ "PartnerType" ], "summary": "PartnerType: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerType_GetPageAsc_776EB22653C3", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PartnerType/SearchByValue": { "post": { "tags": [ "PartnerType" ], "summary": "PartnerType: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerType_SearchByValue_62F3CB4C3FCA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerType" } } } } } } }, "/api/PartnerType/TryGetByValue": { "post": { "tags": [ "PartnerType" ], "summary": "PartnerType: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerType_TryGetByValue_1ECA5D5D97F5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerType" } } } } } } }, "/api/PartnerType/UpsertGraph": { "put": { "tags": [ "PartnerType" ], "summary": "PartnerType: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerType_UpsertGraph_3EE80D43587A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerType" } } } } } } }, "/api/PartnerType/UpsertGraphWithExtraFields": { "put": { "tags": [ "PartnerType" ], "summary": "PartnerType: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PartnerType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PartnerType_UpsertGraphWithExtraFields_4359201D23C4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerType" } } } } } } }, "/api/PhoneCall": { "get": { "tags": [ "PhoneCall" ], "summary": "PhoneCall: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PhoneCall-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PhoneCall_GetAll_D0619E129264", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PhoneCall" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PhoneCall" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PhoneCall" } } } } } }, "post": { "tags": [ "PhoneCall" ], "summary": "PhoneCall: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PhoneCall-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PhoneCall_Post_0B03CFD472B2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PhoneCall" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PhoneCall" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PhoneCall" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PhoneCall" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PhoneCall" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PhoneCall" } } } } } }, "put": { "tags": [ "PhoneCall" ], "summary": "PhoneCall: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PhoneCall-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PhoneCall_Put_12E461423A92", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PhoneCall" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PhoneCall" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PhoneCall" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PhoneCall" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PhoneCall" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PhoneCall" } } } } } } }, "/api/PhoneCall/{NewFolder}/ChangeFolder": { "post": { "tags": [ "PhoneCall" ], "summary": "PhoneCall: ChangeFolder", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PhoneCall-Create.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PhoneCall_ChangeFolder_620844FFCBF2", "parameters": [ { "name": "NewFolder", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/X_ERP_Common.PhoneFolderIds" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/PhoneCall/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "PhoneCall" ], "summary": "PhoneCall: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PhoneCall-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PhoneCall_GetPageByValue_1033EAB2AD9B", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PhoneCall/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "PhoneCall" ], "summary": "PhoneCall: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PhoneCall-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PhoneCall_GetPageByValue2_782C7852E21E", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PhoneCall/DeleteByFilter": { "post": { "tags": [ "PhoneCall" ], "summary": "PhoneCall: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PhoneCall-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PhoneCall_DeleteByFilter_0F676E1396B8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/PhoneCall/GetAllByValue": { "post": { "tags": [ "PhoneCall" ], "summary": "PhoneCall: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PhoneCall-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PhoneCall_GetAllByValue_934EA9568E02", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PhoneCall" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PhoneCall" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PhoneCall" } } } } } } }, "/api/PhoneCall/GetAllGraphByValue": { "post": { "tags": [ "PhoneCall" ], "summary": "PhoneCall: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PhoneCall-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PhoneCall_GetAllGraphByValue_426EDA3D1AD2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PhoneCall" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PhoneCall" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PhoneCall" } } } } } } }, "/api/PhoneCall/GetByValue": { "post": { "tags": [ "PhoneCall" ], "summary": "PhoneCall: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PhoneCall-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PhoneCall_GetByValue_38E12152A7FD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PhoneCall" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PhoneCall" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PhoneCall" } } } } } } }, "/api/PhoneCall/GetLookup": { "post": { "tags": [ "PhoneCall" ], "summary": "PhoneCall: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PhoneCall-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PhoneCall_GetLookup_8BD798AC8AC7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/PhoneCall/GetLookupByValue": { "post": { "tags": [ "PhoneCall" ], "summary": "PhoneCall: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PhoneCall-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PhoneCall_GetLookupByValue_A6C6BE008DB3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/PhoneCall/Page": { "get": { "tags": [ "PhoneCall" ], "summary": "PhoneCall: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PhoneCall-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PhoneCall_GetPage_44D008DDD8F8", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PhoneCall/PageAsc": { "get": { "tags": [ "PhoneCall" ], "summary": "PhoneCall: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PhoneCall-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PhoneCall_GetPageAsc_5D8772EC7FE9", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PhoneCall/PageByIncoming/{incoming}": { "get": { "tags": [ "PhoneCall" ], "summary": "PhoneCall: GetPageByIncoming", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PhoneCall-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PhoneCall_GetPageByIncoming_3D6DBCC6D181", "parameters": [ { "name": "incoming", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PhoneCall/PagePhoneCallsByFolder/{FolderId}/{IncludeSubFolders}": { "get": { "tags": [ "PhoneCall" ], "summary": "PhoneCall: GetPagePhoneCallsByFolder", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PhoneCall-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PhoneCall_GetPagePhoneCallsByFolder_0240DBF84B1A", "parameters": [ { "name": "FolderId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "IncludeSubFolders", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PhoneCall/SearchByValue": { "post": { "tags": [ "PhoneCall" ], "summary": "PhoneCall: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PhoneCall-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PhoneCall_SearchByValue_D6BBC2F0A6EF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PhoneCall" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PhoneCall" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PhoneCall" } } } } } } }, "/api/PhoneCall/TryGetByValue": { "post": { "tags": [ "PhoneCall" ], "summary": "PhoneCall: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PhoneCall-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PhoneCall_TryGetByValue_E93D89548CA1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PhoneCall" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PhoneCall" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PhoneCall" } } } } } } }, "/api/PhoneCall/UpsertGraph": { "put": { "tags": [ "PhoneCall" ], "summary": "PhoneCall: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PhoneCall-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PhoneCall_UpsertGraph_A2E555CEAFCD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PhoneCall" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PhoneCall" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PhoneCall" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PhoneCall" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PhoneCall" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PhoneCall" } } } } } } }, "/api/PhoneCall/UpsertGraphWithExtraFields": { "put": { "tags": [ "PhoneCall" ], "summary": "PhoneCall: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PhoneCall-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PhoneCall_UpsertGraphWithExtraFields_A1DCADDFB787", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PhoneCall" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PhoneCall" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PhoneCall" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PhoneCall" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PhoneCall" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PhoneCall" } } } } } } }, "/api/PhoneFolder": { "get": { "tags": [ "PhoneFolder" ], "summary": "PhoneFolder: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PhoneFolder-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PhoneFolder_GetAll_5D263568F848", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PhoneFolder" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PhoneFolder" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PhoneFolder" } } } } } }, "post": { "tags": [ "PhoneFolder" ], "summary": "PhoneFolder: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PhoneFolder-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PhoneFolder_Post_F9877245C7BF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PhoneFolder" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PhoneFolder" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PhoneFolder" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PhoneFolder" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PhoneFolder" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PhoneFolder" } } } } } }, "put": { "tags": [ "PhoneFolder" ], "summary": "PhoneFolder: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PhoneFolder-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PhoneFolder_Put_3B7888B3823C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PhoneFolder" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PhoneFolder" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PhoneFolder" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PhoneFolder" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PhoneFolder" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PhoneFolder" } } } } } } }, "/api/PhoneFolder/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "PhoneFolder" ], "summary": "PhoneFolder: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PhoneFolder-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PhoneFolder_GetPageByValue_D5736386D860", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PhoneFolder/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "PhoneFolder" ], "summary": "PhoneFolder: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PhoneFolder-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PhoneFolder_GetPageByValue2_721DEECE7B29", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PhoneFolder/DeleteByFilter": { "post": { "tags": [ "PhoneFolder" ], "summary": "PhoneFolder: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PhoneFolder-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PhoneFolder_DeleteByFilter_6E7BE2C3BE03", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/PhoneFolder/GetAllByValue": { "post": { "tags": [ "PhoneFolder" ], "summary": "PhoneFolder: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PhoneFolder-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PhoneFolder_GetAllByValue_F8126D4612D3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PhoneFolder" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PhoneFolder" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PhoneFolder" } } } } } } }, "/api/PhoneFolder/GetAllGraphByValue": { "post": { "tags": [ "PhoneFolder" ], "summary": "PhoneFolder: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PhoneFolder-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PhoneFolder_GetAllGraphByValue_02E126B337B7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PhoneFolder" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PhoneFolder" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PhoneFolder" } } } } } } }, "/api/PhoneFolder/GetByValue": { "post": { "tags": [ "PhoneFolder" ], "summary": "PhoneFolder: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PhoneFolder-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PhoneFolder_GetByValue_5BC85838F71A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PhoneFolder" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PhoneFolder" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PhoneFolder" } } } } } } }, "/api/PhoneFolder/GetLookup": { "post": { "tags": [ "PhoneFolder" ], "summary": "PhoneFolder: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PhoneFolder-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PhoneFolder_GetLookup_D13135A3A3E4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/PhoneFolder/GetLookupByValue": { "post": { "tags": [ "PhoneFolder" ], "summary": "PhoneFolder: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PhoneFolder-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PhoneFolder_GetLookupByValue_0732CCC8F19E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/PhoneFolder/Page": { "get": { "tags": [ "PhoneFolder" ], "summary": "PhoneFolder: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PhoneFolder-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PhoneFolder_GetPage_3CA500BA850B", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PhoneFolder/PageAsc": { "get": { "tags": [ "PhoneFolder" ], "summary": "PhoneFolder: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PhoneFolder-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PhoneFolder_GetPageAsc_98395F5F86A9", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PhoneFolder/SearchByValue": { "post": { "tags": [ "PhoneFolder" ], "summary": "PhoneFolder: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PhoneFolder-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PhoneFolder_SearchByValue_1B4FC04B82C3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PhoneFolder" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PhoneFolder" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PhoneFolder" } } } } } } }, "/api/PhoneFolder/TryGetByValue": { "post": { "tags": [ "PhoneFolder" ], "summary": "PhoneFolder: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PhoneFolder-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PhoneFolder_TryGetByValue_243817C39C1D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PhoneFolder" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PhoneFolder" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PhoneFolder" } } } } } } }, "/api/PhoneFolder/UpsertGraph": { "put": { "tags": [ "PhoneFolder" ], "summary": "PhoneFolder: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PhoneFolder-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PhoneFolder_UpsertGraph_092AAD3077C1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PhoneFolder" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PhoneFolder" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PhoneFolder" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PhoneFolder" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PhoneFolder" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PhoneFolder" } } } } } } }, "/api/PhoneFolder/UpsertGraphWithExtraFields": { "put": { "tags": [ "PhoneFolder" ], "summary": "PhoneFolder: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PhoneFolder-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PhoneFolder_UpsertGraphWithExtraFields_40889AC898D5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PhoneFolder" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PhoneFolder" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PhoneFolder" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PhoneFolder" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PhoneFolder" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PhoneFolder" } } } } } } }, "/api/PhoneLine": { "get": { "tags": [ "PhoneLine" ], "summary": "PhoneLine: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PhoneLine-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PhoneLine_GetAll_E84E553C4C89", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PhoneLine" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PhoneLine" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PhoneLine" } } } } } }, "post": { "tags": [ "PhoneLine" ], "summary": "PhoneLine: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PhoneLine-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PhoneLine_Post_C67DC4EB6EA8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PhoneLine" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PhoneLine" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PhoneLine" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PhoneLine" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PhoneLine" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PhoneLine" } } } } } }, "put": { "tags": [ "PhoneLine" ], "summary": "PhoneLine: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PhoneLine-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PhoneLine_Put_D9826BE34953", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PhoneLine" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PhoneLine" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PhoneLine" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PhoneLine" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PhoneLine" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PhoneLine" } } } } } } }, "/api/PhoneLine/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "PhoneLine" ], "summary": "PhoneLine: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PhoneLine-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PhoneLine_GetPageByValue_FA186CA241BE", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PhoneLine/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "PhoneLine" ], "summary": "PhoneLine: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PhoneLine-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PhoneLine_GetPageByValue2_CADFCE8B3354", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PhoneLine/DeleteByFilter": { "post": { "tags": [ "PhoneLine" ], "summary": "PhoneLine: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PhoneLine-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PhoneLine_DeleteByFilter_139EF47D56AD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/PhoneLine/GetAllByValue": { "post": { "tags": [ "PhoneLine" ], "summary": "PhoneLine: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PhoneLine-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PhoneLine_GetAllByValue_B6A9EEFE1DB2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PhoneLine" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PhoneLine" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PhoneLine" } } } } } } }, "/api/PhoneLine/GetAllGraphByValue": { "post": { "tags": [ "PhoneLine" ], "summary": "PhoneLine: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PhoneLine-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PhoneLine_GetAllGraphByValue_A0177FFA99D4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PhoneLine" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PhoneLine" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PhoneLine" } } } } } } }, "/api/PhoneLine/GetByValue": { "post": { "tags": [ "PhoneLine" ], "summary": "PhoneLine: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PhoneLine-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PhoneLine_GetByValue_0250D82699AC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PhoneLine" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PhoneLine" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PhoneLine" } } } } } } }, "/api/PhoneLine/GetLookup": { "post": { "tags": [ "PhoneLine" ], "summary": "PhoneLine: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PhoneLine-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PhoneLine_GetLookup_15FBFBC8BACE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/PhoneLine/GetLookupByValue": { "post": { "tags": [ "PhoneLine" ], "summary": "PhoneLine: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PhoneLine-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PhoneLine_GetLookupByValue_0A7B0075328A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/PhoneLine/Page": { "get": { "tags": [ "PhoneLine" ], "summary": "PhoneLine: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PhoneLine-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PhoneLine_GetPage_F0C10C5D44CC", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PhoneLine/PageAsc": { "get": { "tags": [ "PhoneLine" ], "summary": "PhoneLine: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PhoneLine-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PhoneLine_GetPageAsc_5A8BA84BD54D", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PhoneLine/SearchByValue": { "post": { "tags": [ "PhoneLine" ], "summary": "PhoneLine: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PhoneLine-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PhoneLine_SearchByValue_49AC162601C1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PhoneLine" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PhoneLine" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PhoneLine" } } } } } } }, "/api/PhoneLine/TryGetByValue": { "post": { "tags": [ "PhoneLine" ], "summary": "PhoneLine: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PhoneLine-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PhoneLine_TryGetByValue_E1EC57D223AD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PhoneLine" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PhoneLine" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PhoneLine" } } } } } } }, "/api/PhoneLine/UpsertGraph": { "put": { "tags": [ "PhoneLine" ], "summary": "PhoneLine: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PhoneLine-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PhoneLine_UpsertGraph_955EFA112DC7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PhoneLine" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PhoneLine" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PhoneLine" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PhoneLine" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PhoneLine" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PhoneLine" } } } } } } }, "/api/PhoneLine/UpsertGraphWithExtraFields": { "put": { "tags": [ "PhoneLine" ], "summary": "PhoneLine: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PhoneLine-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PhoneLine_UpsertGraphWithExtraFields_4F31E9302F1A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PhoneLine" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PhoneLine" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PhoneLine" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PhoneLine" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PhoneLine" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PhoneLine" } } } } } } }, "/api/PhoneLineEmployee": { "get": { "tags": [ "PhoneLineEmployee" ], "summary": "PhoneLineEmployee: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PhoneLineEmployee-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PhoneLineEmployee_GetAll_2F1E40C34D7B", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PhoneLineEmployee" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PhoneLineEmployee" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PhoneLineEmployee" } } } } } }, "post": { "tags": [ "PhoneLineEmployee" ], "summary": "PhoneLineEmployee: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PhoneLineEmployee-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PhoneLineEmployee_Post_7421A9377E94", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PhoneLineEmployee" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PhoneLineEmployee" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PhoneLineEmployee" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PhoneLineEmployee" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PhoneLineEmployee" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PhoneLineEmployee" } } } } } }, "put": { "tags": [ "PhoneLineEmployee" ], "summary": "PhoneLineEmployee: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PhoneLineEmployee-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PhoneLineEmployee_Put_B0B2A5C72AC2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PhoneLineEmployee" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PhoneLineEmployee" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PhoneLineEmployee" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PhoneLineEmployee" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PhoneLineEmployee" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PhoneLineEmployee" } } } } } } }, "/api/PhoneLineEmployee/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "PhoneLineEmployee" ], "summary": "PhoneLineEmployee: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PhoneLineEmployee-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PhoneLineEmployee_GetPageByValue_A15BCA9201AA", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PhoneLineEmployee/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "PhoneLineEmployee" ], "summary": "PhoneLineEmployee: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PhoneLineEmployee-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PhoneLineEmployee_GetPageByValue2_7333B002ECA8", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PhoneLineEmployee/DeleteByFilter": { "post": { "tags": [ "PhoneLineEmployee" ], "summary": "PhoneLineEmployee: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PhoneLineEmployee-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PhoneLineEmployee_DeleteByFilter_B8AC02BF50B6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/PhoneLineEmployee/GetAllByValue": { "post": { "tags": [ "PhoneLineEmployee" ], "summary": "PhoneLineEmployee: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PhoneLineEmployee-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PhoneLineEmployee_GetAllByValue_E66583BB0024", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PhoneLineEmployee" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PhoneLineEmployee" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PhoneLineEmployee" } } } } } } }, "/api/PhoneLineEmployee/GetAllGraphByValue": { "post": { "tags": [ "PhoneLineEmployee" ], "summary": "PhoneLineEmployee: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PhoneLineEmployee-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PhoneLineEmployee_GetAllGraphByValue_281E65CE5EE2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PhoneLineEmployee" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PhoneLineEmployee" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PhoneLineEmployee" } } } } } } }, "/api/PhoneLineEmployee/GetByValue": { "post": { "tags": [ "PhoneLineEmployee" ], "summary": "PhoneLineEmployee: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PhoneLineEmployee-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PhoneLineEmployee_GetByValue_880572F2D118", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PhoneLineEmployee" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PhoneLineEmployee" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PhoneLineEmployee" } } } } } } }, "/api/PhoneLineEmployee/GetLookup": { "post": { "tags": [ "PhoneLineEmployee" ], "summary": "PhoneLineEmployee: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PhoneLineEmployee-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PhoneLineEmployee_GetLookup_E56CD2CF9ABA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/PhoneLineEmployee/GetLookupByValue": { "post": { "tags": [ "PhoneLineEmployee" ], "summary": "PhoneLineEmployee: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PhoneLineEmployee-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PhoneLineEmployee_GetLookupByValue_CC129F51536D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/PhoneLineEmployee/Page": { "get": { "tags": [ "PhoneLineEmployee" ], "summary": "PhoneLineEmployee: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PhoneLineEmployee-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PhoneLineEmployee_GetPage_5DEEBD654338", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PhoneLineEmployee/PageAsc": { "get": { "tags": [ "PhoneLineEmployee" ], "summary": "PhoneLineEmployee: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PhoneLineEmployee-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PhoneLineEmployee_GetPageAsc_52100B9CF068", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PhoneLineEmployee/SearchByValue": { "post": { "tags": [ "PhoneLineEmployee" ], "summary": "PhoneLineEmployee: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PhoneLineEmployee-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PhoneLineEmployee_SearchByValue_634F70603397", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PhoneLineEmployee" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PhoneLineEmployee" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PhoneLineEmployee" } } } } } } }, "/api/PhoneLineEmployee/TryGetByValue": { "post": { "tags": [ "PhoneLineEmployee" ], "summary": "PhoneLineEmployee: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PhoneLineEmployee-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PhoneLineEmployee_TryGetByValue_E25BD30A319D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PhoneLineEmployee" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PhoneLineEmployee" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PhoneLineEmployee" } } } } } } }, "/api/PhoneLineEmployee/UpsertGraph": { "put": { "tags": [ "PhoneLineEmployee" ], "summary": "PhoneLineEmployee: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PhoneLineEmployee-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PhoneLineEmployee_UpsertGraph_455C34489E25", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PhoneLineEmployee" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PhoneLineEmployee" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PhoneLineEmployee" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PhoneLineEmployee" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PhoneLineEmployee" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PhoneLineEmployee" } } } } } } }, "/api/PhoneLineEmployee/UpsertGraphWithExtraFields": { "put": { "tags": [ "PhoneLineEmployee" ], "summary": "PhoneLineEmployee: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PhoneLineEmployee-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PhoneLineEmployee_UpsertGraphWithExtraFields_76024179F271", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PhoneLineEmployee" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PhoneLineEmployee" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PhoneLineEmployee" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PhoneLineEmployee" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PhoneLineEmployee" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PhoneLineEmployee" } } } } } } }, "/api/PhoneLog": { "get": { "tags": [ "PhoneLog" ], "summary": "PhoneLog: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PhoneLog-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PhoneLog_GetAll_AFF1B34C6C01", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PhoneLog" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PhoneLog" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PhoneLog" } } } } } }, "post": { "tags": [ "PhoneLog" ], "summary": "PhoneLog: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PhoneLog-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PhoneLog_Post_3F46DB501DA1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PhoneLog" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PhoneLog" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PhoneLog" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PhoneLog" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PhoneLog" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PhoneLog" } } } } } }, "put": { "tags": [ "PhoneLog" ], "summary": "PhoneLog: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PhoneLog-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PhoneLog_Put_E317C7587CBB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PhoneLog" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PhoneLog" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PhoneLog" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PhoneLog" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PhoneLog" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PhoneLog" } } } } } } }, "/api/PhoneLog/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "PhoneLog" ], "summary": "PhoneLog: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PhoneLog-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PhoneLog_GetPageByValue_9992B715E00F", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PhoneLog/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "PhoneLog" ], "summary": "PhoneLog: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PhoneLog-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PhoneLog_GetPageByValue2_FE03034B9C71", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PhoneLog/DeleteByFilter": { "post": { "tags": [ "PhoneLog" ], "summary": "PhoneLog: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PhoneLog-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PhoneLog_DeleteByFilter_1340DB394447", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/PhoneLog/GetAllByValue": { "post": { "tags": [ "PhoneLog" ], "summary": "PhoneLog: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PhoneLog-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PhoneLog_GetAllByValue_1D20A2DA66CB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PhoneLog" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PhoneLog" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PhoneLog" } } } } } } }, "/api/PhoneLog/GetAllGraphByValue": { "post": { "tags": [ "PhoneLog" ], "summary": "PhoneLog: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PhoneLog-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PhoneLog_GetAllGraphByValue_5AAF2BC21FAD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PhoneLog" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PhoneLog" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PhoneLog" } } } } } } }, "/api/PhoneLog/GetByValue": { "post": { "tags": [ "PhoneLog" ], "summary": "PhoneLog: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PhoneLog-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PhoneLog_GetByValue_7A929977E3C7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PhoneLog" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PhoneLog" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PhoneLog" } } } } } } }, "/api/PhoneLog/GetLookup": { "post": { "tags": [ "PhoneLog" ], "summary": "PhoneLog: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PhoneLog-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PhoneLog_GetLookup_99C46EF7B878", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/PhoneLog/GetLookupByValue": { "post": { "tags": [ "PhoneLog" ], "summary": "PhoneLog: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PhoneLog-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PhoneLog_GetLookupByValue_AF3C42E296E6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/PhoneLog/Page": { "get": { "tags": [ "PhoneLog" ], "summary": "PhoneLog: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PhoneLog-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PhoneLog_GetPage_3AB77A91E420", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PhoneLog/PageAsc": { "get": { "tags": [ "PhoneLog" ], "summary": "PhoneLog: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PhoneLog-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PhoneLog_GetPageAsc_A7BC82088B9E", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/PhoneLog/SearchByValue": { "post": { "tags": [ "PhoneLog" ], "summary": "PhoneLog: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PhoneLog-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PhoneLog_SearchByValue_CAFDC1C7B668", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PhoneLog" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PhoneLog" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PhoneLog" } } } } } } }, "/api/PhoneLog/TryGetByValue": { "post": { "tags": [ "PhoneLog" ], "summary": "PhoneLog: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PhoneLog-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PhoneLog_TryGetByValue_15B43EA5F278", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PhoneLog" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PhoneLog" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PhoneLog" } } } } } } }, "/api/PhoneLog/UpsertGraph": { "put": { "tags": [ "PhoneLog" ], "summary": "PhoneLog: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PhoneLog-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PhoneLog_UpsertGraph_9C83DA8A75A4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PhoneLog" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PhoneLog" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.PhoneLog" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PhoneLog" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PhoneLog" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PhoneLog" } } } } } } }, "/api/PhoneLog/UpsertGraphWithExtraFields": { "put": { "tags": [ "PhoneLog" ], "summary": "PhoneLog: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PhoneLog-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PhoneLog_UpsertGraphWithExtraFields_683087F8AD84", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PhoneLog" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PhoneLog" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PhoneLog" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PhoneLog" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PhoneLog" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PhoneLog" } } } } } } }, "/api/PluginUpload/GetRegisteredPlugins": { "get": { "tags": [ "PluginUpload" ], "summary": "PluginUpload: GetRegisteredPlugins", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PluginUpload-Read.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PluginUpload_GetRegisteredPlugins_C3481234114F", "responses": { "200": { "description": "OK" } } } }, "/api/PluginUpload/Upload": { "post": { "tags": [ "PluginUpload" ], "summary": "PluginUpload: UploadPlugin", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PluginUpload-Create.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PluginUpload_UploadPlugin_F132E6385656", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } }, "encoding": { "file": { "style": "form" } } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/PortalConroller/GetArticles": { "get": { "tags": [ "PortalConroller" ], "summary": "PortalConroller: GetArticles", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: PortalConroller-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "PortalConroller_GetArticles_DC20B94FB9B5", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Dto.ArticleCarouselDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Dto.ArticleCarouselDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Dto.ArticleCarouselDto" } } } } } } }, "/api/Procurement": { "get": { "tags": [ "Procurement" ], "summary": "Procurement: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Procurement-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Procurement_GetAll_CFC7F1C9DCDF", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Procurement" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Procurement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Procurement" } } } } } }, "post": { "tags": [ "Procurement" ], "summary": "Procurement: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Procurement-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Procurement_Post_D215501F0A02", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Procurement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Procurement" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Procurement" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Procurement" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Procurement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Procurement" } } } } } }, "put": { "tags": [ "Procurement" ], "summary": "Procurement: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Procurement-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Procurement_Put_41B3969CB46D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Procurement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Procurement" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Procurement" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Procurement" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Procurement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Procurement" } } } } } } }, "/api/Procurement/{OpenProcurement}/PageFromViewProduction": { "get": { "tags": [ "Procurement" ], "summary": "Procurement: GetPageFromViewProduction", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Procurement-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Procurement_GetPageFromViewProduction_5B314345114A", "parameters": [ { "name": "OpenProcurement", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Procurement/{OpenProcurement}/PageFromViewPurchase": { "get": { "tags": [ "Procurement" ], "summary": "Procurement: GetPageFromViewPurchase", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Procurement-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Procurement_GetPageFromViewPurchase_4E301B00E8C8", "parameters": [ { "name": "OpenProcurement", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Procurement/{OpenProcurement}/PageFromViewUnclear": { "get": { "tags": [ "Procurement" ], "summary": "Procurement: PageFromViewUnclear", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Procurement-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Procurement_PageFromViewUnclear_FD0353538B64", "parameters": [ { "name": "OpenProcurement", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Procurement/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "Procurement" ], "summary": "Procurement: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Procurement-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Procurement_GetPageByValue_6C378CE35561", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Procurement/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "Procurement" ], "summary": "Procurement: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Procurement-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Procurement_GetPageByValue2_0C7F47951EF9", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Procurement/ClearProcurement": { "get": { "tags": [ "Procurement" ], "summary": "Procurement: ClearProcurement", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Procurement-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Procurement_ClearProcurement_1B86B2983FEA", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/Procurement/CreateOrder": { "post": { "tags": [ "Procurement" ], "summary": "Procurement: CreateOrder", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Procurement-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Procurement_CreateOrder_B420D8BF15B1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Procurement_CreateOrderRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Procurement_CreateOrderRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Procurement_CreateOrderRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/Procurement/CreateProduction": { "post": { "tags": [ "Procurement" ], "summary": "Procurement: CreateProduction", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Procurement-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Procurement_CreateProduction_3FEF214C0C6A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Procurement_CreateProductionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Procurement_CreateProductionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Procurement_CreateProductionRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/Procurement/DeleteByFilter": { "post": { "tags": [ "Procurement" ], "summary": "Procurement: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Procurement-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Procurement_DeleteByFilter_0634F559413A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/Procurement/GetAllByValue": { "post": { "tags": [ "Procurement" ], "summary": "Procurement: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Procurement-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Procurement_GetAllByValue_9432ADB5F186", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Procurement" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Procurement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Procurement" } } } } } } }, "/api/Procurement/GetAllGraphByValue": { "post": { "tags": [ "Procurement" ], "summary": "Procurement: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Procurement-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Procurement_GetAllGraphByValue_5F8F12A148DD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Procurement" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Procurement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Procurement" } } } } } } }, "/api/Procurement/GetByValue": { "post": { "tags": [ "Procurement" ], "summary": "Procurement: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Procurement-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Procurement_GetByValue_03BA605208C2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Procurement" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Procurement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Procurement" } } } } } } }, "/api/Procurement/GetLookup": { "post": { "tags": [ "Procurement" ], "summary": "Procurement: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Procurement-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Procurement_GetLookup_C9F95DBFE236", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/Procurement/GetLookupByValue": { "post": { "tags": [ "Procurement" ], "summary": "Procurement: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Procurement-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Procurement_GetLookupByValue_12BD1319FC2F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/Procurement/Page": { "get": { "tags": [ "Procurement" ], "summary": "Procurement: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Procurement-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Procurement_GetPage_39739659BE50", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Procurement/PageAsc": { "get": { "tags": [ "Procurement" ], "summary": "Procurement: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Procurement-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Procurement_GetPageAsc_510F534C2BAC", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Procurement/RunWizard": { "post": { "tags": [ "Procurement" ], "summary": "Procurement: RunWizard", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Procurement-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Procurement_RunWizard_2915B176C711", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Procurement_RunWizardRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Procurement_RunWizardRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Procurement_RunWizardRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/Procurement/SearchByValue": { "post": { "tags": [ "Procurement" ], "summary": "Procurement: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Procurement-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Procurement_SearchByValue_0BA240E66691", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.Procurement" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.Procurement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.Procurement" } } } } } } }, "/api/Procurement/TryGetByValue": { "post": { "tags": [ "Procurement" ], "summary": "Procurement: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Procurement-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Procurement_TryGetByValue_6EC072B64395", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Procurement" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Procurement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Procurement" } } } } } } }, "/api/Procurement/UpdateNewAnnouncedQuantityUsed": { "post": { "tags": [ "Procurement" ], "summary": "Procurement: UpdateNewAnnouncedQuantityUsed", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Procurement-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Procurement_UpdateNewAnnouncedQuantityUsed_6BDADCCC5ADB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Procurement_UpdateQuantityUsedRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Procurement_UpdateQuantityUsedRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Procurement_UpdateQuantityUsedRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xPROC550_ProcurementWizard_QuantityUsedResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xPROC550_ProcurementWizard_QuantityUsedResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xPROC550_ProcurementWizard_QuantityUsedResult" } } } } } } }, "/api/Procurement/UpdateNewOrderedQuantityUsed": { "post": { "tags": [ "Procurement" ], "summary": "Procurement: UpdateNewOrderedQuantityUsed", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Procurement-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Procurement_UpdateNewOrderedQuantityUsed_8DC17722A428", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Procurement_UpdateQuantityUsedRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Procurement_UpdateQuantityUsedRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Procurement_UpdateQuantityUsedRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xPROC550_ProcurementWizard_QuantityUsedResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xPROC550_ProcurementWizard_QuantityUsedResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xPROC550_ProcurementWizard_QuantityUsedResult" } } } } } } }, "/api/Procurement/UpdateNewStockQuantityUsed": { "post": { "tags": [ "Procurement" ], "summary": "Procurement: UpdateNewStockQuantityUsed", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Procurement-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Procurement_UpdateNewStockQuantityUsed_960F300DFFDD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Procurement_UpdateQuantityUsedRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Procurement_UpdateQuantityUsedRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Procurement_UpdateQuantityUsedRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xPROC550_ProcurementWizard_QuantityUsedResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xPROC550_ProcurementWizard_QuantityUsedResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xPROC550_ProcurementWizard_QuantityUsedResult" } } } } } } }, "/api/Procurement/UpsertGraph": { "put": { "tags": [ "Procurement" ], "summary": "Procurement: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Procurement-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Procurement_UpsertGraph_F1C13B6A0197", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Procurement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Procurement" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Procurement" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Procurement" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Procurement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Procurement" } } } } } } }, "/api/Procurement/UpsertGraphWithExtraFields": { "put": { "tags": [ "Procurement" ], "summary": "Procurement: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Procurement-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Procurement_UpsertGraphWithExtraFields_5C3346D62823", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Procurement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Procurement" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Procurement" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Procurement" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Procurement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Procurement" } } } } } } }, "/api/Production": { "get": { "tags": [ "Production" ], "summary": "Production: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Production-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Production_GetAll_A6292B5824C4", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Production" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Production" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Production" } } } } } }, "post": { "tags": [ "Production" ], "summary": "Production: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Production-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Production_Post_7EF818EE46E3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Production" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Production" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Production" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Production" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Production" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Production" } } } } } }, "put": { "tags": [ "Production" ], "summary": "Production: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Production-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Production_Put_9FB0EDFA41E8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Production" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Production" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Production" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Production" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Production" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Production" } } } } } } }, "/api/Production/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "Production" ], "summary": "Production: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Production-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Production_GetPageByValue_FA2C4645B52A", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Production/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "Production" ], "summary": "Production: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Production-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Production_GetPageByValue2_CED34FD3E2C9", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Production/AnnounceQuantity": { "post": { "tags": [ "Production" ], "summary": "Production: AnnounceQuantity", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Production-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Production_AnnounceQuantity_FC640810DACF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Production_AnnounceQuantityRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Production_AnnounceQuantityRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Production_AnnounceQuantityRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/Production/CalculateQuantityPicked": { "post": { "tags": [ "Production" ], "summary": "Production: CalculateQuantityPicked", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Production-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Production_CalculateQuantityPicked_CE9E8CE39C79", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Production_IdRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Production_IdRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Production_IdRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xPROC418U_Production_Calculate_QuantityPickResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xPROC418U_Production_Calculate_QuantityPickResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xPROC418U_Production_Calculate_QuantityPickResult" } } } } } } }, "/api/Production/CloseProductionManually": { "post": { "tags": [ "Production" ], "summary": "Production: CloseProductionManually", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Production-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Production_CloseProductionManually_273D3DF3EED6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Production_IdRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Production_IdRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Production_IdRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/Production/CompletedQuantity": { "post": { "tags": [ "Production" ], "summary": "Production: CompletedQuantity", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Production-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Production_CompletedQuantity_DA8B48F9615A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Production_IdRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Production_IdRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Production_IdRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.QuantityCompletedResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.QuantityCompletedResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.QuantityCompletedResult" } } } } } } }, "/api/Production/CreateNewProductionOrder": { "post": { "tags": [ "Production" ], "summary": "Production: CreateNewProductionOrder", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Production-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Production_CreateNewProductionOrder_AAA76DDC44E5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Production_CreateNewOrderRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Production_CreateNewOrderRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Production_CreateNewOrderRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Production" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Production" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Production" } } } } } } }, "/api/Production/DeleteByFilter": { "post": { "tags": [ "Production" ], "summary": "Production: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Production-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Production_DeleteByFilter_3C4CEE4F01CA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/Production/gantt-chart-data": { "get": { "tags": [ "Production" ], "summary": "Production: GetProductionForGanttChart", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Production-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Production_GetProductionForGanttChart_495DFEAD31D0", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionGanttChartModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionGanttChartModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionGanttChartModel" } } } } } } }, "/api/Production/gantt-chart-resources": { "get": { "tags": [ "Production" ], "summary": "Production: GetResourcesForGantt", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Production-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Production_GetResourcesForGantt_71E220FA675F", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ResourceAssignmentModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ResourceAssignmentModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ResourceAssignmentModel" } } } } } } }, "/api/Production/GetAllByValue": { "post": { "tags": [ "Production" ], "summary": "Production: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Production-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Production_GetAllByValue_3542A2139948", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Production" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Production" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Production" } } } } } } }, "/api/Production/GetAllGraphByValue": { "post": { "tags": [ "Production" ], "summary": "Production: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Production-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Production_GetAllGraphByValue_E09D564D10E9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Production" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Production" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Production" } } } } } } }, "/api/Production/GetByValue": { "post": { "tags": [ "Production" ], "summary": "Production: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Production-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Production_GetByValue_089DB89D1E03", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Production" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Production" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Production" } } } } } } }, "/api/Production/GetLookup": { "post": { "tags": [ "Production" ], "summary": "Production: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Production-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Production_GetLookup_082252834001", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/Production/GetLookupByValue": { "post": { "tags": [ "Production" ], "summary": "Production: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Production-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Production_GetLookupByValue_384F7BE9D283", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/Production/IssueQuantity": { "post": { "tags": [ "Production" ], "summary": "Production: IssueQuantity", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Production-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Production_IssueQuantity_7931C6D3A43F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Production_IssueQuantityRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Production_IssueQuantityRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Production_IssueQuantityRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/Production/PackedQuantity": { "post": { "tags": [ "Production" ], "summary": "Production: PackedQuantity", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Production-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Production_PackedQuantity_B6AAB62281A7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Production_IdRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Production_IdRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Production_IdRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xPROC418U_Production_PackResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xPROC418U_Production_PackResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xPROC418U_Production_PackResult" } } } } } } }, "/api/Production/Page": { "get": { "tags": [ "Production" ], "summary": "Production: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Production-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Production_GetPage_E4F7F58F8404", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Production/PageAsc": { "get": { "tags": [ "Production" ], "summary": "Production: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Production-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Production_GetPageAsc_8E0A378318B9", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Production/PageFromView": { "get": { "tags": [ "Production" ], "summary": "Production: GetPageFromView", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Production-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Production_GetPageFromView_715FE17231F6", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Production/PickQuantity": { "post": { "tags": [ "Production" ], "summary": "Production: PickQuantity", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Production-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Production_PickQuantity_95C9FC62DE9F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Production_PickQuantityRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Production_PickQuantityRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Production_PickQuantityRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/Production/ReserveQuantity": { "post": { "tags": [ "Production" ], "summary": "Production: ReserveQuantity", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Production-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Production_ReserveQuantity_C1A0B40C63DF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Production_ReserveQuantityRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Production_ReserveQuantityRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Production_ReserveQuantityRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/Production/SearchByValue": { "post": { "tags": [ "Production" ], "summary": "Production: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Production-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Production_SearchByValue_D01D7F124B71", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.Production" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.Production" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.Production" } } } } } } }, "/api/Production/SetFirstProductionNumber": { "post": { "tags": [ "Production" ], "summary": "Production: SetFirstProductionNumber", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Production-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Production_SetFirstProductionNumber_B7400FBBA46E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Production_SetFirstNumberRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Production_SetFirstNumberRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Production_SetFirstNumberRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/Production/Sproc_UpdateField": { "put": { "tags": [ "Production" ], "summary": "Production: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Production-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Production_Put_170D47CC1BB0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Production_Sproc_UpdateField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Production_Sproc_UpdateField" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Production_Sproc_UpdateField" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Production_Sproc_UpdateField" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Production_Sproc_UpdateField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Production_Sproc_UpdateField" } } } } } } }, "/api/Production/TryGetByValue": { "post": { "tags": [ "Production" ], "summary": "Production: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Production-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Production_TryGetByValue_FB38F8536418", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Production" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Production" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Production" } } } } } } }, "/api/Production/UpdateProduction/{id}": { "put": { "tags": [ "Production" ], "summary": "Production: UpdateProduction", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Production-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Production_UpdateProduction_B7A3BD074B30", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionModel" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Production" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Production" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Production" } } } } } } }, "/api/Production/UpdateProductionField/{id}": { "patch": { "tags": [ "Production" ], "summary": "Production: UpdateProductionField", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Production-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Production_UpdateProductionField_2F5DF9EDCEE4", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "fieldName", "in": "query", "schema": { "type": "string" } }, { "name": "fieldValue", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionGanttChartModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionGanttChartModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionGanttChartModel" } } } } } } }, "/api/Production/UpsertGraph": { "put": { "tags": [ "Production" ], "summary": "Production: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Production-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Production_UpsertGraph_E6FE791A1013", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Production" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Production" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Production" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Production" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Production" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Production" } } } } } } }, "/api/Production/UpsertGraphWithExtraFields": { "put": { "tags": [ "Production" ], "summary": "Production: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Production-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Production_UpsertGraphWithExtraFields_9696A4F71F15", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Production" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Production" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Production" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Production" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Production" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Production" } } } } } } }, "/api/ProductionDataAcquisition": { "get": { "tags": [ "ProductionDataAcquisition" ], "summary": "ProductionDataAcquisition: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDataAcquisition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDataAcquisition_GetAll_54E4E7641651", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionDataAcquisition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionDataAcquisition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionDataAcquisition" } } } } } }, "post": { "tags": [ "ProductionDataAcquisition" ], "summary": "ProductionDataAcquisition: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDataAcquisition-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDataAcquisition_Post_4AAE8B8F94E7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisition" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDataAcquisition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDataAcquisition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDataAcquisition" } } } } } }, "put": { "tags": [ "ProductionDataAcquisition" ], "summary": "ProductionDataAcquisition: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDataAcquisition-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDataAcquisition_Put_EDC875E1B788", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisition" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDataAcquisition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDataAcquisition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDataAcquisition" } } } } } } }, "/api/ProductionDataAcquisition/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "ProductionDataAcquisition" ], "summary": "ProductionDataAcquisition: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDataAcquisition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDataAcquisition_GetPageByValue_8C94987E29C5", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ProductionDataAcquisition/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "ProductionDataAcquisition" ], "summary": "ProductionDataAcquisition: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDataAcquisition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDataAcquisition_GetPageByValue2_47E04BA30205", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ProductionDataAcquisition/DeleteByFilter": { "post": { "tags": [ "ProductionDataAcquisition" ], "summary": "ProductionDataAcquisition: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDataAcquisition-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDataAcquisition_DeleteByFilter_6B1863661AE4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/ProductionDataAcquisition/GetAllByValue": { "post": { "tags": [ "ProductionDataAcquisition" ], "summary": "ProductionDataAcquisition: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDataAcquisition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDataAcquisition_GetAllByValue_95A9E2C3D786", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionDataAcquisition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionDataAcquisition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionDataAcquisition" } } } } } } }, "/api/ProductionDataAcquisition/GetAllGraphByValue": { "post": { "tags": [ "ProductionDataAcquisition" ], "summary": "ProductionDataAcquisition: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDataAcquisition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDataAcquisition_GetAllGraphByValue_A822BE1FAA23", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionDataAcquisition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionDataAcquisition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionDataAcquisition" } } } } } } }, "/api/ProductionDataAcquisition/GetByProduction": { "post": { "tags": [ "ProductionDataAcquisition" ], "summary": "ProductionDataAcquisition: GetByProduction", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDataAcquisition-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDataAcquisition_GetByProduction_F9BE633DEE55", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Production_IdRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Production_IdRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Production_IdRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW450_ProductionDataAcquisition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW450_ProductionDataAcquisition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW450_ProductionDataAcquisition" } } } } } } }, "/api/ProductionDataAcquisition/GetByValue": { "post": { "tags": [ "ProductionDataAcquisition" ], "summary": "ProductionDataAcquisition: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDataAcquisition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDataAcquisition_GetByValue_33AE6EC739A3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDataAcquisition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDataAcquisition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDataAcquisition" } } } } } } }, "/api/ProductionDataAcquisition/GetLookup": { "post": { "tags": [ "ProductionDataAcquisition" ], "summary": "ProductionDataAcquisition: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDataAcquisition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDataAcquisition_GetLookup_3C210987CBE1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ProductionDataAcquisition/GetLookupByValue": { "post": { "tags": [ "ProductionDataAcquisition" ], "summary": "ProductionDataAcquisition: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDataAcquisition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDataAcquisition_GetLookupByValue_FF028F3DF10E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ProductionDataAcquisition/Page": { "get": { "tags": [ "ProductionDataAcquisition" ], "summary": "ProductionDataAcquisition: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDataAcquisition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDataAcquisition_GetPage_D97A9490F505", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ProductionDataAcquisition/PageAsc": { "get": { "tags": [ "ProductionDataAcquisition" ], "summary": "ProductionDataAcquisition: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDataAcquisition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDataAcquisition_GetPageAsc_C20836F3BE50", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ProductionDataAcquisition/PageFromView": { "get": { "tags": [ "ProductionDataAcquisition" ], "summary": "ProductionDataAcquisition: GetPageFromView", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDataAcquisition-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDataAcquisition_GetPageFromView_2427869FAA4E", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ProductionDataAcquisition/SearchByValue": { "post": { "tags": [ "ProductionDataAcquisition" ], "summary": "ProductionDataAcquisition: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDataAcquisition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDataAcquisition_SearchByValue_C2271FC8B599", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ProductionDataAcquisition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ProductionDataAcquisition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ProductionDataAcquisition" } } } } } } }, "/api/ProductionDataAcquisition/TryGetByValue": { "post": { "tags": [ "ProductionDataAcquisition" ], "summary": "ProductionDataAcquisition: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDataAcquisition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDataAcquisition_TryGetByValue_F31BCD11118A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDataAcquisition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDataAcquisition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDataAcquisition" } } } } } } }, "/api/ProductionDataAcquisition/UpsertGraph": { "put": { "tags": [ "ProductionDataAcquisition" ], "summary": "ProductionDataAcquisition: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDataAcquisition-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDataAcquisition_UpsertGraph_69F7D454238B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisition" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDataAcquisition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDataAcquisition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDataAcquisition" } } } } } } }, "/api/ProductionDataAcquisition/UpsertGraphWithExtraFields": { "put": { "tags": [ "ProductionDataAcquisition" ], "summary": "ProductionDataAcquisition: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDataAcquisition-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDataAcquisition_UpsertGraphWithExtraFields_EA7E764EAC48", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionDataAcquisition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionDataAcquisition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionDataAcquisition" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionDataAcquisition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionDataAcquisition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionDataAcquisition" } } } } } } }, "/api/ProductionDataAcquisitionReasonCode": { "get": { "tags": [ "ProductionDataAcquisitionReasonCode" ], "summary": "ProductionDataAcquisitionReasonCode: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDataAcquisitionReasonCode-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDataAcquisitionReasonCode_GetAll_28548FA915E9", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionDataAcquisitionReasonCode" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionDataAcquisitionReasonCode" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionDataAcquisitionReasonCode" } } } } } }, "post": { "tags": [ "ProductionDataAcquisitionReasonCode" ], "summary": "ProductionDataAcquisitionReasonCode: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDataAcquisitionReasonCode-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDataAcquisitionReasonCode_Post_6DAB0D27D27E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisitionReasonCode" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisitionReasonCode" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisitionReasonCode" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDataAcquisitionReasonCode" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDataAcquisitionReasonCode" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDataAcquisitionReasonCode" } } } } } }, "put": { "tags": [ "ProductionDataAcquisitionReasonCode" ], "summary": "ProductionDataAcquisitionReasonCode: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDataAcquisitionReasonCode-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDataAcquisitionReasonCode_Put_DFDFF828BA22", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisitionReasonCode" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisitionReasonCode" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisitionReasonCode" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDataAcquisitionReasonCode" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDataAcquisitionReasonCode" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDataAcquisitionReasonCode" } } } } } } }, "/api/ProductionDataAcquisitionReasonCode/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "ProductionDataAcquisitionReasonCode" ], "summary": "ProductionDataAcquisitionReasonCode: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDataAcquisitionReasonCode-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDataAcquisitionReasonCode_GetPageByValue_5799057F8E70", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ProductionDataAcquisitionReasonCode/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "ProductionDataAcquisitionReasonCode" ], "summary": "ProductionDataAcquisitionReasonCode: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDataAcquisitionReasonCode-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDataAcquisitionReasonCode_GetPageByValue2_BD823400C10A", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ProductionDataAcquisitionReasonCode/DeleteByFilter": { "post": { "tags": [ "ProductionDataAcquisitionReasonCode" ], "summary": "ProductionDataAcquisitionReasonCode: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDataAcquisitionReasonCode-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDataAcquisitionReasonCode_DeleteByFilter_7D31DB143367", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/ProductionDataAcquisitionReasonCode/GetAllByValue": { "post": { "tags": [ "ProductionDataAcquisitionReasonCode" ], "summary": "ProductionDataAcquisitionReasonCode: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDataAcquisitionReasonCode-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDataAcquisitionReasonCode_GetAllByValue_EBACA08C1D9F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionDataAcquisitionReasonCode" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionDataAcquisitionReasonCode" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionDataAcquisitionReasonCode" } } } } } } }, "/api/ProductionDataAcquisitionReasonCode/GetAllGraphByValue": { "post": { "tags": [ "ProductionDataAcquisitionReasonCode" ], "summary": "ProductionDataAcquisitionReasonCode: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDataAcquisitionReasonCode-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDataAcquisitionReasonCode_GetAllGraphByValue_0B0F4114E5C8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionDataAcquisitionReasonCode" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionDataAcquisitionReasonCode" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionDataAcquisitionReasonCode" } } } } } } }, "/api/ProductionDataAcquisitionReasonCode/GetByValue": { "post": { "tags": [ "ProductionDataAcquisitionReasonCode" ], "summary": "ProductionDataAcquisitionReasonCode: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDataAcquisitionReasonCode-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDataAcquisitionReasonCode_GetByValue_C724BAA39B43", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDataAcquisitionReasonCode" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDataAcquisitionReasonCode" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDataAcquisitionReasonCode" } } } } } } }, "/api/ProductionDataAcquisitionReasonCode/GetLookup": { "post": { "tags": [ "ProductionDataAcquisitionReasonCode" ], "summary": "ProductionDataAcquisitionReasonCode: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDataAcquisitionReasonCode-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDataAcquisitionReasonCode_GetLookup_3E9E65859EDA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ProductionDataAcquisitionReasonCode/GetLookupByValue": { "post": { "tags": [ "ProductionDataAcquisitionReasonCode" ], "summary": "ProductionDataAcquisitionReasonCode: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDataAcquisitionReasonCode-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDataAcquisitionReasonCode_GetLookupByValue_690D8A5DF8D4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ProductionDataAcquisitionReasonCode/Page": { "get": { "tags": [ "ProductionDataAcquisitionReasonCode" ], "summary": "ProductionDataAcquisitionReasonCode: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDataAcquisitionReasonCode-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDataAcquisitionReasonCode_GetPage_CBE975D80F06", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ProductionDataAcquisitionReasonCode/PageAsc": { "get": { "tags": [ "ProductionDataAcquisitionReasonCode" ], "summary": "ProductionDataAcquisitionReasonCode: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDataAcquisitionReasonCode-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDataAcquisitionReasonCode_GetPageAsc_32EFD782047E", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ProductionDataAcquisitionReasonCode/SearchByValue": { "post": { "tags": [ "ProductionDataAcquisitionReasonCode" ], "summary": "ProductionDataAcquisitionReasonCode: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDataAcquisitionReasonCode-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDataAcquisitionReasonCode_SearchByValue_3F4E0693227D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ProductionDataAcquisitionReasonCode" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ProductionDataAcquisitionReasonCode" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ProductionDataAcquisitionReasonCode" } } } } } } }, "/api/ProductionDataAcquisitionReasonCode/TryGetByValue": { "post": { "tags": [ "ProductionDataAcquisitionReasonCode" ], "summary": "ProductionDataAcquisitionReasonCode: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDataAcquisitionReasonCode-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDataAcquisitionReasonCode_TryGetByValue_2023C000E4BA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDataAcquisitionReasonCode" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDataAcquisitionReasonCode" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDataAcquisitionReasonCode" } } } } } } }, "/api/ProductionDataAcquisitionReasonCode/UpsertGraph": { "put": { "tags": [ "ProductionDataAcquisitionReasonCode" ], "summary": "ProductionDataAcquisitionReasonCode: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDataAcquisitionReasonCode-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDataAcquisitionReasonCode_UpsertGraph_008E08AD6F78", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisitionReasonCode" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisitionReasonCode" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisitionReasonCode" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDataAcquisitionReasonCode" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDataAcquisitionReasonCode" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDataAcquisitionReasonCode" } } } } } } }, "/api/ProductionDataAcquisitionReasonCode/UpsertGraphWithExtraFields": { "put": { "tags": [ "ProductionDataAcquisitionReasonCode" ], "summary": "ProductionDataAcquisitionReasonCode: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDataAcquisitionReasonCode-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDataAcquisitionReasonCode_UpsertGraphWithExtraFields_374D3EE85295", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionDataAcquisitionReasonCode" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionDataAcquisitionReasonCode" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionDataAcquisitionReasonCode" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionDataAcquisitionReasonCode" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionDataAcquisitionReasonCode" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionDataAcquisitionReasonCode" } } } } } } }, "/api/ProductionDataAcquisitionStatus": { "get": { "tags": [ "ProductionDataAcquisitionStatus" ], "summary": "ProductionDataAcquisitionStatus: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDataAcquisitionStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDataAcquisitionStatus_GetAll_A1AC149F5CAD", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionDataAcquisitionStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionDataAcquisitionStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionDataAcquisitionStatus" } } } } } }, "post": { "tags": [ "ProductionDataAcquisitionStatus" ], "summary": "ProductionDataAcquisitionStatus: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDataAcquisitionStatus-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDataAcquisitionStatus_Post_996E65636DB5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisitionStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisitionStatus" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisitionStatus" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDataAcquisitionStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDataAcquisitionStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDataAcquisitionStatus" } } } } } }, "put": { "tags": [ "ProductionDataAcquisitionStatus" ], "summary": "ProductionDataAcquisitionStatus: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDataAcquisitionStatus-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDataAcquisitionStatus_Put_5E9F58B380B2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisitionStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisitionStatus" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisitionStatus" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDataAcquisitionStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDataAcquisitionStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDataAcquisitionStatus" } } } } } } }, "/api/ProductionDataAcquisitionStatus/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "ProductionDataAcquisitionStatus" ], "summary": "ProductionDataAcquisitionStatus: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDataAcquisitionStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDataAcquisitionStatus_GetPageByValue_A31D0EF24C9A", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ProductionDataAcquisitionStatus/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "ProductionDataAcquisitionStatus" ], "summary": "ProductionDataAcquisitionStatus: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDataAcquisitionStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDataAcquisitionStatus_GetPageByValue2_B8177B45CD78", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ProductionDataAcquisitionStatus/DeleteByFilter": { "post": { "tags": [ "ProductionDataAcquisitionStatus" ], "summary": "ProductionDataAcquisitionStatus: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDataAcquisitionStatus-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDataAcquisitionStatus_DeleteByFilter_E93A4F771369", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/ProductionDataAcquisitionStatus/GetAllByValue": { "post": { "tags": [ "ProductionDataAcquisitionStatus" ], "summary": "ProductionDataAcquisitionStatus: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDataAcquisitionStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDataAcquisitionStatus_GetAllByValue_B6EA10F64CE0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionDataAcquisitionStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionDataAcquisitionStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionDataAcquisitionStatus" } } } } } } }, "/api/ProductionDataAcquisitionStatus/GetAllGraphByValue": { "post": { "tags": [ "ProductionDataAcquisitionStatus" ], "summary": "ProductionDataAcquisitionStatus: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDataAcquisitionStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDataAcquisitionStatus_GetAllGraphByValue_F15A1531C7F2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionDataAcquisitionStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionDataAcquisitionStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionDataAcquisitionStatus" } } } } } } }, "/api/ProductionDataAcquisitionStatus/GetByValue": { "post": { "tags": [ "ProductionDataAcquisitionStatus" ], "summary": "ProductionDataAcquisitionStatus: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDataAcquisitionStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDataAcquisitionStatus_GetByValue_1FBF9D5E7D68", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDataAcquisitionStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDataAcquisitionStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDataAcquisitionStatus" } } } } } } }, "/api/ProductionDataAcquisitionStatus/GetLookup": { "post": { "tags": [ "ProductionDataAcquisitionStatus" ], "summary": "ProductionDataAcquisitionStatus: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDataAcquisitionStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDataAcquisitionStatus_GetLookup_648C24C198BB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ProductionDataAcquisitionStatus/GetLookupByValue": { "post": { "tags": [ "ProductionDataAcquisitionStatus" ], "summary": "ProductionDataAcquisitionStatus: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDataAcquisitionStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDataAcquisitionStatus_GetLookupByValue_79C2F8C7E0FF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ProductionDataAcquisitionStatus/Page": { "get": { "tags": [ "ProductionDataAcquisitionStatus" ], "summary": "ProductionDataAcquisitionStatus: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDataAcquisitionStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDataAcquisitionStatus_GetPage_50B43C60B258", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ProductionDataAcquisitionStatus/PageAsc": { "get": { "tags": [ "ProductionDataAcquisitionStatus" ], "summary": "ProductionDataAcquisitionStatus: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDataAcquisitionStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDataAcquisitionStatus_GetPageAsc_FCF8ABDF8141", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ProductionDataAcquisitionStatus/SearchByValue": { "post": { "tags": [ "ProductionDataAcquisitionStatus" ], "summary": "ProductionDataAcquisitionStatus: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDataAcquisitionStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDataAcquisitionStatus_SearchByValue_4FC2683F07AD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ProductionDataAcquisitionStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ProductionDataAcquisitionStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ProductionDataAcquisitionStatus" } } } } } } }, "/api/ProductionDataAcquisitionStatus/TryGetByValue": { "post": { "tags": [ "ProductionDataAcquisitionStatus" ], "summary": "ProductionDataAcquisitionStatus: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDataAcquisitionStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDataAcquisitionStatus_TryGetByValue_1A0946DCC9A9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDataAcquisitionStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDataAcquisitionStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDataAcquisitionStatus" } } } } } } }, "/api/ProductionDataAcquisitionStatus/UpsertGraph": { "put": { "tags": [ "ProductionDataAcquisitionStatus" ], "summary": "ProductionDataAcquisitionStatus: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDataAcquisitionStatus-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDataAcquisitionStatus_UpsertGraph_98BC38CE99DE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisitionStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisitionStatus" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisitionStatus" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDataAcquisitionStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDataAcquisitionStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDataAcquisitionStatus" } } } } } } }, "/api/ProductionDataAcquisitionStatus/UpsertGraphWithExtraFields": { "put": { "tags": [ "ProductionDataAcquisitionStatus" ], "summary": "ProductionDataAcquisitionStatus: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDataAcquisitionStatus-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDataAcquisitionStatus_UpsertGraphWithExtraFields_F6F7D813E88B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionDataAcquisitionStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionDataAcquisitionStatus" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionDataAcquisitionStatus" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionDataAcquisitionStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionDataAcquisitionStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionDataAcquisitionStatus" } } } } } } }, "/api/ProductionDataAcquisitionWorkplace": { "get": { "tags": [ "ProductionDataAcquisitionWorkplace" ], "summary": "ProductionDataAcquisitionWorkplace: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDataAcquisitionWorkplace-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDataAcquisitionWorkplace_GetAll_0AD10E6BD230", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionDataAcquisitionWorkplace" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionDataAcquisitionWorkplace" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionDataAcquisitionWorkplace" } } } } } }, "post": { "tags": [ "ProductionDataAcquisitionWorkplace" ], "summary": "ProductionDataAcquisitionWorkplace: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDataAcquisitionWorkplace-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDataAcquisitionWorkplace_Post_5F8702011AB8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisitionWorkplace" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisitionWorkplace" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisitionWorkplace" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDataAcquisitionWorkplace" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDataAcquisitionWorkplace" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDataAcquisitionWorkplace" } } } } } }, "put": { "tags": [ "ProductionDataAcquisitionWorkplace" ], "summary": "ProductionDataAcquisitionWorkplace: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDataAcquisitionWorkplace-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDataAcquisitionWorkplace_Put_387B9A77D83A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisitionWorkplace" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisitionWorkplace" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisitionWorkplace" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDataAcquisitionWorkplace" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDataAcquisitionWorkplace" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDataAcquisitionWorkplace" } } } } } } }, "/api/ProductionDataAcquisitionWorkplace/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "ProductionDataAcquisitionWorkplace" ], "summary": "ProductionDataAcquisitionWorkplace: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDataAcquisitionWorkplace-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDataAcquisitionWorkplace_GetPageByValue_E73456E6B63D", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ProductionDataAcquisitionWorkplace/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "ProductionDataAcquisitionWorkplace" ], "summary": "ProductionDataAcquisitionWorkplace: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDataAcquisitionWorkplace-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDataAcquisitionWorkplace_GetPageByValue2_2AA2490171F9", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ProductionDataAcquisitionWorkplace/DeleteByFilter": { "post": { "tags": [ "ProductionDataAcquisitionWorkplace" ], "summary": "ProductionDataAcquisitionWorkplace: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDataAcquisitionWorkplace-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDataAcquisitionWorkplace_DeleteByFilter_931BA575F977", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/ProductionDataAcquisitionWorkplace/GetAllByValue": { "post": { "tags": [ "ProductionDataAcquisitionWorkplace" ], "summary": "ProductionDataAcquisitionWorkplace: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDataAcquisitionWorkplace-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDataAcquisitionWorkplace_GetAllByValue_61C646AB8EA7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionDataAcquisitionWorkplace" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionDataAcquisitionWorkplace" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionDataAcquisitionWorkplace" } } } } } } }, "/api/ProductionDataAcquisitionWorkplace/GetAllGraphByValue": { "post": { "tags": [ "ProductionDataAcquisitionWorkplace" ], "summary": "ProductionDataAcquisitionWorkplace: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDataAcquisitionWorkplace-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDataAcquisitionWorkplace_GetAllGraphByValue_188DC130BA61", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionDataAcquisitionWorkplace" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionDataAcquisitionWorkplace" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionDataAcquisitionWorkplace" } } } } } } }, "/api/ProductionDataAcquisitionWorkplace/GetByValue": { "post": { "tags": [ "ProductionDataAcquisitionWorkplace" ], "summary": "ProductionDataAcquisitionWorkplace: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDataAcquisitionWorkplace-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDataAcquisitionWorkplace_GetByValue_3DBDFFD6EABD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDataAcquisitionWorkplace" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDataAcquisitionWorkplace" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDataAcquisitionWorkplace" } } } } } } }, "/api/ProductionDataAcquisitionWorkplace/GetLookup": { "post": { "tags": [ "ProductionDataAcquisitionWorkplace" ], "summary": "ProductionDataAcquisitionWorkplace: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDataAcquisitionWorkplace-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDataAcquisitionWorkplace_GetLookup_2E40FBCD9629", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ProductionDataAcquisitionWorkplace/GetLookupByValue": { "post": { "tags": [ "ProductionDataAcquisitionWorkplace" ], "summary": "ProductionDataAcquisitionWorkplace: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDataAcquisitionWorkplace-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDataAcquisitionWorkplace_GetLookupByValue_6F363F033439", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ProductionDataAcquisitionWorkplace/Page": { "get": { "tags": [ "ProductionDataAcquisitionWorkplace" ], "summary": "ProductionDataAcquisitionWorkplace: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDataAcquisitionWorkplace-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDataAcquisitionWorkplace_GetPage_B790F8A6FAEF", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ProductionDataAcquisitionWorkplace/PageAsc": { "get": { "tags": [ "ProductionDataAcquisitionWorkplace" ], "summary": "ProductionDataAcquisitionWorkplace: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDataAcquisitionWorkplace-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDataAcquisitionWorkplace_GetPageAsc_FD42CDF96F17", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ProductionDataAcquisitionWorkplace/SearchByValue": { "post": { "tags": [ "ProductionDataAcquisitionWorkplace" ], "summary": "ProductionDataAcquisitionWorkplace: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDataAcquisitionWorkplace-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDataAcquisitionWorkplace_SearchByValue_6A38843858AB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ProductionDataAcquisitionWorkplace" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ProductionDataAcquisitionWorkplace" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ProductionDataAcquisitionWorkplace" } } } } } } }, "/api/ProductionDataAcquisitionWorkplace/TryGetByValue": { "post": { "tags": [ "ProductionDataAcquisitionWorkplace" ], "summary": "ProductionDataAcquisitionWorkplace: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDataAcquisitionWorkplace-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDataAcquisitionWorkplace_TryGetByValue_D436962BA4CF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDataAcquisitionWorkplace" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDataAcquisitionWorkplace" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDataAcquisitionWorkplace" } } } } } } }, "/api/ProductionDataAcquisitionWorkplace/UpsertGraph": { "put": { "tags": [ "ProductionDataAcquisitionWorkplace" ], "summary": "ProductionDataAcquisitionWorkplace: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDataAcquisitionWorkplace-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDataAcquisitionWorkplace_UpsertGraph_D03A451633E3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisitionWorkplace" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisitionWorkplace" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisitionWorkplace" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDataAcquisitionWorkplace" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDataAcquisitionWorkplace" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDataAcquisitionWorkplace" } } } } } } }, "/api/ProductionDataAcquisitionWorkplace/UpsertGraphWithExtraFields": { "put": { "tags": [ "ProductionDataAcquisitionWorkplace" ], "summary": "ProductionDataAcquisitionWorkplace: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDataAcquisitionWorkplace-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDataAcquisitionWorkplace_UpsertGraphWithExtraFields_7EAB4C69F416", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionDataAcquisitionWorkplace" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionDataAcquisitionWorkplace" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionDataAcquisitionWorkplace" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionDataAcquisitionWorkplace" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionDataAcquisitionWorkplace" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionDataAcquisitionWorkplace" } } } } } } }, "/api/ProductionDataAcquisitionWorkplaceStatus": { "get": { "tags": [ "ProductionDataAcquisitionWorkplaceStatus" ], "summary": "ProductionDataAcquisitionWorkplaceStatus: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDataAcquisitionWorkplaceStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDataAcquisitionWorkplaceStatus_GetAll_4E0EB24F8CA5", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionDataAcquisitionWorkplaceStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionDataAcquisitionWorkplaceStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionDataAcquisitionWorkplaceStatus" } } } } } }, "post": { "tags": [ "ProductionDataAcquisitionWorkplaceStatus" ], "summary": "ProductionDataAcquisitionWorkplaceStatus: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDataAcquisitionWorkplaceStatus-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDataAcquisitionWorkplaceStatus_Post_46FDAD14240E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisitionWorkplaceStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisitionWorkplaceStatus" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisitionWorkplaceStatus" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDataAcquisitionWorkplaceStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDataAcquisitionWorkplaceStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDataAcquisitionWorkplaceStatus" } } } } } }, "put": { "tags": [ "ProductionDataAcquisitionWorkplaceStatus" ], "summary": "ProductionDataAcquisitionWorkplaceStatus: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDataAcquisitionWorkplaceStatus-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDataAcquisitionWorkplaceStatus_Put_AECB55431AAF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisitionWorkplaceStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisitionWorkplaceStatus" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisitionWorkplaceStatus" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDataAcquisitionWorkplaceStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDataAcquisitionWorkplaceStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDataAcquisitionWorkplaceStatus" } } } } } } }, "/api/ProductionDataAcquisitionWorkplaceStatus/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "ProductionDataAcquisitionWorkplaceStatus" ], "summary": "ProductionDataAcquisitionWorkplaceStatus: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDataAcquisitionWorkplaceStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDataAcquisitionWorkplaceStatus_GetPageByValue_93A8E8835B2D", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ProductionDataAcquisitionWorkplaceStatus/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "ProductionDataAcquisitionWorkplaceStatus" ], "summary": "ProductionDataAcquisitionWorkplaceStatus: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDataAcquisitionWorkplaceStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDataAcquisitionWorkplaceStatus_GetPageByValue2_FFDF38596435", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ProductionDataAcquisitionWorkplaceStatus/DeleteByFilter": { "post": { "tags": [ "ProductionDataAcquisitionWorkplaceStatus" ], "summary": "ProductionDataAcquisitionWorkplaceStatus: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDataAcquisitionWorkplaceStatus-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDataAcquisitionWorkplaceStatus_DeleteByFilter_92CC7170012D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/ProductionDataAcquisitionWorkplaceStatus/GetAllByValue": { "post": { "tags": [ "ProductionDataAcquisitionWorkplaceStatus" ], "summary": "ProductionDataAcquisitionWorkplaceStatus: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDataAcquisitionWorkplaceStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDataAcquisitionWorkplaceStatus_GetAllByValue_1468CE5F35C8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionDataAcquisitionWorkplaceStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionDataAcquisitionWorkplaceStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionDataAcquisitionWorkplaceStatus" } } } } } } }, "/api/ProductionDataAcquisitionWorkplaceStatus/GetAllGraphByValue": { "post": { "tags": [ "ProductionDataAcquisitionWorkplaceStatus" ], "summary": "ProductionDataAcquisitionWorkplaceStatus: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDataAcquisitionWorkplaceStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDataAcquisitionWorkplaceStatus_GetAllGraphByValue_9153B4B22C7E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionDataAcquisitionWorkplaceStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionDataAcquisitionWorkplaceStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionDataAcquisitionWorkplaceStatus" } } } } } } }, "/api/ProductionDataAcquisitionWorkplaceStatus/GetByValue": { "post": { "tags": [ "ProductionDataAcquisitionWorkplaceStatus" ], "summary": "ProductionDataAcquisitionWorkplaceStatus: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDataAcquisitionWorkplaceStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDataAcquisitionWorkplaceStatus_GetByValue_A0356B30E34D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDataAcquisitionWorkplaceStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDataAcquisitionWorkplaceStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDataAcquisitionWorkplaceStatus" } } } } } } }, "/api/ProductionDataAcquisitionWorkplaceStatus/GetLookup": { "post": { "tags": [ "ProductionDataAcquisitionWorkplaceStatus" ], "summary": "ProductionDataAcquisitionWorkplaceStatus: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDataAcquisitionWorkplaceStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDataAcquisitionWorkplaceStatus_GetLookup_8C0594431F9A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ProductionDataAcquisitionWorkplaceStatus/GetLookupByValue": { "post": { "tags": [ "ProductionDataAcquisitionWorkplaceStatus" ], "summary": "ProductionDataAcquisitionWorkplaceStatus: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDataAcquisitionWorkplaceStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDataAcquisitionWorkplaceStatus_GetLookupByValue_92744C016847", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ProductionDataAcquisitionWorkplaceStatus/Page": { "get": { "tags": [ "ProductionDataAcquisitionWorkplaceStatus" ], "summary": "ProductionDataAcquisitionWorkplaceStatus: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDataAcquisitionWorkplaceStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDataAcquisitionWorkplaceStatus_GetPage_70D9673258B9", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ProductionDataAcquisitionWorkplaceStatus/PageAsc": { "get": { "tags": [ "ProductionDataAcquisitionWorkplaceStatus" ], "summary": "ProductionDataAcquisitionWorkplaceStatus: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDataAcquisitionWorkplaceStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDataAcquisitionWorkplaceStatus_GetPageAsc_9DF65BB0ED69", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ProductionDataAcquisitionWorkplaceStatus/SearchByValue": { "post": { "tags": [ "ProductionDataAcquisitionWorkplaceStatus" ], "summary": "ProductionDataAcquisitionWorkplaceStatus: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDataAcquisitionWorkplaceStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDataAcquisitionWorkplaceStatus_SearchByValue_F6EF3236AC7B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ProductionDataAcquisitionWorkplaceStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ProductionDataAcquisitionWorkplaceStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ProductionDataAcquisitionWorkplaceStatus" } } } } } } }, "/api/ProductionDataAcquisitionWorkplaceStatus/TryGetByValue": { "post": { "tags": [ "ProductionDataAcquisitionWorkplaceStatus" ], "summary": "ProductionDataAcquisitionWorkplaceStatus: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDataAcquisitionWorkplaceStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDataAcquisitionWorkplaceStatus_TryGetByValue_7AC53C5B79FC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDataAcquisitionWorkplaceStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDataAcquisitionWorkplaceStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDataAcquisitionWorkplaceStatus" } } } } } } }, "/api/ProductionDataAcquisitionWorkplaceStatus/UpsertGraph": { "put": { "tags": [ "ProductionDataAcquisitionWorkplaceStatus" ], "summary": "ProductionDataAcquisitionWorkplaceStatus: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDataAcquisitionWorkplaceStatus-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDataAcquisitionWorkplaceStatus_UpsertGraph_F82129B5DBFB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisitionWorkplaceStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisitionWorkplaceStatus" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisitionWorkplaceStatus" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDataAcquisitionWorkplaceStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDataAcquisitionWorkplaceStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDataAcquisitionWorkplaceStatus" } } } } } } }, "/api/ProductionDataAcquisitionWorkplaceStatus/UpsertGraphWithExtraFields": { "put": { "tags": [ "ProductionDataAcquisitionWorkplaceStatus" ], "summary": "ProductionDataAcquisitionWorkplaceStatus: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDataAcquisitionWorkplaceStatus-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDataAcquisitionWorkplaceStatus_UpsertGraphWithExtraFields_2435E8D5CFCC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionDataAcquisitionWorkplaceStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionDataAcquisitionWorkplaceStatus" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionDataAcquisitionWorkplaceStatus" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionDataAcquisitionWorkplaceStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionDataAcquisitionWorkplaceStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionDataAcquisitionWorkplaceStatus" } } } } } } }, "/api/ProductionDurationUnit": { "get": { "tags": [ "ProductionDurationUnit" ], "summary": "ProductionDurationUnit: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDurationUnit-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDurationUnit_GetAll_4D0B8E7C9E67", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionDurationUnit" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionDurationUnit" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionDurationUnit" } } } } } }, "post": { "tags": [ "ProductionDurationUnit" ], "summary": "ProductionDurationUnit: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDurationUnit-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDurationUnit_Post_B7123F5AA7E0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDurationUnit" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDurationUnit" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDurationUnit" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDurationUnit" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDurationUnit" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDurationUnit" } } } } } }, "put": { "tags": [ "ProductionDurationUnit" ], "summary": "ProductionDurationUnit: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDurationUnit-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDurationUnit_Put_9FE2561A9D7D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDurationUnit" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDurationUnit" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDurationUnit" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDurationUnit" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDurationUnit" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDurationUnit" } } } } } } }, "/api/ProductionDurationUnit/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "ProductionDurationUnit" ], "summary": "ProductionDurationUnit: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDurationUnit-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDurationUnit_GetPageByValue_05C62DBA2E5F", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ProductionDurationUnit/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "ProductionDurationUnit" ], "summary": "ProductionDurationUnit: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDurationUnit-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDurationUnit_GetPageByValue2_A7E0690554CC", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ProductionDurationUnit/DeleteByFilter": { "post": { "tags": [ "ProductionDurationUnit" ], "summary": "ProductionDurationUnit: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDurationUnit-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDurationUnit_DeleteByFilter_974E0B27739A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/ProductionDurationUnit/GetAllByValue": { "post": { "tags": [ "ProductionDurationUnit" ], "summary": "ProductionDurationUnit: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDurationUnit-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDurationUnit_GetAllByValue_47F21B9BEE3B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionDurationUnit" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionDurationUnit" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionDurationUnit" } } } } } } }, "/api/ProductionDurationUnit/GetAllGraphByValue": { "post": { "tags": [ "ProductionDurationUnit" ], "summary": "ProductionDurationUnit: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDurationUnit-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDurationUnit_GetAllGraphByValue_658FF4C7AB01", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionDurationUnit" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionDurationUnit" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionDurationUnit" } } } } } } }, "/api/ProductionDurationUnit/GetByValue": { "post": { "tags": [ "ProductionDurationUnit" ], "summary": "ProductionDurationUnit: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDurationUnit-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDurationUnit_GetByValue_827C11B90EC0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDurationUnit" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDurationUnit" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDurationUnit" } } } } } } }, "/api/ProductionDurationUnit/GetLookup": { "post": { "tags": [ "ProductionDurationUnit" ], "summary": "ProductionDurationUnit: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDurationUnit-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDurationUnit_GetLookup_9E8F2C9A160F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ProductionDurationUnit/GetLookupByValue": { "post": { "tags": [ "ProductionDurationUnit" ], "summary": "ProductionDurationUnit: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDurationUnit-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDurationUnit_GetLookupByValue_5BB1AB8D5AAF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ProductionDurationUnit/Page": { "get": { "tags": [ "ProductionDurationUnit" ], "summary": "ProductionDurationUnit: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDurationUnit-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDurationUnit_GetPage_92CD33141A2A", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ProductionDurationUnit/PageAsc": { "get": { "tags": [ "ProductionDurationUnit" ], "summary": "ProductionDurationUnit: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDurationUnit-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDurationUnit_GetPageAsc_F5776C05D4C2", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ProductionDurationUnit/SearchByValue": { "post": { "tags": [ "ProductionDurationUnit" ], "summary": "ProductionDurationUnit: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDurationUnit-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDurationUnit_SearchByValue_C0C4D8D1C7B6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ProductionDurationUnit" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ProductionDurationUnit" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ProductionDurationUnit" } } } } } } }, "/api/ProductionDurationUnit/TryGetByValue": { "post": { "tags": [ "ProductionDurationUnit" ], "summary": "ProductionDurationUnit: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDurationUnit-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDurationUnit_TryGetByValue_22460C421AED", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDurationUnit" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDurationUnit" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDurationUnit" } } } } } } }, "/api/ProductionDurationUnit/UpsertGraph": { "put": { "tags": [ "ProductionDurationUnit" ], "summary": "ProductionDurationUnit: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDurationUnit-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDurationUnit_UpsertGraph_35DEFD22108B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDurationUnit" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDurationUnit" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDurationUnit" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDurationUnit" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDurationUnit" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDurationUnit" } } } } } } }, "/api/ProductionDurationUnit/UpsertGraphWithExtraFields": { "put": { "tags": [ "ProductionDurationUnit" ], "summary": "ProductionDurationUnit: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionDurationUnit-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionDurationUnit_UpsertGraphWithExtraFields_7ED9CBB3F30F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionDurationUnit" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionDurationUnit" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionDurationUnit" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionDurationUnit" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionDurationUnit" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionDurationUnit" } } } } } } }, "/api/ProductionPosition": { "get": { "tags": [ "ProductionPosition" ], "summary": "ProductionPosition: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPosition_GetAll_1D5CEC157285", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW420_ProductionPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW420_ProductionPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW420_ProductionPosition" } } } } } }, "post": { "tags": [ "ProductionPosition" ], "summary": "ProductionPosition: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPosition-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPosition_Post_A92F83184246", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW420_ProductionPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW420_ProductionPosition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW420_ProductionPosition" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW420_ProductionPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW420_ProductionPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW420_ProductionPosition" } } } } } }, "put": { "tags": [ "ProductionPosition" ], "summary": "ProductionPosition: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPosition-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPosition_Put_D0442EA8CF60", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW420_ProductionPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW420_ProductionPosition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW420_ProductionPosition" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW420_ProductionPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW420_ProductionPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW420_ProductionPosition" } } } } } } }, "/api/ProductionPosition/{id}/ProductionTaskUpdate": { "post": { "tags": [ "ProductionPosition" ], "summary": "ProductionPosition: ProductionTaskUpdate", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPosition-Create.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPosition_ProductionTaskUpdate_FFA2059FE648", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPosition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPosition" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionPosition" } } } } } } }, "/api/ProductionPosition/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "ProductionPosition" ], "summary": "ProductionPosition: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPosition_GetPageByValue_79292E528E8F", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ProductionPosition/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "ProductionPosition" ], "summary": "ProductionPosition: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPosition_GetPageByValue2_27059D653D49", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ProductionPosition/AddSegment": { "post": { "tags": [ "ProductionPosition" ], "summary": "ProductionPosition: AddSegments", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPosition-Create.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPosition_AddSegments_7CEE5F0E252F", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionSegmentModel" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionSegmentModel" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionSegmentModel" } } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionPositionResourceSegment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionPositionResourceSegment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionPositionResourceSegment" } } } } } } }, "/api/ProductionPosition/DeleteByFilter": { "post": { "tags": [ "ProductionPosition" ], "summary": "ProductionPosition: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPosition-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPosition_DeleteByFilter_51037B54D53E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/ProductionPosition/DeleteSegment": { "post": { "tags": [ "ProductionPosition" ], "summary": "ProductionPosition: DeleteSegments", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPosition-Create.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPosition_DeleteSegments_FFDB0F86D272", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionSegmentModel" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionSegmentModel" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionSegmentModel" } } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionSegmentModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionSegmentModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionSegmentModel" } } } } } } }, "/api/ProductionPosition/GetAllByValue": { "post": { "tags": [ "ProductionPosition" ], "summary": "ProductionPosition: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPosition_GetAllByValue_1C02329B4AFD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW420_ProductionPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW420_ProductionPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW420_ProductionPosition" } } } } } } }, "/api/ProductionPosition/GetAllGraphByValue": { "post": { "tags": [ "ProductionPosition" ], "summary": "ProductionPosition: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPosition_GetAllGraphByValue_00F8D502AF24", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW420_ProductionPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW420_ProductionPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW420_ProductionPosition" } } } } } } }, "/api/ProductionPosition/GetByValue": { "post": { "tags": [ "ProductionPosition" ], "summary": "ProductionPosition: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPosition_GetByValue_EE953B32B1E6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW420_ProductionPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW420_ProductionPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW420_ProductionPosition" } } } } } } }, "/api/ProductionPosition/GetLookup": { "post": { "tags": [ "ProductionPosition" ], "summary": "ProductionPosition: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPosition_GetLookup_FC77C49560C1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ProductionPosition/GetLookupByValue": { "post": { "tags": [ "ProductionPosition" ], "summary": "ProductionPosition: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPosition_GetLookupByValue_50F3A8A18384", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ProductionPosition/GetOutputPosition": { "post": { "tags": [ "ProductionPosition" ], "summary": "ProductionPosition: GetOutputPosition", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPosition-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPosition_GetOutputPosition_02FABD5C70C5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPosition_GetWithQuantitiesRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPosition_GetWithQuantitiesRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPosition_GetWithQuantitiesRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW_ProductionPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW_ProductionPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW_ProductionPosition" } } } } } } }, "/api/ProductionPosition/GetProductionPositionWithQuantities": { "post": { "tags": [ "ProductionPosition" ], "summary": "ProductionPosition: GetProductionPositionWithQuantities", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPosition-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPosition_GetProductionPositionWithQuantities_9E09AA3961A0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPosition_GetWithQuantitiesRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPosition_GetWithQuantitiesRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPosition_GetWithQuantitiesRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW420_ProductionPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW420_ProductionPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW420_ProductionPosition" } } } } } } }, "/api/ProductionPosition/Page": { "get": { "tags": [ "ProductionPosition" ], "summary": "ProductionPosition: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPosition_GetPage_339D81678BF8", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ProductionPosition/PageAsc": { "get": { "tags": [ "ProductionPosition" ], "summary": "ProductionPosition: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPosition_GetPageAsc_42DE44221D68", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ProductionPosition/SearchByValue": { "post": { "tags": [ "ProductionPosition" ], "summary": "ProductionPosition: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPosition_SearchByValue_17F36A38B003", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW420_ProductionPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW420_ProductionPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW420_ProductionPosition" } } } } } } }, "/api/ProductionPosition/Sproc_UpdateField": { "put": { "tags": [ "ProductionPosition" ], "summary": "ProductionPosition: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPosition-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPosition_Put_D009973128BA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPosition_Sproc_UpdateField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPosition_Sproc_UpdateField" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPosition_Sproc_UpdateField" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionPosition_Sproc_UpdateField" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionPosition_Sproc_UpdateField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionPosition_Sproc_UpdateField" } } } } } } }, "/api/ProductionPosition/TryGetByValue": { "post": { "tags": [ "ProductionPosition" ], "summary": "ProductionPosition: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPosition_TryGetByValue_62B6035CBFB9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW420_ProductionPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW420_ProductionPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW420_ProductionPosition" } } } } } } }, "/api/ProductionPosition/UpdateProductionPosition/{id}": { "post": { "tags": [ "ProductionPosition" ], "summary": "ProductionPosition: UpdateProductionPosition", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPosition-Create.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPosition_UpdateProductionPosition_FF4FEADE5166", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW420_ProductionPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW420_ProductionPosition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW420_ProductionPosition" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW420_ProductionPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW420_ProductionPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW420_ProductionPosition" } } } } } } }, "/api/ProductionPosition/UpdateProductionPositionField/{id}": { "patch": { "tags": [ "ProductionPosition" ], "summary": "ProductionPosition: UpdateProductionPositionField", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPosition-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPosition_UpdateProductionPositionField_FBCBB709CD40", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "fieldName", "in": "query", "schema": { "type": "string" } }, { "name": "fieldValue", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionGanttChartModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionGanttChartModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionGanttChartModel" } } } } } } }, "/api/ProductionPosition/UpdateSegment": { "post": { "tags": [ "ProductionPosition" ], "summary": "ProductionPosition: UpdateSegments", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPosition-Create.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPosition_UpdateSegments_A1E5E8CE3C4B", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionSegmentModel" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionSegmentModel" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionSegmentModel" } } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionSegmentModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionSegmentModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionSegmentModel" } } } } } } }, "/api/ProductionPosition/UpsertGraph": { "put": { "tags": [ "ProductionPosition" ], "summary": "ProductionPosition: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPosition-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPosition_UpsertGraph_88BDECEE45F5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW420_ProductionPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW420_ProductionPosition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW420_ProductionPosition" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW420_ProductionPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW420_ProductionPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW420_ProductionPosition" } } } } } } }, "/api/ProductionPosition/UpsertGraphWithExtraFields": { "put": { "tags": [ "ProductionPosition" ], "summary": "ProductionPosition: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPosition-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPosition_UpsertGraphWithExtraFields_32CA0268988F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW420_ProductionPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW420_ProductionPosition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW420_ProductionPosition" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW420_ProductionPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW420_ProductionPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW420_ProductionPosition" } } } } } } }, "/api/ProductionPositionResource": { "get": { "tags": [ "ProductionPositionResource" ], "summary": "ProductionPositionResource: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPositionResource-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPositionResource_GetAll_05909CBFA4CB", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionPositionResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionPositionResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionPositionResource" } } } } } }, "post": { "tags": [ "ProductionPositionResource" ], "summary": "ProductionPositionResource: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPositionResource-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPositionResource_Post_AB5856537760", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionResource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionResource" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionPositionResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionPositionResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionPositionResource" } } } } } }, "put": { "tags": [ "ProductionPositionResource" ], "summary": "ProductionPositionResource: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPositionResource-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPositionResource_Put_A829A1FF22E2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionResource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionResource" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionPositionResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionPositionResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionPositionResource" } } } } } } }, "/api/ProductionPositionResource/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "ProductionPositionResource" ], "summary": "ProductionPositionResource: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPositionResource-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPositionResource_GetPageByValue_DF7DBAE35838", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ProductionPositionResource/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "ProductionPositionResource" ], "summary": "ProductionPositionResource: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPositionResource-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPositionResource_GetPageByValue2_F1F38A8067B3", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ProductionPositionResource/DeleteByFilter": { "post": { "tags": [ "ProductionPositionResource" ], "summary": "ProductionPositionResource: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPositionResource-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPositionResource_DeleteByFilter_EF642F577AF9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/ProductionPositionResource/GetAllByValue": { "post": { "tags": [ "ProductionPositionResource" ], "summary": "ProductionPositionResource: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPositionResource-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPositionResource_GetAllByValue_09274A616603", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionPositionResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionPositionResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionPositionResource" } } } } } } }, "/api/ProductionPositionResource/GetAllGraphByValue": { "post": { "tags": [ "ProductionPositionResource" ], "summary": "ProductionPositionResource: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPositionResource-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPositionResource_GetAllGraphByValue_F48E0CA9550B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionPositionResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionPositionResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionPositionResource" } } } } } } }, "/api/ProductionPositionResource/GetByValue": { "post": { "tags": [ "ProductionPositionResource" ], "summary": "ProductionPositionResource: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPositionResource-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPositionResource_GetByValue_0F41C1A6925C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionPositionResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionPositionResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionPositionResource" } } } } } } }, "/api/ProductionPositionResource/GetLookup": { "post": { "tags": [ "ProductionPositionResource" ], "summary": "ProductionPositionResource: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPositionResource-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPositionResource_GetLookup_7E63695A06F4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ProductionPositionResource/GetLookupByValue": { "post": { "tags": [ "ProductionPositionResource" ], "summary": "ProductionPositionResource: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPositionResource-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPositionResource_GetLookupByValue_96009E570073", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ProductionPositionResource/Page": { "get": { "tags": [ "ProductionPositionResource" ], "summary": "ProductionPositionResource: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPositionResource-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPositionResource_GetPage_68428116900E", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ProductionPositionResource/PageAsc": { "get": { "tags": [ "ProductionPositionResource" ], "summary": "ProductionPositionResource: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPositionResource-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPositionResource_GetPageAsc_FF5171AE3D0C", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ProductionPositionResource/SearchByValue": { "post": { "tags": [ "ProductionPositionResource" ], "summary": "ProductionPositionResource: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPositionResource-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPositionResource_SearchByValue_592990BEB916", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ProductionPositionResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ProductionPositionResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ProductionPositionResource" } } } } } } }, "/api/ProductionPositionResource/TryGetByValue": { "post": { "tags": [ "ProductionPositionResource" ], "summary": "ProductionPositionResource: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPositionResource-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPositionResource_TryGetByValue_40122A35E139", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionPositionResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionPositionResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionPositionResource" } } } } } } }, "/api/ProductionPositionResource/UpsertGraph": { "put": { "tags": [ "ProductionPositionResource" ], "summary": "ProductionPositionResource: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPositionResource-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPositionResource_UpsertGraph_5BD4BFC30F97", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionResource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionResource" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionPositionResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionPositionResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionPositionResource" } } } } } } }, "/api/ProductionPositionResource/UpsertGraphWithExtraFields": { "put": { "tags": [ "ProductionPositionResource" ], "summary": "ProductionPositionResource: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPositionResource-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPositionResource_UpsertGraphWithExtraFields_04698DDF4347", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionPositionResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionPositionResource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionPositionResource" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionPositionResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionPositionResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionPositionResource" } } } } } } }, "/api/ProductionPositionResourceGroup": { "get": { "tags": [ "ProductionPositionResourceGroup" ], "summary": "ProductionPositionResourceGroup: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPositionResourceGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPositionResourceGroup_GetAll_498378AC8B83", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionPositionResourceGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionPositionResourceGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionPositionResourceGroup" } } } } } }, "post": { "tags": [ "ProductionPositionResourceGroup" ], "summary": "ProductionPositionResourceGroup: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPositionResourceGroup-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPositionResourceGroup_Post_FDC65B423DDD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionResourceGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionResourceGroup" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionResourceGroup" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionPositionResourceGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionPositionResourceGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionPositionResourceGroup" } } } } } }, "put": { "tags": [ "ProductionPositionResourceGroup" ], "summary": "ProductionPositionResourceGroup: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPositionResourceGroup-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPositionResourceGroup_Put_89F99FB67C3A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionResourceGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionResourceGroup" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionResourceGroup" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionPositionResourceGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionPositionResourceGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionPositionResourceGroup" } } } } } } }, "/api/ProductionPositionResourceGroup/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "ProductionPositionResourceGroup" ], "summary": "ProductionPositionResourceGroup: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPositionResourceGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPositionResourceGroup_GetPageByValue_980784D1A7B1", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ProductionPositionResourceGroup/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "ProductionPositionResourceGroup" ], "summary": "ProductionPositionResourceGroup: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPositionResourceGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPositionResourceGroup_GetPageByValue2_0A7E1E873941", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ProductionPositionResourceGroup/DeleteByFilter": { "post": { "tags": [ "ProductionPositionResourceGroup" ], "summary": "ProductionPositionResourceGroup: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPositionResourceGroup-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPositionResourceGroup_DeleteByFilter_5D0833611E2F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/ProductionPositionResourceGroup/GetAllByValue": { "post": { "tags": [ "ProductionPositionResourceGroup" ], "summary": "ProductionPositionResourceGroup: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPositionResourceGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPositionResourceGroup_GetAllByValue_F4696BF99B70", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionPositionResourceGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionPositionResourceGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionPositionResourceGroup" } } } } } } }, "/api/ProductionPositionResourceGroup/GetAllGraphByValue": { "post": { "tags": [ "ProductionPositionResourceGroup" ], "summary": "ProductionPositionResourceGroup: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPositionResourceGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPositionResourceGroup_GetAllGraphByValue_8482BB9818BE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionPositionResourceGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionPositionResourceGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionPositionResourceGroup" } } } } } } }, "/api/ProductionPositionResourceGroup/GetByValue": { "post": { "tags": [ "ProductionPositionResourceGroup" ], "summary": "ProductionPositionResourceGroup: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPositionResourceGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPositionResourceGroup_GetByValue_825762B694F2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionPositionResourceGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionPositionResourceGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionPositionResourceGroup" } } } } } } }, "/api/ProductionPositionResourceGroup/GetLookup": { "post": { "tags": [ "ProductionPositionResourceGroup" ], "summary": "ProductionPositionResourceGroup: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPositionResourceGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPositionResourceGroup_GetLookup_6AF1AA510471", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ProductionPositionResourceGroup/GetLookupByValue": { "post": { "tags": [ "ProductionPositionResourceGroup" ], "summary": "ProductionPositionResourceGroup: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPositionResourceGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPositionResourceGroup_GetLookupByValue_BA1CF83CD116", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ProductionPositionResourceGroup/Page": { "get": { "tags": [ "ProductionPositionResourceGroup" ], "summary": "ProductionPositionResourceGroup: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPositionResourceGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPositionResourceGroup_GetPage_B2DB877E7536", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ProductionPositionResourceGroup/PageAsc": { "get": { "tags": [ "ProductionPositionResourceGroup" ], "summary": "ProductionPositionResourceGroup: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPositionResourceGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPositionResourceGroup_GetPageAsc_8F4E27AFE05F", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ProductionPositionResourceGroup/SearchByValue": { "post": { "tags": [ "ProductionPositionResourceGroup" ], "summary": "ProductionPositionResourceGroup: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPositionResourceGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPositionResourceGroup_SearchByValue_446DBD36526E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ProductionPositionResourceGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ProductionPositionResourceGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ProductionPositionResourceGroup" } } } } } } }, "/api/ProductionPositionResourceGroup/TryGetByValue": { "post": { "tags": [ "ProductionPositionResourceGroup" ], "summary": "ProductionPositionResourceGroup: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPositionResourceGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPositionResourceGroup_TryGetByValue_364C96E7CF41", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionPositionResourceGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionPositionResourceGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionPositionResourceGroup" } } } } } } }, "/api/ProductionPositionResourceGroup/UpsertGraph": { "put": { "tags": [ "ProductionPositionResourceGroup" ], "summary": "ProductionPositionResourceGroup: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPositionResourceGroup-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPositionResourceGroup_UpsertGraph_47AE6293E85D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionResourceGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionResourceGroup" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionResourceGroup" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionPositionResourceGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionPositionResourceGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionPositionResourceGroup" } } } } } } }, "/api/ProductionPositionResourceGroup/UpsertGraphWithExtraFields": { "put": { "tags": [ "ProductionPositionResourceGroup" ], "summary": "ProductionPositionResourceGroup: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPositionResourceGroup-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPositionResourceGroup_UpsertGraphWithExtraFields_400F121EC81B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionPositionResourceGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionPositionResourceGroup" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionPositionResourceGroup" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionPositionResourceGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionPositionResourceGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionPositionResourceGroup" } } } } } } }, "/api/ProductionPositionType": { "get": { "tags": [ "ProductionPositionType" ], "summary": "ProductionPositionType: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPositionType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPositionType_GetAll_D6621F3227B8", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionPositionType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionPositionType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionPositionType" } } } } } }, "post": { "tags": [ "ProductionPositionType" ], "summary": "ProductionPositionType: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPositionType-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPositionType_Post_86BF19D2D89D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionPositionType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionPositionType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionPositionType" } } } } } }, "put": { "tags": [ "ProductionPositionType" ], "summary": "ProductionPositionType: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPositionType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPositionType_Put_AF83AC374BB0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionPositionType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionPositionType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionPositionType" } } } } } } }, "/api/ProductionPositionType/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "ProductionPositionType" ], "summary": "ProductionPositionType: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPositionType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPositionType_GetPageByValue_1DFAB42C7235", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ProductionPositionType/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "ProductionPositionType" ], "summary": "ProductionPositionType: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPositionType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPositionType_GetPageByValue2_6FECE0EA5812", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ProductionPositionType/DeleteByFilter": { "post": { "tags": [ "ProductionPositionType" ], "summary": "ProductionPositionType: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPositionType-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPositionType_DeleteByFilter_E4E9CEC9F160", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/ProductionPositionType/GetAllByValue": { "post": { "tags": [ "ProductionPositionType" ], "summary": "ProductionPositionType: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPositionType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPositionType_GetAllByValue_4CCAD04D6A08", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionPositionType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionPositionType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionPositionType" } } } } } } }, "/api/ProductionPositionType/GetAllGraphByValue": { "post": { "tags": [ "ProductionPositionType" ], "summary": "ProductionPositionType: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPositionType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPositionType_GetAllGraphByValue_B9115C08A96C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionPositionType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionPositionType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionPositionType" } } } } } } }, "/api/ProductionPositionType/GetByValue": { "post": { "tags": [ "ProductionPositionType" ], "summary": "ProductionPositionType: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPositionType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPositionType_GetByValue_03D09F11A223", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionPositionType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionPositionType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionPositionType" } } } } } } }, "/api/ProductionPositionType/GetLookup": { "post": { "tags": [ "ProductionPositionType" ], "summary": "ProductionPositionType: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPositionType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPositionType_GetLookup_36465F132DC4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ProductionPositionType/GetLookupByValue": { "post": { "tags": [ "ProductionPositionType" ], "summary": "ProductionPositionType: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPositionType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPositionType_GetLookupByValue_93205EC16778", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ProductionPositionType/Page": { "get": { "tags": [ "ProductionPositionType" ], "summary": "ProductionPositionType: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPositionType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPositionType_GetPage_4B03DF7A8012", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ProductionPositionType/PageAsc": { "get": { "tags": [ "ProductionPositionType" ], "summary": "ProductionPositionType: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPositionType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPositionType_GetPageAsc_25FFD2F092A5", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ProductionPositionType/SearchByValue": { "post": { "tags": [ "ProductionPositionType" ], "summary": "ProductionPositionType: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPositionType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPositionType_SearchByValue_F9AE77B8EAB2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ProductionPositionType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ProductionPositionType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ProductionPositionType" } } } } } } }, "/api/ProductionPositionType/TryGetByValue": { "post": { "tags": [ "ProductionPositionType" ], "summary": "ProductionPositionType: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPositionType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPositionType_TryGetByValue_43789E229CC0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionPositionType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionPositionType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionPositionType" } } } } } } }, "/api/ProductionPositionType/UpsertGraph": { "put": { "tags": [ "ProductionPositionType" ], "summary": "ProductionPositionType: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPositionType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPositionType_UpsertGraph_7B39CF193F3B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionPositionType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionPositionType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionPositionType" } } } } } } }, "/api/ProductionPositionType/UpsertGraphWithExtraFields": { "put": { "tags": [ "ProductionPositionType" ], "summary": "ProductionPositionType: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPositionType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPositionType_UpsertGraphWithExtraFields_0CCA64593053", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionPositionType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionPositionType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionPositionType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionPositionType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionPositionType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionPositionType" } } } } } } }, "/api/ProductionPositionWarehousing": { "get": { "tags": [ "ProductionPositionWarehousing" ], "summary": "ProductionPositionWarehousing: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPositionWarehousing-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPositionWarehousing_GetAll_6CFDD47B50A7", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionPositionWarehousing" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionPositionWarehousing" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionPositionWarehousing" } } } } } }, "post": { "tags": [ "ProductionPositionWarehousing" ], "summary": "ProductionPositionWarehousing: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPositionWarehousing-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPositionWarehousing_Post_12AEB0DFE682", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionWarehousing" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionWarehousing" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionWarehousing" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionPositionWarehousing" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionPositionWarehousing" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionPositionWarehousing" } } } } } }, "put": { "tags": [ "ProductionPositionWarehousing" ], "summary": "ProductionPositionWarehousing: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPositionWarehousing-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPositionWarehousing_Put_31ADB6CCE9CF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionWarehousing" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionWarehousing" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionWarehousing" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionPositionWarehousing" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionPositionWarehousing" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionPositionWarehousing" } } } } } } }, "/api/ProductionPositionWarehousing/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "ProductionPositionWarehousing" ], "summary": "ProductionPositionWarehousing: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPositionWarehousing-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPositionWarehousing_GetPageByValue_B5A7AA357B5E", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ProductionPositionWarehousing/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "ProductionPositionWarehousing" ], "summary": "ProductionPositionWarehousing: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPositionWarehousing-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPositionWarehousing_GetPageByValue2_9E0DBE51E8C1", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ProductionPositionWarehousing/DeleteByFilter": { "post": { "tags": [ "ProductionPositionWarehousing" ], "summary": "ProductionPositionWarehousing: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPositionWarehousing-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPositionWarehousing_DeleteByFilter_6A0FCEE30081", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/ProductionPositionWarehousing/DeleteWarehousing": { "post": { "tags": [ "ProductionPositionWarehousing" ], "summary": "ProductionPositionWarehousing: DeleteWarehousing", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPositionWarehousing-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPositionWarehousing_DeleteWarehousing_F8BF618AA8B8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionWarehousing_DeleteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionWarehousing_DeleteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionWarehousing_DeleteRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/ProductionPositionWarehousing/GetAllByValue": { "post": { "tags": [ "ProductionPositionWarehousing" ], "summary": "ProductionPositionWarehousing: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPositionWarehousing-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPositionWarehousing_GetAllByValue_EAE138DF031D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionPositionWarehousing" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionPositionWarehousing" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionPositionWarehousing" } } } } } } }, "/api/ProductionPositionWarehousing/GetAllFromViewByValue": { "post": { "tags": [ "ProductionPositionWarehousing" ], "summary": "ProductionPositionWarehousing: GetAllFromViewByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPositionWarehousing-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPositionWarehousing_GetAllFromViewByValue_C016BA14C642", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionWarehousing_GetAllFromViewByValueRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionWarehousing_GetAllFromViewByValueRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionWarehousing_GetAllFromViewByValueRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW425_ProductionPositionWarehousing" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW425_ProductionPositionWarehousing" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW425_ProductionPositionWarehousing" } } } } } } }, "/api/ProductionPositionWarehousing/GetAllGraphByValue": { "post": { "tags": [ "ProductionPositionWarehousing" ], "summary": "ProductionPositionWarehousing: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPositionWarehousing-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPositionWarehousing_GetAllGraphByValue_68FB14A979BB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionPositionWarehousing" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionPositionWarehousing" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionPositionWarehousing" } } } } } } }, "/api/ProductionPositionWarehousing/GetByValue": { "post": { "tags": [ "ProductionPositionWarehousing" ], "summary": "ProductionPositionWarehousing: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPositionWarehousing-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPositionWarehousing_GetByValue_CD8D8610C782", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionPositionWarehousing" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionPositionWarehousing" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionPositionWarehousing" } } } } } } }, "/api/ProductionPositionWarehousing/GetLookup": { "post": { "tags": [ "ProductionPositionWarehousing" ], "summary": "ProductionPositionWarehousing: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPositionWarehousing-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPositionWarehousing_GetLookup_E633238CCDC3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ProductionPositionWarehousing/GetLookupByValue": { "post": { "tags": [ "ProductionPositionWarehousing" ], "summary": "ProductionPositionWarehousing: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPositionWarehousing-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPositionWarehousing_GetLookupByValue_6FB1BC96FD72", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ProductionPositionWarehousing/InsertWarehousing": { "post": { "tags": [ "ProductionPositionWarehousing" ], "summary": "ProductionPositionWarehousing: InsertWarehousing", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPositionWarehousing-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPositionWarehousing_InsertWarehousing_310385C7DC1D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionWarehousing_InsertRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionWarehousing_InsertRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionWarehousing_InsertRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xPROC429I_ProductionPositionWarehousingResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xPROC429I_ProductionPositionWarehousingResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xPROC429I_ProductionPositionWarehousingResult" } } } } } } }, "/api/ProductionPositionWarehousing/Page": { "get": { "tags": [ "ProductionPositionWarehousing" ], "summary": "ProductionPositionWarehousing: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPositionWarehousing-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPositionWarehousing_GetPage_DDBAD9E6BAE3", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ProductionPositionWarehousing/PageAsc": { "get": { "tags": [ "ProductionPositionWarehousing" ], "summary": "ProductionPositionWarehousing: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPositionWarehousing-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPositionWarehousing_GetPageAsc_42402C2E6A7F", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ProductionPositionWarehousing/SaveDraftWarehousing": { "post": { "tags": [ "ProductionPositionWarehousing" ], "summary": "ProductionPositionWarehousing: SaveDraftWarehousingResult", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPositionWarehousing-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPositionWarehousing_SaveDraftWarehousingResult_397860881DD7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionWarehousing_ProductionIdRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionWarehousing_ProductionIdRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionWarehousing_ProductionIdRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SaveDraftWarehousingResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SaveDraftWarehousingResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SaveDraftWarehousingResult" } } } } } } }, "/api/ProductionPositionWarehousing/SearchByValue": { "post": { "tags": [ "ProductionPositionWarehousing" ], "summary": "ProductionPositionWarehousing: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPositionWarehousing-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPositionWarehousing_SearchByValue_02B9ED538636", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ProductionPositionWarehousing" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ProductionPositionWarehousing" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ProductionPositionWarehousing" } } } } } } }, "/api/ProductionPositionWarehousing/TryGetByValue": { "post": { "tags": [ "ProductionPositionWarehousing" ], "summary": "ProductionPositionWarehousing: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPositionWarehousing-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPositionWarehousing_TryGetByValue_A60584781BEF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionPositionWarehousing" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionPositionWarehousing" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionPositionWarehousing" } } } } } } }, "/api/ProductionPositionWarehousing/UpdateWarehousing_BinLocationId": { "post": { "tags": [ "ProductionPositionWarehousing" ], "summary": "ProductionPositionWarehousing: UpdateWarehousing_BinLocationId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPositionWarehousing-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPositionWarehousing_UpdateWarehousing_BinLocationId_2AADAC177CF6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionWarehousing_UpdateBinLocationIdRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionWarehousing_UpdateBinLocationIdRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionWarehousing_UpdateBinLocationIdRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xPROC429U_ProductionPositionWarehousing_BinLocationIdResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xPROC429U_ProductionPositionWarehousing_BinLocationIdResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xPROC429U_ProductionPositionWarehousing_BinLocationIdResult" } } } } } } }, "/api/ProductionPositionWarehousing/UpdateWarehousing_IndividualizationNumberId": { "post": { "tags": [ "ProductionPositionWarehousing" ], "summary": "ProductionPositionWarehousing: UpdateWarehousing_IndividualizationNumberId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPositionWarehousing-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPositionWarehousing_UpdateWarehousing_IndividualizationNumberId_7CAB40E671B2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionWarehousing_UpdateIndividualizationNumberIdRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionWarehousing_UpdateIndividualizationNumberIdRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionWarehousing_UpdateIndividualizationNumberIdRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/ProductionPositionWarehousing/UpdateWarehousing_Quantity": { "post": { "tags": [ "ProductionPositionWarehousing" ], "summary": "ProductionPositionWarehousing: UpdateWarehousing_Quantity", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPositionWarehousing-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPositionWarehousing_UpdateWarehousing_Quantity_115D3FA99A1E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionWarehousing_UpdateQuantityRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionWarehousing_UpdateQuantityRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionWarehousing_UpdateQuantityRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/ProductionPositionWarehousing/UpdateWarehousing_WarehouseId": { "post": { "tags": [ "ProductionPositionWarehousing" ], "summary": "ProductionPositionWarehousing: UpdateWarehousing_WarehouseId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPositionWarehousing-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPositionWarehousing_UpdateWarehousing_WarehouseId_B49FF63E6587", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionWarehousing_UpdateWarehouseIdRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionWarehousing_UpdateWarehouseIdRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionWarehousing_UpdateWarehouseIdRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xPROC429U_ProductionPositionWarehousing_WarehouseIdResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xPROC429U_ProductionPositionWarehousing_WarehouseIdResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xPROC429U_ProductionPositionWarehousing_WarehouseIdResult" } } } } } } }, "/api/ProductionPositionWarehousing/UpdateWarehousing_WarehouseMediumId": { "post": { "tags": [ "ProductionPositionWarehousing" ], "summary": "ProductionPositionWarehousing: UpdateWarehousing_WarehouseMediumId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPositionWarehousing-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPositionWarehousing_UpdateWarehousing_WarehouseMediumId_4284240FEE65", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionWarehousing_UpdateWarehouseMediumIdRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionWarehousing_UpdateWarehouseMediumIdRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionWarehousing_UpdateWarehouseMediumIdRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/ProductionPositionWarehousing/UpsertGraph": { "put": { "tags": [ "ProductionPositionWarehousing" ], "summary": "ProductionPositionWarehousing: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPositionWarehousing-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPositionWarehousing_UpsertGraph_F7F3CE8ACC13", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionWarehousing" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionWarehousing" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionWarehousing" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionPositionWarehousing" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionPositionWarehousing" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionPositionWarehousing" } } } } } } }, "/api/ProductionPositionWarehousing/UpsertGraphWithExtraFields": { "put": { "tags": [ "ProductionPositionWarehousing" ], "summary": "ProductionPositionWarehousing: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionPositionWarehousing-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionPositionWarehousing_UpsertGraphWithExtraFields_C8425E530305", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionPositionWarehousing" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionPositionWarehousing" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionPositionWarehousing" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionPositionWarehousing" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionPositionWarehousing" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionPositionWarehousing" } } } } } } }, "/api/ProductionStatus": { "get": { "tags": [ "ProductionStatus" ], "summary": "ProductionStatus: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionStatus_GetAll_72D0195C1CB1", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionStatus" } } } } } }, "post": { "tags": [ "ProductionStatus" ], "summary": "ProductionStatus: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionStatus-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionStatus_Post_D77201B82DD1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionStatus" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionStatus" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionStatus" } } } } } }, "put": { "tags": [ "ProductionStatus" ], "summary": "ProductionStatus: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionStatus-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionStatus_Put_9AF4A4A8F745", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionStatus" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionStatus" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionStatus" } } } } } } }, "/api/ProductionStatus/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "ProductionStatus" ], "summary": "ProductionStatus: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionStatus_GetPageByValue_07EC2B0532DC", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ProductionStatus/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "ProductionStatus" ], "summary": "ProductionStatus: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionStatus_GetPageByValue2_BF43B3858DCE", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ProductionStatus/DeleteByFilter": { "post": { "tags": [ "ProductionStatus" ], "summary": "ProductionStatus: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionStatus-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionStatus_DeleteByFilter_AA6A969540C9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/ProductionStatus/GetAllByValue": { "post": { "tags": [ "ProductionStatus" ], "summary": "ProductionStatus: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionStatus_GetAllByValue_E84D3648157F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionStatus" } } } } } } }, "/api/ProductionStatus/GetAllGraphByValue": { "post": { "tags": [ "ProductionStatus" ], "summary": "ProductionStatus: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionStatus_GetAllGraphByValue_CBF5193F66FD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionStatus" } } } } } } }, "/api/ProductionStatus/GetByValue": { "post": { "tags": [ "ProductionStatus" ], "summary": "ProductionStatus: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionStatus_GetByValue_E396DCE15771", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionStatus" } } } } } } }, "/api/ProductionStatus/GetLookup": { "post": { "tags": [ "ProductionStatus" ], "summary": "ProductionStatus: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionStatus_GetLookup_0A5A018110EB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ProductionStatus/GetLookupByValue": { "post": { "tags": [ "ProductionStatus" ], "summary": "ProductionStatus: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionStatus_GetLookupByValue_40816A8F7159", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ProductionStatus/Page": { "get": { "tags": [ "ProductionStatus" ], "summary": "ProductionStatus: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionStatus_GetPage_5027B9590825", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ProductionStatus/PageAsc": { "get": { "tags": [ "ProductionStatus" ], "summary": "ProductionStatus: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionStatus_GetPageAsc_882D49CE8004", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ProductionStatus/SearchByValue": { "post": { "tags": [ "ProductionStatus" ], "summary": "ProductionStatus: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionStatus_SearchByValue_6CE9BC017ED3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ProductionStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ProductionStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ProductionStatus" } } } } } } }, "/api/ProductionStatus/TryGetByValue": { "post": { "tags": [ "ProductionStatus" ], "summary": "ProductionStatus: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionStatus_TryGetByValue_0AF7CEDCA4DA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionStatus" } } } } } } }, "/api/ProductionStatus/UpsertGraph": { "put": { "tags": [ "ProductionStatus" ], "summary": "ProductionStatus: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionStatus-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionStatus_UpsertGraph_9B2CE3803EA4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionStatus" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionStatus" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionStatus" } } } } } } }, "/api/ProductionStatus/UpsertGraphWithExtraFields": { "put": { "tags": [ "ProductionStatus" ], "summary": "ProductionStatus: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProductionStatus-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProductionStatus_UpsertGraphWithExtraFields_78319CC75BA8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionStatus" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionStatus" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionStatus" } } } } } } }, "/api/Project": { "get": { "tags": [ "Project" ], "summary": "Project: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Project-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Project_GetAll_E4F8C090AC81", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Project" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Project" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Project" } } } } } }, "post": { "tags": [ "Project" ], "summary": "Project: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Project-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Project_Post_AA0B2D751C63", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Project" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Project" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Project" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Project" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Project" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Project" } } } } } }, "put": { "tags": [ "Project" ], "summary": "Project: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Project-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Project_Put_8C9EEBB0651B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Project" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Project" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Project" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Project" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Project" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Project" } } } } } } }, "/api/Project/{Id}/GetProjectPositionData": { "get": { "tags": [ "Project" ], "summary": "Project: GetProjectPositionData", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Project-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Project_GetProjectPositionData_7591252E29DB", "parameters": [ { "name": "Id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW220_DocPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW220_DocPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW220_DocPosition" } } } } } } }, "/api/Project/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "Project" ], "summary": "Project: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Project-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Project_GetPageByValue_6B10A07D53CC", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Project/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "Project" ], "summary": "Project: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Project-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Project_GetPageByValue2_DC897C64093F", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Project/DeleteByFilter": { "post": { "tags": [ "Project" ], "summary": "Project: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Project-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Project_DeleteByFilter_CAAA3E3DFC25", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/Project/GetAllByValue": { "post": { "tags": [ "Project" ], "summary": "Project: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Project-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Project_GetAllByValue_ADA37DA9E540", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Project" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Project" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Project" } } } } } } }, "/api/Project/GetAllGraphByValue": { "post": { "tags": [ "Project" ], "summary": "Project: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Project-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Project_GetAllGraphByValue_436378D3943D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Project" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Project" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Project" } } } } } } }, "/api/Project/GetByValue": { "post": { "tags": [ "Project" ], "summary": "Project: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Project-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Project_GetByValue_15AB894F2103", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Project" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Project" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Project" } } } } } } }, "/api/Project/GetLookup": { "post": { "tags": [ "Project" ], "summary": "Project: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Project-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Project_GetLookup_BFEF4B3CEFD8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/Project/GetLookupByValue": { "post": { "tags": [ "Project" ], "summary": "Project: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Project-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Project_GetLookupByValue_F1803D7D692E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/Project/Page": { "get": { "tags": [ "Project" ], "summary": "Project: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Project-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Project_GetPage_7003C679D935", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Project/PageAsc": { "get": { "tags": [ "Project" ], "summary": "Project: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Project-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Project_GetPageAsc_A0DB97F9FFD5", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Project/PageProjectsByParent/{ParentId}/{IncludeSubNodes}": { "get": { "tags": [ "Project" ], "summary": "Project: GetPageProjectsByParent", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Project-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Project_GetPageProjectsByParent_15FFFA229CB9", "parameters": [ { "name": "ParentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "IncludeSubNodes", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Project/SearchByValue": { "post": { "tags": [ "Project" ], "summary": "Project: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Project-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Project_SearchByValue_E05239A95857", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.Project" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.Project" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.Project" } } } } } } }, "/api/Project/TryGetByValue": { "post": { "tags": [ "Project" ], "summary": "Project: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Project-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Project_TryGetByValue_4AAB999A93E1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Project" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Project" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Project" } } } } } } }, "/api/Project/UpdateProjectField/{id}": { "patch": { "tags": [ "Project" ], "summary": "Project: UpdateProjectField", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Project-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Project_UpdateProjectField_B2E634AB52E9", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "fieldName", "in": "query", "schema": { "type": "string" } }, { "name": "fieldValue", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Project" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Project" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Project" } } } } } } }, "/api/Project/UpsertGraph": { "put": { "tags": [ "Project" ], "summary": "Project: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Project-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Project_UpsertGraph_10FBF9B54CE2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Project" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Project" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Project" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Project" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Project" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Project" } } } } } } }, "/api/Project/UpsertGraphWithExtraFields": { "put": { "tags": [ "Project" ], "summary": "Project: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Project-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Project_UpsertGraphWithExtraFields_C9B0A46E9149", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Project" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Project" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Project" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Project" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Project" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Project" } } } } } } }, "/api/ProjectDependencyType": { "get": { "tags": [ "ProjectDependencyType" ], "summary": "ProjectDependencyType: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProjectDependencyType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProjectDependencyType_GetAll_842A1B13DDCD", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProjectDependencyType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProjectDependencyType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProjectDependencyType" } } } } } }, "post": { "tags": [ "ProjectDependencyType" ], "summary": "ProjectDependencyType: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProjectDependencyType-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProjectDependencyType_Post_12C188FEFD72", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProjectDependencyType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProjectDependencyType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProjectDependencyType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProjectDependencyType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProjectDependencyType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProjectDependencyType" } } } } } }, "put": { "tags": [ "ProjectDependencyType" ], "summary": "ProjectDependencyType: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProjectDependencyType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProjectDependencyType_Put_992BC5192B2A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProjectDependencyType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProjectDependencyType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProjectDependencyType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProjectDependencyType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProjectDependencyType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProjectDependencyType" } } } } } } }, "/api/ProjectDependencyType/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "ProjectDependencyType" ], "summary": "ProjectDependencyType: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProjectDependencyType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProjectDependencyType_GetPageByValue_DFB98F5E3E62", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ProjectDependencyType/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "ProjectDependencyType" ], "summary": "ProjectDependencyType: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProjectDependencyType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProjectDependencyType_GetPageByValue2_6A13207E8882", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ProjectDependencyType/DeleteByFilter": { "post": { "tags": [ "ProjectDependencyType" ], "summary": "ProjectDependencyType: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProjectDependencyType-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProjectDependencyType_DeleteByFilter_7080BAFFE156", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/ProjectDependencyType/GetAllByValue": { "post": { "tags": [ "ProjectDependencyType" ], "summary": "ProjectDependencyType: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProjectDependencyType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProjectDependencyType_GetAllByValue_F166C30E7E19", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProjectDependencyType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProjectDependencyType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProjectDependencyType" } } } } } } }, "/api/ProjectDependencyType/GetAllGraphByValue": { "post": { "tags": [ "ProjectDependencyType" ], "summary": "ProjectDependencyType: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProjectDependencyType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProjectDependencyType_GetAllGraphByValue_33D0ACC022C7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProjectDependencyType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProjectDependencyType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProjectDependencyType" } } } } } } }, "/api/ProjectDependencyType/GetByValue": { "post": { "tags": [ "ProjectDependencyType" ], "summary": "ProjectDependencyType: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProjectDependencyType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProjectDependencyType_GetByValue_1D22F8066F53", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProjectDependencyType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProjectDependencyType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProjectDependencyType" } } } } } } }, "/api/ProjectDependencyType/GetLookup": { "post": { "tags": [ "ProjectDependencyType" ], "summary": "ProjectDependencyType: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProjectDependencyType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProjectDependencyType_GetLookup_88CDEC7B5320", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ProjectDependencyType/GetLookupByValue": { "post": { "tags": [ "ProjectDependencyType" ], "summary": "ProjectDependencyType: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProjectDependencyType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProjectDependencyType_GetLookupByValue_FCB5CBD2161D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ProjectDependencyType/Page": { "get": { "tags": [ "ProjectDependencyType" ], "summary": "ProjectDependencyType: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProjectDependencyType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProjectDependencyType_GetPage_432BD0ACCB08", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ProjectDependencyType/PageAsc": { "get": { "tags": [ "ProjectDependencyType" ], "summary": "ProjectDependencyType: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProjectDependencyType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProjectDependencyType_GetPageAsc_5A7982944A83", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ProjectDependencyType/SearchByValue": { "post": { "tags": [ "ProjectDependencyType" ], "summary": "ProjectDependencyType: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProjectDependencyType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProjectDependencyType_SearchByValue_26BFB56D7A7B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ProjectDependencyType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ProjectDependencyType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ProjectDependencyType" } } } } } } }, "/api/ProjectDependencyType/TryGetByValue": { "post": { "tags": [ "ProjectDependencyType" ], "summary": "ProjectDependencyType: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProjectDependencyType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProjectDependencyType_TryGetByValue_B5A5EA9C1F22", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProjectDependencyType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProjectDependencyType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProjectDependencyType" } } } } } } }, "/api/ProjectDependencyType/UpsertGraph": { "put": { "tags": [ "ProjectDependencyType" ], "summary": "ProjectDependencyType: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProjectDependencyType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProjectDependencyType_UpsertGraph_8C7988576153", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProjectDependencyType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProjectDependencyType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProjectDependencyType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProjectDependencyType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProjectDependencyType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProjectDependencyType" } } } } } } }, "/api/ProjectDependencyType/UpsertGraphWithExtraFields": { "put": { "tags": [ "ProjectDependencyType" ], "summary": "ProjectDependencyType: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProjectDependencyType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProjectDependencyType_UpsertGraphWithExtraFields_98691D848B94", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProjectDependencyType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProjectDependencyType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProjectDependencyType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProjectDependencyType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProjectDependencyType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProjectDependencyType" } } } } } } }, "/api/ProjectStatus": { "get": { "tags": [ "ProjectStatus" ], "summary": "ProjectStatus: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProjectStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProjectStatus_GetAll_590FD44DCAB5", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProjectStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProjectStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProjectStatus" } } } } } }, "post": { "tags": [ "ProjectStatus" ], "summary": "ProjectStatus: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProjectStatus-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProjectStatus_Post_DE751D73A30E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProjectStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProjectStatus" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProjectStatus" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProjectStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProjectStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProjectStatus" } } } } } }, "put": { "tags": [ "ProjectStatus" ], "summary": "ProjectStatus: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProjectStatus-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProjectStatus_Put_325681BBAD3B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProjectStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProjectStatus" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProjectStatus" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProjectStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProjectStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProjectStatus" } } } } } } }, "/api/ProjectStatus/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "ProjectStatus" ], "summary": "ProjectStatus: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProjectStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProjectStatus_GetPageByValue_67E9C7A54E46", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ProjectStatus/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "ProjectStatus" ], "summary": "ProjectStatus: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProjectStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProjectStatus_GetPageByValue2_E27AF9909996", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ProjectStatus/DeleteByFilter": { "post": { "tags": [ "ProjectStatus" ], "summary": "ProjectStatus: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProjectStatus-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProjectStatus_DeleteByFilter_B0BB8DC7CE3F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/ProjectStatus/GetAllByValue": { "post": { "tags": [ "ProjectStatus" ], "summary": "ProjectStatus: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProjectStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProjectStatus_GetAllByValue_C4F10E8654A1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProjectStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProjectStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProjectStatus" } } } } } } }, "/api/ProjectStatus/GetAllGraphByValue": { "post": { "tags": [ "ProjectStatus" ], "summary": "ProjectStatus: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProjectStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProjectStatus_GetAllGraphByValue_6B2346EEC6D3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProjectStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProjectStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProjectStatus" } } } } } } }, "/api/ProjectStatus/GetByValue": { "post": { "tags": [ "ProjectStatus" ], "summary": "ProjectStatus: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProjectStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProjectStatus_GetByValue_F56222182A05", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProjectStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProjectStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProjectStatus" } } } } } } }, "/api/ProjectStatus/GetLookup": { "post": { "tags": [ "ProjectStatus" ], "summary": "ProjectStatus: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProjectStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProjectStatus_GetLookup_DFB6D4BC1A39", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ProjectStatus/GetLookupByValue": { "post": { "tags": [ "ProjectStatus" ], "summary": "ProjectStatus: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProjectStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProjectStatus_GetLookupByValue_861FD0C9930A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ProjectStatus/Page": { "get": { "tags": [ "ProjectStatus" ], "summary": "ProjectStatus: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProjectStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProjectStatus_GetPage_258291FD54B3", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ProjectStatus/PageAsc": { "get": { "tags": [ "ProjectStatus" ], "summary": "ProjectStatus: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProjectStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProjectStatus_GetPageAsc_FBCAE2C45932", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ProjectStatus/SearchByValue": { "post": { "tags": [ "ProjectStatus" ], "summary": "ProjectStatus: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProjectStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProjectStatus_SearchByValue_5035DB2E77A5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ProjectStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ProjectStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ProjectStatus" } } } } } } }, "/api/ProjectStatus/TryGetByValue": { "post": { "tags": [ "ProjectStatus" ], "summary": "ProjectStatus: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProjectStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProjectStatus_TryGetByValue_C8DE98FDC719", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProjectStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProjectStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProjectStatus" } } } } } } }, "/api/ProjectStatus/UpsertGraph": { "put": { "tags": [ "ProjectStatus" ], "summary": "ProjectStatus: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProjectStatus-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProjectStatus_UpsertGraph_94F5D088C031", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProjectStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProjectStatus" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ProjectStatus" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProjectStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProjectStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProjectStatus" } } } } } } }, "/api/ProjectStatus/UpsertGraphWithExtraFields": { "put": { "tags": [ "ProjectStatus" ], "summary": "ProjectStatus: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ProjectStatus-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ProjectStatus_UpsertGraphWithExtraFields_5ED8814B7128", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProjectStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProjectStatus" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProjectStatus" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProjectStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProjectStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProjectStatus" } } } } } } }, "/api/ReportTemplate": { "get": { "tags": [ "ReportTemplate" ], "summary": "ReportTemplate: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ReportTemplate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ReportTemplate_GetAll_46B5ADF62EB1", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ReportTemplate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ReportTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ReportTemplate" } } } } } }, "post": { "tags": [ "ReportTemplate" ], "summary": "ReportTemplate: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ReportTemplate-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ReportTemplate_Post_5168C15FE634", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ReportTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ReportTemplate" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ReportTemplate" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ReportTemplate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ReportTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ReportTemplate" } } } } } }, "put": { "tags": [ "ReportTemplate" ], "summary": "ReportTemplate: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ReportTemplate-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ReportTemplate_Put_7E2ABAE06F42", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ReportTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ReportTemplate" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ReportTemplate" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ReportTemplate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ReportTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ReportTemplate" } } } } } } }, "/api/ReportTemplate/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "ReportTemplate" ], "summary": "ReportTemplate: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ReportTemplate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ReportTemplate_GetPageByValue_D69D8048CAFA", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ReportTemplate/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "ReportTemplate" ], "summary": "ReportTemplate: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ReportTemplate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ReportTemplate_GetPageByValue2_32DF3226388B", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ReportTemplate/DeleteByFilter": { "post": { "tags": [ "ReportTemplate" ], "summary": "ReportTemplate: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ReportTemplate-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ReportTemplate_DeleteByFilter_E9538A8B69B5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/ReportTemplate/DownloadTemplatedReport/{ReportName}/{ReportParameters}/{Format}": { "get": { "tags": [ "ReportTemplate" ], "summary": "ReportTemplate: DownloadTemplatedReport", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ReportTemplate-Read.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ReportTemplate_DownloadTemplatedReport_32666F14F418", "parameters": [ { "name": "ReportName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ReportParameters", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Format", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ReportTemplate/ExportReport/{reportName}": { "get": { "tags": [ "ReportTemplate" ], "summary": "ReportTemplate: ExportReport", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ReportTemplate-Read.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ReportTemplate_ExportReport_657303553652", "parameters": [ { "name": "reportName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ReportTemplate/GetAllByValue": { "post": { "tags": [ "ReportTemplate" ], "summary": "ReportTemplate: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ReportTemplate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ReportTemplate_GetAllByValue_F1D6618D8DDA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ReportTemplate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ReportTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ReportTemplate" } } } } } } }, "/api/ReportTemplate/GetAllGraphByValue": { "post": { "tags": [ "ReportTemplate" ], "summary": "ReportTemplate: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ReportTemplate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ReportTemplate_GetAllGraphByValue_8FD14A536154", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ReportTemplate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ReportTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ReportTemplate" } } } } } } }, "/api/ReportTemplate/GetAllUrls": { "get": { "tags": [ "ReportTemplate" ], "summary": "ReportTemplate: GetAllUrls", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ReportTemplate-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ReportTemplate_GetAllUrls_E8DA24167C81", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.Dictionary_Of_System.String_And_System.String" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.Dictionary_Of_System.String_And_System.String" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.Dictionary_Of_System.String_And_System.String" } } } } } } }, "/api/ReportTemplate/GetArticleEditReportTemplates": { "get": { "tags": [ "ReportTemplate" ], "summary": "ReportTemplate: GetArticleEditReportTemplates", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ReportTemplate-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ReportTemplate_GetArticleEditReportTemplates_BC5B5A951FF3", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ReportTemplateListItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ReportTemplateListItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ReportTemplateListItem" } } } } } } }, "/api/ReportTemplate/GetByReportTypeId/{reportTypeId}": { "get": { "tags": [ "ReportTemplate" ], "summary": "ReportTemplate: GetByReportTypeId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ReportTemplate-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ReportTemplate_GetByReportTypeId_DC3C23C1A349", "parameters": [ { "name": "reportTypeId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ReportTemplateListItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ReportTemplateListItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ReportTemplateListItem" } } } } } } }, "/api/ReportTemplate/GetByValue": { "post": { "tags": [ "ReportTemplate" ], "summary": "ReportTemplate: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ReportTemplate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ReportTemplate_GetByValue_70EDC5DE20D7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ReportTemplate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ReportTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ReportTemplate" } } } } } } }, "/api/ReportTemplate/GetDocReportTemplates": { "post": { "tags": [ "ReportTemplate" ], "summary": "ReportTemplate: GetDocReportTemplates", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ReportTemplate-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ReportTemplate_GetDocReportTemplates_7234E8C7D5BF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ReportTemplate_GetDocReportTemplatesRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ReportTemplate_GetDocReportTemplatesRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ReportTemplate_GetDocReportTemplatesRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ReportTemplateListItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ReportTemplateListItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ReportTemplateListItem" } } } } } } }, "/api/ReportTemplate/GetDunningReportTemplates": { "get": { "tags": [ "ReportTemplate" ], "summary": "ReportTemplate: GetDunningReportTemplates", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ReportTemplate-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ReportTemplate_GetDunningReportTemplates_5964274BC1A8", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ReportTemplateListItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ReportTemplateListItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ReportTemplateListItem" } } } } } } }, "/api/ReportTemplate/GetLookup": { "post": { "tags": [ "ReportTemplate" ], "summary": "ReportTemplate: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ReportTemplate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ReportTemplate_GetLookup_2072B5EB7696", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ReportTemplate/GetLookupByValue": { "post": { "tags": [ "ReportTemplate" ], "summary": "ReportTemplate: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ReportTemplate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ReportTemplate_GetLookupByValue_40223DF7A550", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ReportTemplate/GetPackingListReportTemplates": { "get": { "tags": [ "ReportTemplate" ], "summary": "ReportTemplate: GetPackingListReportTemplates", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ReportTemplate-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ReportTemplate_GetPackingListReportTemplates_8CA68859EF3F", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ReportTemplateListItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ReportTemplateListItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ReportTemplateListItem" } } } } } } }, "/api/ReportTemplate/GetPartnerEditReportTemplates": { "get": { "tags": [ "ReportTemplate" ], "summary": "ReportTemplate: GetPartnerEditReportTemplates", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ReportTemplate-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ReportTemplate_GetPartnerEditReportTemplates_5E3BD96E6A7C", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ReportTemplateListItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ReportTemplateListItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ReportTemplateListItem" } } } } } } }, "/api/ReportTemplate/GetProductionEditReportTemplates": { "get": { "tags": [ "ReportTemplate" ], "summary": "ReportTemplate: GetProductionEditReportTemplates", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ReportTemplate-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ReportTemplate_GetProductionEditReportTemplates_6AEE89CE0193", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ReportTemplateListItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ReportTemplateListItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ReportTemplateListItem" } } } } } } }, "/api/ReportTemplate/ImportReport": { "post": { "tags": [ "ReportTemplate" ], "summary": "ReportTemplate: ImportReport", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ReportTemplate-Create.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ReportTemplate_ImportReport_2022988194EC", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" }, "reportName": { "type": "string", "default": "" }, "reportTypeId": { "type": "string", "default": "Doc" } } }, "encoding": { "file": { "style": "form" }, "reportName": { "style": "form" }, "reportTypeId": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ReportTemplate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ReportTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ReportTemplate" } } } } } } }, "/api/ReportTemplate/Page": { "get": { "tags": [ "ReportTemplate" ], "summary": "ReportTemplate: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ReportTemplate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ReportTemplate_GetPage_ECCE946AEB02", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ReportTemplate/PageAsc": { "get": { "tags": [ "ReportTemplate" ], "summary": "ReportTemplate: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ReportTemplate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ReportTemplate_GetPageAsc_E5CB774559B7", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ReportTemplate/SearchByValue": { "post": { "tags": [ "ReportTemplate" ], "summary": "ReportTemplate: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ReportTemplate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ReportTemplate_SearchByValue_3646DCF29C54", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ReportTemplate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ReportTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ReportTemplate" } } } } } } }, "/api/ReportTemplate/TryGetByValue": { "post": { "tags": [ "ReportTemplate" ], "summary": "ReportTemplate: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ReportTemplate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ReportTemplate_TryGetByValue_EB1AC337AE7B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ReportTemplate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ReportTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ReportTemplate" } } } } } } }, "/api/ReportTemplate/UpsertGraph": { "put": { "tags": [ "ReportTemplate" ], "summary": "ReportTemplate: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ReportTemplate-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ReportTemplate_UpsertGraph_365940831427", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ReportTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ReportTemplate" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ReportTemplate" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ReportTemplate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ReportTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ReportTemplate" } } } } } } }, "/api/ReportTemplate/UpsertGraphWithExtraFields": { "put": { "tags": [ "ReportTemplate" ], "summary": "ReportTemplate: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ReportTemplate-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ReportTemplate_UpsertGraphWithExtraFields_20FB2DC7E061", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ReportTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ReportTemplate" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ReportTemplate" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ReportTemplate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ReportTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ReportTemplate" } } } } } } }, "/api/ReportType": { "get": { "tags": [ "ReportType" ], "summary": "ReportType: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ReportType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ReportType_GetAll_F2365EAF9EDF", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ReportType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ReportType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ReportType" } } } } } }, "post": { "tags": [ "ReportType" ], "summary": "ReportType: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ReportType-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ReportType_Post_B83366658F36", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ReportType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ReportType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ReportType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ReportType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ReportType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ReportType" } } } } } }, "put": { "tags": [ "ReportType" ], "summary": "ReportType: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ReportType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ReportType_Put_B5FE088D1D46", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ReportType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ReportType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ReportType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ReportType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ReportType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ReportType" } } } } } } }, "/api/ReportType/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "ReportType" ], "summary": "ReportType: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ReportType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ReportType_GetPageByValue_D6B5CEF8BF18", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ReportType/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "ReportType" ], "summary": "ReportType: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ReportType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ReportType_GetPageByValue2_9A0B4A03C4A6", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ReportType/DeleteByFilter": { "post": { "tags": [ "ReportType" ], "summary": "ReportType: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ReportType-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ReportType_DeleteByFilter_8C8C5360066F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/ReportType/GetAllByValue": { "post": { "tags": [ "ReportType" ], "summary": "ReportType: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ReportType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ReportType_GetAllByValue_FCFD221A0AEC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ReportType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ReportType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ReportType" } } } } } } }, "/api/ReportType/GetAllGraphByValue": { "post": { "tags": [ "ReportType" ], "summary": "ReportType: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ReportType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ReportType_GetAllGraphByValue_7E3F9A278380", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ReportType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ReportType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ReportType" } } } } } } }, "/api/ReportType/GetByValue": { "post": { "tags": [ "ReportType" ], "summary": "ReportType: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ReportType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ReportType_GetByValue_A247684B0B00", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ReportType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ReportType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ReportType" } } } } } } }, "/api/ReportType/GetLookup": { "post": { "tags": [ "ReportType" ], "summary": "ReportType: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ReportType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ReportType_GetLookup_9CC80BFD19F8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ReportType/GetLookupByValue": { "post": { "tags": [ "ReportType" ], "summary": "ReportType: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ReportType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ReportType_GetLookupByValue_BEDF40CA0927", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ReportType/Page": { "get": { "tags": [ "ReportType" ], "summary": "ReportType: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ReportType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ReportType_GetPage_220BB5FFE24E", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ReportType/PageAsc": { "get": { "tags": [ "ReportType" ], "summary": "ReportType: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ReportType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ReportType_GetPageAsc_FC9764BA20E6", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ReportType/SearchByValue": { "post": { "tags": [ "ReportType" ], "summary": "ReportType: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ReportType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ReportType_SearchByValue_D981D171EBDB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ReportType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ReportType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ReportType" } } } } } } }, "/api/ReportType/TryGetByValue": { "post": { "tags": [ "ReportType" ], "summary": "ReportType: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ReportType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ReportType_TryGetByValue_4382CF5FC503", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ReportType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ReportType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ReportType" } } } } } } }, "/api/ReportType/UpsertGraph": { "put": { "tags": [ "ReportType" ], "summary": "ReportType: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ReportType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ReportType_UpsertGraph_8D85DFD84D9A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ReportType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ReportType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ReportType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ReportType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ReportType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ReportType" } } } } } } }, "/api/ReportType/UpsertGraphWithExtraFields": { "put": { "tags": [ "ReportType" ], "summary": "ReportType: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ReportType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ReportType_UpsertGraphWithExtraFields_1964CAA5D33A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ReportType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ReportType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ReportType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ReportType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ReportType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ReportType" } } } } } } }, "/api/Resource": { "get": { "tags": [ "Resource" ], "summary": "Resource: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Resource-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Resource_GetAll_7989F5EDD1D7", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Resource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Resource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Resource" } } } } } }, "post": { "tags": [ "Resource" ], "summary": "Resource: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Resource-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Resource_Post_31F2244F39A2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Resource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Resource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Resource" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Resource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Resource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Resource" } } } } } }, "put": { "tags": [ "Resource" ], "summary": "Resource: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Resource-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Resource_Put_66D82C1CA2BE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Resource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Resource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Resource" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Resource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Resource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Resource" } } } } } } }, "/api/Resource/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "Resource" ], "summary": "Resource: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Resource-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Resource_GetPageByValue_89CCC4B7410C", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Resource/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "Resource" ], "summary": "Resource: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Resource-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Resource_GetPageByValue2_9BDE0C949DA2", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Resource/DeleteByFilter": { "post": { "tags": [ "Resource" ], "summary": "Resource: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Resource-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Resource_DeleteByFilter_23B1DF6AAF32", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/Resource/GetAllByValue": { "post": { "tags": [ "Resource" ], "summary": "Resource: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Resource-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Resource_GetAllByValue_6F351A466F2C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Resource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Resource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Resource" } } } } } } }, "/api/Resource/GetAllGraphByValue": { "post": { "tags": [ "Resource" ], "summary": "Resource: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Resource-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Resource_GetAllGraphByValue_3CA0B610FB39", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Resource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Resource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Resource" } } } } } } }, "/api/Resource/GetByValue": { "post": { "tags": [ "Resource" ], "summary": "Resource: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Resource-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Resource_GetByValue_24A03102BAF5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Resource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Resource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Resource" } } } } } } }, "/api/Resource/GetLookup": { "post": { "tags": [ "Resource" ], "summary": "Resource: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Resource-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Resource_GetLookup_7861CDB7B168", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/Resource/GetLookupByValue": { "post": { "tags": [ "Resource" ], "summary": "Resource: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Resource-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Resource_GetLookupByValue_5058A0CDE50F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/Resource/Page": { "get": { "tags": [ "Resource" ], "summary": "Resource: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Resource-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Resource_GetPage_862339D7799E", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Resource/PageAsc": { "get": { "tags": [ "Resource" ], "summary": "Resource: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Resource-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Resource_GetPageAsc_A3A50A19E048", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Resource/SearchByValue": { "post": { "tags": [ "Resource" ], "summary": "Resource: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Resource-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Resource_SearchByValue_3969918B5EFD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.Resource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.Resource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.Resource" } } } } } } }, "/api/Resource/TryGetByValue": { "post": { "tags": [ "Resource" ], "summary": "Resource: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Resource-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Resource_TryGetByValue_E44928F3D154", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Resource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Resource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Resource" } } } } } } }, "/api/Resource/UpsertGraph": { "put": { "tags": [ "Resource" ], "summary": "Resource: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Resource-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Resource_UpsertGraph_E96863E0E9C4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Resource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Resource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Resource" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Resource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Resource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Resource" } } } } } } }, "/api/Resource/UpsertGraphWithExtraFields": { "put": { "tags": [ "Resource" ], "summary": "Resource: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Resource-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Resource_UpsertGraphWithExtraFields_3F362B674453", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Resource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Resource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Resource" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Resource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Resource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Resource" } } } } } } }, "/api/ResourceGroup": { "get": { "tags": [ "ResourceGroup" ], "summary": "ResourceGroup: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ResourceGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ResourceGroup_GetAll_61FB67FA83BC", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ResourceGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ResourceGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ResourceGroup" } } } } } }, "post": { "tags": [ "ResourceGroup" ], "summary": "ResourceGroup: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ResourceGroup-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ResourceGroup_Post_CCFDA02BB2C3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ResourceGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ResourceGroup" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ResourceGroup" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ResourceGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ResourceGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ResourceGroup" } } } } } }, "put": { "tags": [ "ResourceGroup" ], "summary": "ResourceGroup: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ResourceGroup-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ResourceGroup_Put_6FD02EA874F6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ResourceGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ResourceGroup" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ResourceGroup" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ResourceGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ResourceGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ResourceGroup" } } } } } } }, "/api/ResourceGroup/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "ResourceGroup" ], "summary": "ResourceGroup: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ResourceGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ResourceGroup_GetPageByValue_1CAAFAD6D3C2", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ResourceGroup/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "ResourceGroup" ], "summary": "ResourceGroup: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ResourceGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ResourceGroup_GetPageByValue2_6112D4AC306C", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ResourceGroup/DeleteByFilter": { "post": { "tags": [ "ResourceGroup" ], "summary": "ResourceGroup: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ResourceGroup-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ResourceGroup_DeleteByFilter_BA73BA927178", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/ResourceGroup/GetAllByValue": { "post": { "tags": [ "ResourceGroup" ], "summary": "ResourceGroup: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ResourceGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ResourceGroup_GetAllByValue_E5A537CF877B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ResourceGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ResourceGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ResourceGroup" } } } } } } }, "/api/ResourceGroup/GetAllGraphByValue": { "post": { "tags": [ "ResourceGroup" ], "summary": "ResourceGroup: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ResourceGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ResourceGroup_GetAllGraphByValue_FAD2135398D0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ResourceGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ResourceGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ResourceGroup" } } } } } } }, "/api/ResourceGroup/GetByValue": { "post": { "tags": [ "ResourceGroup" ], "summary": "ResourceGroup: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ResourceGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ResourceGroup_GetByValue_EFAF33EA78BD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ResourceGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ResourceGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ResourceGroup" } } } } } } }, "/api/ResourceGroup/GetLookup": { "post": { "tags": [ "ResourceGroup" ], "summary": "ResourceGroup: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ResourceGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ResourceGroup_GetLookup_068E29D458C8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ResourceGroup/GetLookupByValue": { "post": { "tags": [ "ResourceGroup" ], "summary": "ResourceGroup: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ResourceGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ResourceGroup_GetLookupByValue_40F626CC6C27", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ResourceGroup/Page": { "get": { "tags": [ "ResourceGroup" ], "summary": "ResourceGroup: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ResourceGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ResourceGroup_GetPage_78002EE1D45B", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ResourceGroup/PageAsc": { "get": { "tags": [ "ResourceGroup" ], "summary": "ResourceGroup: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ResourceGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ResourceGroup_GetPageAsc_4DA44DD1E2B3", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ResourceGroup/PageResourceGroupsByParent/{ParentId}/{IncludeSubNodes}/{TopParentsOnly}": { "get": { "tags": [ "ResourceGroup" ], "summary": "ResourceGroup: GetPageResourceGroupsByParent", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ResourceGroup-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ResourceGroup_GetPageResourceGroupsByParent_0EB907447BE4", "parameters": [ { "name": "ParentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "IncludeSubNodes", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "TopParentsOnly", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ResourceGroup/ResourceGroups": { "get": { "tags": [ "ResourceGroup" ], "summary": "ResourceGroup: GetResourceGroups", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ResourceGroup-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ResourceGroup_GetResourceGroups_0B5DD640439E", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ResourceGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ResourceGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ResourceGroup" } } } } } } }, "/api/ResourceGroup/SearchByValue": { "post": { "tags": [ "ResourceGroup" ], "summary": "ResourceGroup: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ResourceGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ResourceGroup_SearchByValue_9324CBC43EB8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ResourceGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ResourceGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ResourceGroup" } } } } } } }, "/api/ResourceGroup/TryGetByValue": { "post": { "tags": [ "ResourceGroup" ], "summary": "ResourceGroup: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ResourceGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ResourceGroup_TryGetByValue_3991A9334224", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ResourceGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ResourceGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ResourceGroup" } } } } } } }, "/api/ResourceGroup/UpsertGraph": { "put": { "tags": [ "ResourceGroup" ], "summary": "ResourceGroup: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ResourceGroup-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ResourceGroup_UpsertGraph_16DD31180215", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ResourceGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ResourceGroup" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ResourceGroup" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ResourceGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ResourceGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ResourceGroup" } } } } } } }, "/api/ResourceGroup/UpsertGraphWithExtraFields": { "put": { "tags": [ "ResourceGroup" ], "summary": "ResourceGroup: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ResourceGroup-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ResourceGroup_UpsertGraphWithExtraFields_5EAF701E78DC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ResourceGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ResourceGroup" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ResourceGroup" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ResourceGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ResourceGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ResourceGroup" } } } } } } }, "/api/ServerInfo": { "get": { "tags": [ "ServerInfo" ], "summary": "ServerInfo: GetServerInfos", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ServerInfo-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ServerInfo_GetServerInfos_99AA9E243FD6", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ServerInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ServerInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ServerInfo" } } } } } } }, "/api/ServerInfo/{tableName}/GetDbTableDefaults": { "get": { "tags": [ "ServerInfo" ], "summary": "ServerInfo: GetDbTableDefaults", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ServerInfo-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ServerInfo_GetDbTableDefaults_7EF934C59C72", "parameters": [ { "name": "tableName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DbTableDefault" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DbTableDefault" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DbTableDefault" } } } } } } }, "/api/ShippingCarrier": { "get": { "tags": [ "ShippingCarrier" ], "summary": "ShippingCarrier: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ShippingCarrier-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ShippingCarrier_GetAll_28DD8820788E", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ShippingCarrier" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ShippingCarrier" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ShippingCarrier" } } } } } }, "post": { "tags": [ "ShippingCarrier" ], "summary": "ShippingCarrier: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ShippingCarrier-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ShippingCarrier_Post_35B76236663F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ShippingCarrier" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ShippingCarrier" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ShippingCarrier" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ShippingCarrier" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ShippingCarrier" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ShippingCarrier" } } } } } }, "put": { "tags": [ "ShippingCarrier" ], "summary": "ShippingCarrier: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ShippingCarrier-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ShippingCarrier_Put_6E01F9CE7FEC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ShippingCarrier" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ShippingCarrier" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ShippingCarrier" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ShippingCarrier" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ShippingCarrier" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ShippingCarrier" } } } } } } }, "/api/ShippingCarrier/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "ShippingCarrier" ], "summary": "ShippingCarrier: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ShippingCarrier-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ShippingCarrier_GetPageByValue_2A95EF280E9D", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ShippingCarrier/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "ShippingCarrier" ], "summary": "ShippingCarrier: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ShippingCarrier-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ShippingCarrier_GetPageByValue2_06E62B91E2DD", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ShippingCarrier/DeleteByFilter": { "post": { "tags": [ "ShippingCarrier" ], "summary": "ShippingCarrier: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ShippingCarrier-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ShippingCarrier_DeleteByFilter_AA7B97A866DB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/ShippingCarrier/GetAllByValue": { "post": { "tags": [ "ShippingCarrier" ], "summary": "ShippingCarrier: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ShippingCarrier-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ShippingCarrier_GetAllByValue_5B3EEFF5AC80", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ShippingCarrier" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ShippingCarrier" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ShippingCarrier" } } } } } } }, "/api/ShippingCarrier/GetAllGraphByValue": { "post": { "tags": [ "ShippingCarrier" ], "summary": "ShippingCarrier: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ShippingCarrier-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ShippingCarrier_GetAllGraphByValue_8EE9EA0F644F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ShippingCarrier" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ShippingCarrier" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ShippingCarrier" } } } } } } }, "/api/ShippingCarrier/GetByValue": { "post": { "tags": [ "ShippingCarrier" ], "summary": "ShippingCarrier: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ShippingCarrier-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ShippingCarrier_GetByValue_0CA7395BDF1A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ShippingCarrier" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ShippingCarrier" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ShippingCarrier" } } } } } } }, "/api/ShippingCarrier/GetLookup": { "post": { "tags": [ "ShippingCarrier" ], "summary": "ShippingCarrier: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ShippingCarrier-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ShippingCarrier_GetLookup_1AD84EF5A5D0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ShippingCarrier/GetLookupByValue": { "post": { "tags": [ "ShippingCarrier" ], "summary": "ShippingCarrier: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ShippingCarrier-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ShippingCarrier_GetLookupByValue_F5E9AD787D01", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ShippingCarrier/Page": { "get": { "tags": [ "ShippingCarrier" ], "summary": "ShippingCarrier: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ShippingCarrier-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ShippingCarrier_GetPage_26D2F798705B", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ShippingCarrier/PageAsc": { "get": { "tags": [ "ShippingCarrier" ], "summary": "ShippingCarrier: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ShippingCarrier-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ShippingCarrier_GetPageAsc_FA7BAAF0B484", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ShippingCarrier/SearchByValue": { "post": { "tags": [ "ShippingCarrier" ], "summary": "ShippingCarrier: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ShippingCarrier-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ShippingCarrier_SearchByValue_76305410E688", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ShippingCarrier" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ShippingCarrier" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ShippingCarrier" } } } } } } }, "/api/ShippingCarrier/TryGetByValue": { "post": { "tags": [ "ShippingCarrier" ], "summary": "ShippingCarrier: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ShippingCarrier-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ShippingCarrier_TryGetByValue_6404A8C77E1D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ShippingCarrier" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ShippingCarrier" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ShippingCarrier" } } } } } } }, "/api/ShippingCarrier/UpsertGraph": { "put": { "tags": [ "ShippingCarrier" ], "summary": "ShippingCarrier: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ShippingCarrier-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ShippingCarrier_UpsertGraph_4E893B449D3E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ShippingCarrier" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ShippingCarrier" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ShippingCarrier" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ShippingCarrier" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ShippingCarrier" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ShippingCarrier" } } } } } } }, "/api/ShippingCarrier/UpsertGraphWithExtraFields": { "put": { "tags": [ "ShippingCarrier" ], "summary": "ShippingCarrier: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ShippingCarrier-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ShippingCarrier_UpsertGraphWithExtraFields_B3D849672880", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ShippingCarrier" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ShippingCarrier" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ShippingCarrier" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ShippingCarrier" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ShippingCarrier" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ShippingCarrier" } } } } } } }, "/api/ShippingRate": { "get": { "tags": [ "ShippingRate" ], "summary": "ShippingRate: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ShippingRate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ShippingRate_GetAll_2AD9EF3470FA", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ShippingRate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ShippingRate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ShippingRate" } } } } } }, "post": { "tags": [ "ShippingRate" ], "summary": "ShippingRate: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ShippingRate-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ShippingRate_Post_3E87D80E7092", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ShippingRate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ShippingRate" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ShippingRate" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ShippingRate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ShippingRate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ShippingRate" } } } } } }, "put": { "tags": [ "ShippingRate" ], "summary": "ShippingRate: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ShippingRate-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ShippingRate_Put_8A6FE406D7EE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ShippingRate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ShippingRate" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ShippingRate" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ShippingRate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ShippingRate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ShippingRate" } } } } } } }, "/api/ShippingRate/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "ShippingRate" ], "summary": "ShippingRate: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ShippingRate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ShippingRate_GetPageByValue_A3F6F717F064", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ShippingRate/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "ShippingRate" ], "summary": "ShippingRate: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ShippingRate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ShippingRate_GetPageByValue2_E7131EB96977", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ShippingRate/DeleteByFilter": { "post": { "tags": [ "ShippingRate" ], "summary": "ShippingRate: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ShippingRate-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ShippingRate_DeleteByFilter_3A81953BC671", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/ShippingRate/GetAllByValue": { "post": { "tags": [ "ShippingRate" ], "summary": "ShippingRate: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ShippingRate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ShippingRate_GetAllByValue_A7DDC5048755", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ShippingRate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ShippingRate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ShippingRate" } } } } } } }, "/api/ShippingRate/GetAllGraphByValue": { "post": { "tags": [ "ShippingRate" ], "summary": "ShippingRate: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ShippingRate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ShippingRate_GetAllGraphByValue_A615C3BA9B99", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ShippingRate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ShippingRate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ShippingRate" } } } } } } }, "/api/ShippingRate/GetByValue": { "post": { "tags": [ "ShippingRate" ], "summary": "ShippingRate: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ShippingRate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ShippingRate_GetByValue_42B6FCE27A1C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ShippingRate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ShippingRate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ShippingRate" } } } } } } }, "/api/ShippingRate/GetLookup": { "post": { "tags": [ "ShippingRate" ], "summary": "ShippingRate: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ShippingRate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ShippingRate_GetLookup_437DB35BE279", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ShippingRate/GetLookupByValue": { "post": { "tags": [ "ShippingRate" ], "summary": "ShippingRate: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ShippingRate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ShippingRate_GetLookupByValue_294B1534D0E8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ShippingRate/Page": { "get": { "tags": [ "ShippingRate" ], "summary": "ShippingRate: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ShippingRate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ShippingRate_GetPage_7D3B0A095F34", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ShippingRate/PageAsc": { "get": { "tags": [ "ShippingRate" ], "summary": "ShippingRate: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ShippingRate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ShippingRate_GetPageAsc_70F65174D25C", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ShippingRate/SearchByValue": { "post": { "tags": [ "ShippingRate" ], "summary": "ShippingRate: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ShippingRate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ShippingRate_SearchByValue_800EA5AEC8FE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ShippingRate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ShippingRate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ShippingRate" } } } } } } }, "/api/ShippingRate/TryGetByValue": { "post": { "tags": [ "ShippingRate" ], "summary": "ShippingRate: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ShippingRate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ShippingRate_TryGetByValue_E4B89ADBC58C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ShippingRate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ShippingRate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ShippingRate" } } } } } } }, "/api/ShippingRate/UpsertGraph": { "put": { "tags": [ "ShippingRate" ], "summary": "ShippingRate: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ShippingRate-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ShippingRate_UpsertGraph_8152E959778F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ShippingRate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ShippingRate" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ShippingRate" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ShippingRate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ShippingRate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ShippingRate" } } } } } } }, "/api/ShippingRate/UpsertGraphWithExtraFields": { "put": { "tags": [ "ShippingRate" ], "summary": "ShippingRate: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ShippingRate-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ShippingRate_UpsertGraphWithExtraFields_87191246C1FD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ShippingRate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ShippingRate" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ShippingRate" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ShippingRate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ShippingRate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ShippingRate" } } } } } } }, "/api/ShippingType": { "get": { "tags": [ "ShippingType" ], "summary": "ShippingType: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ShippingType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ShippingType_GetAll_A48EA5F8D7B6", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ShippingType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ShippingType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ShippingType" } } } } } }, "post": { "tags": [ "ShippingType" ], "summary": "ShippingType: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ShippingType-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ShippingType_Post_11781016F1CD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ShippingType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ShippingType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ShippingType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ShippingType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ShippingType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ShippingType" } } } } } }, "put": { "tags": [ "ShippingType" ], "summary": "ShippingType: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ShippingType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ShippingType_Put_C233DB55013D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ShippingType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ShippingType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ShippingType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ShippingType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ShippingType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ShippingType" } } } } } } }, "/api/ShippingType/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "ShippingType" ], "summary": "ShippingType: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ShippingType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ShippingType_GetPageByValue_1CDC6CF5B391", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ShippingType/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "ShippingType" ], "summary": "ShippingType: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ShippingType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ShippingType_GetPageByValue2_FFD44791363D", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ShippingType/DeleteByFilter": { "post": { "tags": [ "ShippingType" ], "summary": "ShippingType: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ShippingType-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ShippingType_DeleteByFilter_3974CD64A34E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/ShippingType/GetAllByValue": { "post": { "tags": [ "ShippingType" ], "summary": "ShippingType: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ShippingType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ShippingType_GetAllByValue_7F5772998205", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ShippingType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ShippingType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ShippingType" } } } } } } }, "/api/ShippingType/GetAllGraphByValue": { "post": { "tags": [ "ShippingType" ], "summary": "ShippingType: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ShippingType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ShippingType_GetAllGraphByValue_5A397E2337CD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ShippingType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ShippingType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ShippingType" } } } } } } }, "/api/ShippingType/GetByValue": { "post": { "tags": [ "ShippingType" ], "summary": "ShippingType: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ShippingType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ShippingType_GetByValue_07BC23E739C5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ShippingType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ShippingType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ShippingType" } } } } } } }, "/api/ShippingType/GetLookup": { "post": { "tags": [ "ShippingType" ], "summary": "ShippingType: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ShippingType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ShippingType_GetLookup_A8CD2D5C20AA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ShippingType/GetLookupByValue": { "post": { "tags": [ "ShippingType" ], "summary": "ShippingType: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ShippingType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ShippingType_GetLookupByValue_E5519221D625", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ShippingType/Page": { "get": { "tags": [ "ShippingType" ], "summary": "ShippingType: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ShippingType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ShippingType_GetPage_040B507AF53D", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ShippingType/PageAsc": { "get": { "tags": [ "ShippingType" ], "summary": "ShippingType: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ShippingType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ShippingType_GetPageAsc_184B5709DF20", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ShippingType/SearchByValue": { "post": { "tags": [ "ShippingType" ], "summary": "ShippingType: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ShippingType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ShippingType_SearchByValue_D689EBD793D2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ShippingType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ShippingType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ShippingType" } } } } } } }, "/api/ShippingType/TryGetByValue": { "post": { "tags": [ "ShippingType" ], "summary": "ShippingType: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ShippingType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ShippingType_TryGetByValue_3551373454C1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ShippingType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ShippingType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ShippingType" } } } } } } }, "/api/ShippingType/UpsertGraph": { "put": { "tags": [ "ShippingType" ], "summary": "ShippingType: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ShippingType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ShippingType_UpsertGraph_1253F8F46177", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ShippingType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ShippingType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ShippingType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ShippingType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ShippingType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ShippingType" } } } } } } }, "/api/ShippingType/UpsertGraphWithExtraFields": { "put": { "tags": [ "ShippingType" ], "summary": "ShippingType: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ShippingType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ShippingType_UpsertGraphWithExtraFields_0905B90F4935", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ShippingType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ShippingType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ShippingType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ShippingType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ShippingType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ShippingType" } } } } } } }, "/api/ShippingZone": { "get": { "tags": [ "ShippingZone" ], "summary": "ShippingZone: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ShippingZone-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ShippingZone_GetAll_4CF8569EE451", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ShippingZone" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ShippingZone" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ShippingZone" } } } } } }, "post": { "tags": [ "ShippingZone" ], "summary": "ShippingZone: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ShippingZone-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ShippingZone_Post_F9A051818D03", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ShippingZone" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ShippingZone" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ShippingZone" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ShippingZone" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ShippingZone" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ShippingZone" } } } } } }, "put": { "tags": [ "ShippingZone" ], "summary": "ShippingZone: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ShippingZone-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ShippingZone_Put_9CD1E5040499", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ShippingZone" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ShippingZone" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ShippingZone" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ShippingZone" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ShippingZone" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ShippingZone" } } } } } } }, "/api/ShippingZone/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "ShippingZone" ], "summary": "ShippingZone: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ShippingZone-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ShippingZone_GetPageByValue_B749894EEDB8", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ShippingZone/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "ShippingZone" ], "summary": "ShippingZone: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ShippingZone-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ShippingZone_GetPageByValue2_4E07BFE6FB5B", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ShippingZone/DeleteByFilter": { "post": { "tags": [ "ShippingZone" ], "summary": "ShippingZone: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ShippingZone-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ShippingZone_DeleteByFilter_35E8E1D7606C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/ShippingZone/GetAllByValue": { "post": { "tags": [ "ShippingZone" ], "summary": "ShippingZone: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ShippingZone-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ShippingZone_GetAllByValue_1459F1400839", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ShippingZone" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ShippingZone" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ShippingZone" } } } } } } }, "/api/ShippingZone/GetAllGraphByValue": { "post": { "tags": [ "ShippingZone" ], "summary": "ShippingZone: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ShippingZone-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ShippingZone_GetAllGraphByValue_33AFEA46EE7E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ShippingZone" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ShippingZone" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ShippingZone" } } } } } } }, "/api/ShippingZone/GetByValue": { "post": { "tags": [ "ShippingZone" ], "summary": "ShippingZone: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ShippingZone-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ShippingZone_GetByValue_56BDD4E98A69", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ShippingZone" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ShippingZone" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ShippingZone" } } } } } } }, "/api/ShippingZone/GetLookup": { "post": { "tags": [ "ShippingZone" ], "summary": "ShippingZone: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ShippingZone-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ShippingZone_GetLookup_C27CC4DC82FE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ShippingZone/GetLookupByValue": { "post": { "tags": [ "ShippingZone" ], "summary": "ShippingZone: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ShippingZone-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ShippingZone_GetLookupByValue_EA1D29B88523", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ShippingZone/Page": { "get": { "tags": [ "ShippingZone" ], "summary": "ShippingZone: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ShippingZone-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ShippingZone_GetPage_C3FA15533AAF", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ShippingZone/PageAsc": { "get": { "tags": [ "ShippingZone" ], "summary": "ShippingZone: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ShippingZone-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ShippingZone_GetPageAsc_BE9EA5F7FD9A", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ShippingZone/SearchByValue": { "post": { "tags": [ "ShippingZone" ], "summary": "ShippingZone: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ShippingZone-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ShippingZone_SearchByValue_8444DD7B1ABF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ShippingZone" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ShippingZone" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ShippingZone" } } } } } } }, "/api/ShippingZone/TryGetByValue": { "post": { "tags": [ "ShippingZone" ], "summary": "ShippingZone: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ShippingZone-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ShippingZone_TryGetByValue_37502E52DAC4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ShippingZone" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ShippingZone" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ShippingZone" } } } } } } }, "/api/ShippingZone/UpsertGraph": { "put": { "tags": [ "ShippingZone" ], "summary": "ShippingZone: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ShippingZone-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ShippingZone_UpsertGraph_1A23C5465839", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ShippingZone" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ShippingZone" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ShippingZone" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ShippingZone" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ShippingZone" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ShippingZone" } } } } } } }, "/api/ShippingZone/UpsertGraphWithExtraFields": { "put": { "tags": [ "ShippingZone" ], "summary": "ShippingZone: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ShippingZone-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ShippingZone_UpsertGraphWithExtraFields_24891C44994C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ShippingZone" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ShippingZone" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ShippingZone" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ShippingZone" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ShippingZone" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ShippingZone" } } } } } } }, "/api/SmartPool": { "get": { "tags": [ "SmartPool" ], "summary": "SmartPool: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SmartPool-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SmartPool_GetAll_AE1C9A67A2B3", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SmartPool" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SmartPool" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SmartPool" } } } } } }, "post": { "tags": [ "SmartPool" ], "summary": "SmartPool: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SmartPool-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SmartPool_Post_BEB4EFEB4C95", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SmartPool" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SmartPool" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SmartPool" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SmartPool" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SmartPool" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SmartPool" } } } } } }, "put": { "tags": [ "SmartPool" ], "summary": "SmartPool: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SmartPool-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SmartPool_Put_82DC3A23B683", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SmartPool" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SmartPool" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SmartPool" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SmartPool" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SmartPool" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SmartPool" } } } } } } }, "/api/SmartPool/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "SmartPool" ], "summary": "SmartPool: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SmartPool-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SmartPool_GetPageByValue_ECA3F3878C86", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/SmartPool/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "SmartPool" ], "summary": "SmartPool: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SmartPool-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SmartPool_GetPageByValue2_F1F87CAE0FC2", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/SmartPool/BlockDocument/{smartPoolId}": { "put": { "tags": [ "SmartPool" ], "summary": "SmartPool: BlockDocument", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SmartPool-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SmartPool_BlockDocument_EDF01C3C3DDC", "parameters": [ { "name": "smartPoolId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SmartPool" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SmartPool" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SmartPool" } } } } } } }, "/api/SmartPool/CopyDocument/{smartPoolId}": { "post": { "tags": [ "SmartPool" ], "summary": "SmartPool: CopyDocument", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SmartPool-Create.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SmartPool_CopyDocument_1C54DD7AAC30", "parameters": [ { "name": "smartPoolId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SmartPool" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SmartPool" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SmartPool" } } } } } } }, "/api/SmartPool/CreateEditorFile": { "post": { "tags": [ "SmartPool" ], "summary": "SmartPool: CreateEditorFile", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SmartPool-Create.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SmartPool_CreateEditorFile_7AF136B1EBAD", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } }, "encoding": { "file": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SmartPool" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SmartPool" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SmartPool" } } } } } } }, "/api/SmartPool/DeleteByFilter": { "post": { "tags": [ "SmartPool" ], "summary": "SmartPool: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SmartPool-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SmartPool_DeleteByFilter_34B865EB3C74", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/SmartPool/DownloadSmartPoolFile/{SmartPoolId}": { "get": { "tags": [ "SmartPool" ], "summary": "SmartPool: DownloadSmartPoolFile", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SmartPool-Read.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SmartPool_DownloadSmartPoolFile_674400AD359F", "parameters": [ { "name": "SmartPoolId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/SmartPool/GetAiInsights/{smartPoolId}": { "get": { "tags": [ "SmartPool" ], "summary": "SmartPool: GetAiInsights", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SmartPool-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SmartPool_GetAiInsights_A4BB07680D6D", "parameters": [ { "name": "smartPoolId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dto.SmartPoolAiInsightsDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dto.SmartPoolAiInsightsDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dto.SmartPoolAiInsightsDto" } } } } } } }, "/api/SmartPool/GetAllByValue": { "post": { "tags": [ "SmartPool" ], "summary": "SmartPool: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SmartPool-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SmartPool_GetAllByValue_7B48770023F7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SmartPool" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SmartPool" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SmartPool" } } } } } } }, "/api/SmartPool/GetAllGraphByValue": { "post": { "tags": [ "SmartPool" ], "summary": "SmartPool: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SmartPool-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SmartPool_GetAllGraphByValue_A1280FA8BF02", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SmartPool" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SmartPool" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SmartPool" } } } } } } }, "/api/SmartPool/GetByReferenceGuid/{referenceGuid}": { "get": { "tags": [ "SmartPool" ], "summary": "SmartPool: GetByReferenceGuid", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SmartPool-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SmartPool_GetByReferenceGuid_BB15265CDE03", "parameters": [ { "name": "referenceGuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SmartPool" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SmartPool" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SmartPool" } } } } } } }, "/api/SmartPool/GetByValue": { "post": { "tags": [ "SmartPool" ], "summary": "SmartPool: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SmartPool-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SmartPool_GetByValue_932EB37A0629", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SmartPool" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SmartPool" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SmartPool" } } } } } } }, "/api/SmartPool/GetCopyStatus/{smartPoolId}": { "get": { "tags": [ "SmartPool" ], "summary": "SmartPool: GetCopyStatus", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SmartPool-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SmartPool_GetCopyStatus_0C6459C6F2EF", "parameters": [ { "name": "smartPoolId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dto.SmartPoolCopyStatusDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dto.SmartPoolCopyStatusDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dto.SmartPoolCopyStatusDto" } } } } } } }, "/api/SmartPool/GetDuplicates/{smartPoolId}": { "get": { "tags": [ "SmartPool" ], "summary": "SmartPool: GetDuplicates", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SmartPool-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SmartPool_GetDuplicates_6F8DC5B694AB", "parameters": [ { "name": "smartPoolId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW_SmartPool" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW_SmartPool" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW_SmartPool" } } } } } } }, "/api/SmartPool/GetEditorFiles": { "get": { "tags": [ "SmartPool" ], "summary": "SmartPool: GetEditorFiles", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SmartPool-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SmartPool_GetEditorFiles_BD9F56F9E96D", "parameters": [ { "name": "extension", "in": "query", "schema": { "type": "string" } }, { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "id", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SmartPool" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SmartPool" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SmartPool" } } } } } } }, "/api/SmartPool/GetLookup": { "post": { "tags": [ "SmartPool" ], "summary": "SmartPool: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SmartPool-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SmartPool_GetLookup_0B299ED317CC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/SmartPool/GetLookupByValue": { "post": { "tags": [ "SmartPool" ], "summary": "SmartPool: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SmartPool-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SmartPool_GetLookupByValue_02945FF1A936", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/SmartPool/GetVersions/{smartPoolId}": { "get": { "tags": [ "SmartPool" ], "summary": "SmartPool: GetVersions", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SmartPool-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SmartPool_GetVersions_A35518BBC091", "parameters": [ { "name": "smartPoolId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dto.SmartPoolVersionsDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dto.SmartPoolVersionsDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dto.SmartPoolVersionsDto" } } } } } } }, "/api/SmartPool/Page": { "get": { "tags": [ "SmartPool" ], "summary": "SmartPool: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SmartPool-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SmartPool_GetPage_6B3C636F1062", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/SmartPool/PageAsc": { "get": { "tags": [ "SmartPool" ], "summary": "SmartPool: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SmartPool-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SmartPool_GetPageAsc_6D305604D68F", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/SmartPool/PageFromView": { "get": { "tags": [ "SmartPool" ], "summary": "SmartPool: GetPageFromView", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SmartPool-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SmartPool_GetPageFromView_2E02918E39CB", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/SmartPool/SearchByValue": { "post": { "tags": [ "SmartPool" ], "summary": "SmartPool: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SmartPool-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SmartPool_SearchByValue_DA77A24E2137", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.SmartPool" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.SmartPool" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.SmartPool" } } } } } } }, "/api/SmartPool/TryGetByValue": { "post": { "tags": [ "SmartPool" ], "summary": "SmartPool: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SmartPool-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SmartPool_TryGetByValue_D41D7DCB5242", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SmartPool" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SmartPool" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SmartPool" } } } } } } }, "/api/SmartPool/UpdateSmartPoolFile/{smartPoolId}": { "put": { "tags": [ "SmartPool" ], "summary": "SmartPool: UpdateSmartPoolFile", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SmartPool-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SmartPool_UpdateSmartPoolFile_2977EC8252A7", "parameters": [ { "name": "smartPoolId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" }, "rowVersion": { "type": "string" } } }, "encoding": { "file": { "style": "form" }, "rowVersion": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SmartPool" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SmartPool" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SmartPool" } } } } } } }, "/api/SmartPool/UploadChunkFile/{referenceGuid}": { "post": { "tags": [ "SmartPool" ], "summary": "SmartPool: UploadChunkFile", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SmartPool-Create.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SmartPool_UploadChunkFile_D2BA71415FBB", "parameters": [ { "name": "referenceGuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "fileChunk": { "type": "string", "format": "binary" } } }, "encoding": { "fileChunk": { "style": "form" } } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/SmartPool/UpsertGraph": { "put": { "tags": [ "SmartPool" ], "summary": "SmartPool: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SmartPool-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SmartPool_UpsertGraph_72D64A849D23", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SmartPool" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SmartPool" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SmartPool" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SmartPool" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SmartPool" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SmartPool" } } } } } } }, "/api/SmartPool/UpsertGraphWithExtraFields": { "put": { "tags": [ "SmartPool" ], "summary": "SmartPool: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SmartPool-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SmartPool_UpsertGraphWithExtraFields_54C4A522682F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SmartPool" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SmartPool" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SmartPool" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SmartPool" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SmartPool" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SmartPool" } } } } } } }, "/api/SmartPoolApproval": { "get": { "tags": [ "SmartPoolApproval" ], "summary": "SmartPoolApproval: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SmartPoolApproval-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SmartPoolApproval_GetAll_160E12D852C1", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SmartPoolApproval" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SmartPoolApproval" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SmartPoolApproval" } } } } } }, "post": { "tags": [ "SmartPoolApproval" ], "summary": "SmartPoolApproval: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SmartPoolApproval-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SmartPoolApproval_Post_45B100B584A2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SmartPoolApproval" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SmartPoolApproval" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SmartPoolApproval" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SmartPoolApproval" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SmartPoolApproval" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SmartPoolApproval" } } } } } }, "put": { "tags": [ "SmartPoolApproval" ], "summary": "SmartPoolApproval: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SmartPoolApproval-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SmartPoolApproval_Put_BEAF6AAAFD52", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SmartPoolApproval" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SmartPoolApproval" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SmartPoolApproval" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SmartPoolApproval" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SmartPoolApproval" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SmartPoolApproval" } } } } } } }, "/api/SmartPoolApproval/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "SmartPoolApproval" ], "summary": "SmartPoolApproval: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SmartPoolApproval-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SmartPoolApproval_GetPageByValue_C62C32734F51", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/SmartPoolApproval/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "SmartPoolApproval" ], "summary": "SmartPoolApproval: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SmartPoolApproval-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SmartPoolApproval_GetPageByValue2_20E09531AFB5", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/SmartPoolApproval/{SmartPoolId}/PageFromViewBySmartPoolId": { "get": { "tags": [ "SmartPoolApproval" ], "summary": "SmartPoolApproval: GetPageFromViewBySmartPoolId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SmartPoolApproval-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SmartPoolApproval_GetPageFromViewBySmartPoolId_C58F146A6E87", "parameters": [ { "name": "SmartPoolId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/SmartPoolApproval/DeleteByFilter": { "post": { "tags": [ "SmartPoolApproval" ], "summary": "SmartPoolApproval: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SmartPoolApproval-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SmartPoolApproval_DeleteByFilter_0280C3B84648", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/SmartPoolApproval/GetAllByValue": { "post": { "tags": [ "SmartPoolApproval" ], "summary": "SmartPoolApproval: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SmartPoolApproval-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SmartPoolApproval_GetAllByValue_44976A0AB7C0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SmartPoolApproval" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SmartPoolApproval" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SmartPoolApproval" } } } } } } }, "/api/SmartPoolApproval/GetAllGraphByValue": { "post": { "tags": [ "SmartPoolApproval" ], "summary": "SmartPoolApproval: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SmartPoolApproval-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SmartPoolApproval_GetAllGraphByValue_E433B12421ED", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SmartPoolApproval" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SmartPoolApproval" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SmartPoolApproval" } } } } } } }, "/api/SmartPoolApproval/GetByValue": { "post": { "tags": [ "SmartPoolApproval" ], "summary": "SmartPoolApproval: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SmartPoolApproval-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SmartPoolApproval_GetByValue_C444281BB5E2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SmartPoolApproval" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SmartPoolApproval" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SmartPoolApproval" } } } } } } }, "/api/SmartPoolApproval/GetLookup": { "post": { "tags": [ "SmartPoolApproval" ], "summary": "SmartPoolApproval: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SmartPoolApproval-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SmartPoolApproval_GetLookup_8B6DCDD75F33", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/SmartPoolApproval/GetLookupByValue": { "post": { "tags": [ "SmartPoolApproval" ], "summary": "SmartPoolApproval: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SmartPoolApproval-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SmartPoolApproval_GetLookupByValue_CE35E66B6D7D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/SmartPoolApproval/HasApproval/{smartPoolId}": { "get": { "tags": [ "SmartPoolApproval" ], "summary": "SmartPoolApproval: HasApproval", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SmartPoolApproval-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SmartPoolApproval_HasApproval_20DB4E5BCB84", "parameters": [ { "name": "smartPoolId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/SmartPoolApproval/Page": { "get": { "tags": [ "SmartPoolApproval" ], "summary": "SmartPoolApproval: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SmartPoolApproval-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SmartPoolApproval_GetPage_BE8096B55B24", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/SmartPoolApproval/PageAsc": { "get": { "tags": [ "SmartPoolApproval" ], "summary": "SmartPoolApproval: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SmartPoolApproval-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SmartPoolApproval_GetPageAsc_DB7DB0D93725", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/SmartPoolApproval/SearchByValue": { "post": { "tags": [ "SmartPoolApproval" ], "summary": "SmartPoolApproval: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SmartPoolApproval-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SmartPoolApproval_SearchByValue_BFEDDB1699AB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.SmartPoolApproval" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.SmartPoolApproval" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.SmartPoolApproval" } } } } } } }, "/api/SmartPoolApproval/TryGetByValue": { "post": { "tags": [ "SmartPoolApproval" ], "summary": "SmartPoolApproval: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SmartPoolApproval-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SmartPoolApproval_TryGetByValue_E1898B6FF31D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SmartPoolApproval" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SmartPoolApproval" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SmartPoolApproval" } } } } } } }, "/api/SmartPoolApproval/UpsertGraph": { "put": { "tags": [ "SmartPoolApproval" ], "summary": "SmartPoolApproval: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SmartPoolApproval-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SmartPoolApproval_UpsertGraph_1DF9C919E70F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SmartPoolApproval" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SmartPoolApproval" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SmartPoolApproval" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SmartPoolApproval" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SmartPoolApproval" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SmartPoolApproval" } } } } } } }, "/api/SmartPoolApproval/UpsertGraphWithExtraFields": { "put": { "tags": [ "SmartPoolApproval" ], "summary": "SmartPoolApproval: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SmartPoolApproval-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SmartPoolApproval_UpsertGraphWithExtraFields_F535F1735BA0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SmartPoolApproval" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SmartPoolApproval" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SmartPoolApproval" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SmartPoolApproval" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SmartPoolApproval" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SmartPoolApproval" } } } } } } }, "/api/SmartPoolLinkedEntity": { "get": { "tags": [ "SmartPoolLinkedEntity" ], "summary": "SmartPoolLinkedEntity: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SmartPoolLinkedEntity-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SmartPoolLinkedEntity_GetAll_AD1ECA54E11D", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SmartPoolLinkedEntity" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SmartPoolLinkedEntity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SmartPoolLinkedEntity" } } } } } }, "post": { "tags": [ "SmartPoolLinkedEntity" ], "summary": "SmartPoolLinkedEntity: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SmartPoolLinkedEntity-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SmartPoolLinkedEntity_Post_53BD32DF2104", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SmartPoolLinkedEntity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SmartPoolLinkedEntity" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SmartPoolLinkedEntity" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SmartPoolLinkedEntity" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SmartPoolLinkedEntity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SmartPoolLinkedEntity" } } } } } }, "put": { "tags": [ "SmartPoolLinkedEntity" ], "summary": "SmartPoolLinkedEntity: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SmartPoolLinkedEntity-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SmartPoolLinkedEntity_Put_ED1A4071F5D8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SmartPoolLinkedEntity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SmartPoolLinkedEntity" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SmartPoolLinkedEntity" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SmartPoolLinkedEntity" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SmartPoolLinkedEntity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SmartPoolLinkedEntity" } } } } } } }, "/api/SmartPoolLinkedEntity/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "SmartPoolLinkedEntity" ], "summary": "SmartPoolLinkedEntity: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SmartPoolLinkedEntity-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SmartPoolLinkedEntity_GetPageByValue_3CEA10E0A25A", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/SmartPoolLinkedEntity/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "SmartPoolLinkedEntity" ], "summary": "SmartPoolLinkedEntity: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SmartPoolLinkedEntity-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SmartPoolLinkedEntity_GetPageByValue2_D888077CFC6A", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/SmartPoolLinkedEntity/{SmartPoolId}/PageFromViewBySmartPoolId": { "get": { "tags": [ "SmartPoolLinkedEntity" ], "summary": "SmartPoolLinkedEntity: GetPageFromViewBySmartPoolId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SmartPoolLinkedEntity-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SmartPoolLinkedEntity_GetPageFromViewBySmartPoolId_AED3DB93D921", "parameters": [ { "name": "SmartPoolId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/SmartPoolLinkedEntity/DeleteByFilter": { "post": { "tags": [ "SmartPoolLinkedEntity" ], "summary": "SmartPoolLinkedEntity: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SmartPoolLinkedEntity-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SmartPoolLinkedEntity_DeleteByFilter_D8FC34487898", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/SmartPoolLinkedEntity/GetAllByValue": { "post": { "tags": [ "SmartPoolLinkedEntity" ], "summary": "SmartPoolLinkedEntity: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SmartPoolLinkedEntity-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SmartPoolLinkedEntity_GetAllByValue_A594E0545BCF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SmartPoolLinkedEntity" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SmartPoolLinkedEntity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SmartPoolLinkedEntity" } } } } } } }, "/api/SmartPoolLinkedEntity/GetAllGraphByValue": { "post": { "tags": [ "SmartPoolLinkedEntity" ], "summary": "SmartPoolLinkedEntity: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SmartPoolLinkedEntity-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SmartPoolLinkedEntity_GetAllGraphByValue_93D98F37A90E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SmartPoolLinkedEntity" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SmartPoolLinkedEntity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SmartPoolLinkedEntity" } } } } } } }, "/api/SmartPoolLinkedEntity/GetByValue": { "post": { "tags": [ "SmartPoolLinkedEntity" ], "summary": "SmartPoolLinkedEntity: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SmartPoolLinkedEntity-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SmartPoolLinkedEntity_GetByValue_8CFFF5EE5A11", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SmartPoolLinkedEntity" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SmartPoolLinkedEntity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SmartPoolLinkedEntity" } } } } } } }, "/api/SmartPoolLinkedEntity/GetLookup": { "post": { "tags": [ "SmartPoolLinkedEntity" ], "summary": "SmartPoolLinkedEntity: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SmartPoolLinkedEntity-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SmartPoolLinkedEntity_GetLookup_F34EA7EA3B2E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/SmartPoolLinkedEntity/GetLookupByValue": { "post": { "tags": [ "SmartPoolLinkedEntity" ], "summary": "SmartPoolLinkedEntity: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SmartPoolLinkedEntity-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SmartPoolLinkedEntity_GetLookupByValue_1821E93FB2D6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/SmartPoolLinkedEntity/Page": { "get": { "tags": [ "SmartPoolLinkedEntity" ], "summary": "SmartPoolLinkedEntity: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SmartPoolLinkedEntity-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SmartPoolLinkedEntity_GetPage_92461C7F0ACB", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/SmartPoolLinkedEntity/PageAsc": { "get": { "tags": [ "SmartPoolLinkedEntity" ], "summary": "SmartPoolLinkedEntity: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SmartPoolLinkedEntity-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SmartPoolLinkedEntity_GetPageAsc_6C501C591BC7", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/SmartPoolLinkedEntity/PageFromView": { "get": { "tags": [ "SmartPoolLinkedEntity" ], "summary": "SmartPoolLinkedEntity: GetPageFromView", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SmartPoolLinkedEntity-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SmartPoolLinkedEntity_GetPageFromView_78D24FD8CC54", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/SmartPoolLinkedEntity/SearchByValue": { "post": { "tags": [ "SmartPoolLinkedEntity" ], "summary": "SmartPoolLinkedEntity: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SmartPoolLinkedEntity-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SmartPoolLinkedEntity_SearchByValue_A6AB791BE2F0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.SmartPoolLinkedEntity" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.SmartPoolLinkedEntity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.SmartPoolLinkedEntity" } } } } } } }, "/api/SmartPoolLinkedEntity/TryGetByValue": { "post": { "tags": [ "SmartPoolLinkedEntity" ], "summary": "SmartPoolLinkedEntity: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SmartPoolLinkedEntity-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SmartPoolLinkedEntity_TryGetByValue_6A00ADE2D706", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SmartPoolLinkedEntity" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SmartPoolLinkedEntity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SmartPoolLinkedEntity" } } } } } } }, "/api/SmartPoolLinkedEntity/UpsertGraph": { "put": { "tags": [ "SmartPoolLinkedEntity" ], "summary": "SmartPoolLinkedEntity: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SmartPoolLinkedEntity-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SmartPoolLinkedEntity_UpsertGraph_83086994B59C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SmartPoolLinkedEntity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SmartPoolLinkedEntity" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SmartPoolLinkedEntity" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SmartPoolLinkedEntity" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SmartPoolLinkedEntity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SmartPoolLinkedEntity" } } } } } } }, "/api/SmartPoolLinkedEntity/UpsertGraphWithExtraFields": { "put": { "tags": [ "SmartPoolLinkedEntity" ], "summary": "SmartPoolLinkedEntity: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SmartPoolLinkedEntity-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SmartPoolLinkedEntity_UpsertGraphWithExtraFields_DB2AE453C426", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SmartPoolLinkedEntity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SmartPoolLinkedEntity" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SmartPoolLinkedEntity" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SmartPoolLinkedEntity" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SmartPoolLinkedEntity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SmartPoolLinkedEntity" } } } } } } }, "/api/SmartPoolOcr": { "get": { "tags": [ "SmartPoolOcr" ], "summary": "SmartPoolOcr: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SmartPoolOcr-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SmartPoolOcr_GetAll_77264B6AEEF7", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SmartPoolOcr" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SmartPoolOcr" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SmartPoolOcr" } } } } } }, "post": { "tags": [ "SmartPoolOcr" ], "summary": "SmartPoolOcr: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SmartPoolOcr-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SmartPoolOcr_Post_8AD9A926C491", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SmartPoolOcr" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SmartPoolOcr" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SmartPoolOcr" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SmartPoolOcr" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SmartPoolOcr" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SmartPoolOcr" } } } } } }, "put": { "tags": [ "SmartPoolOcr" ], "summary": "SmartPoolOcr: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SmartPoolOcr-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SmartPoolOcr_Put_222A2CA85E29", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SmartPoolOcr" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SmartPoolOcr" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SmartPoolOcr" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SmartPoolOcr" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SmartPoolOcr" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SmartPoolOcr" } } } } } } }, "/api/SmartPoolOcr/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "SmartPoolOcr" ], "summary": "SmartPoolOcr: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SmartPoolOcr-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SmartPoolOcr_GetPageByValue_75F804187656", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/SmartPoolOcr/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "SmartPoolOcr" ], "summary": "SmartPoolOcr: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SmartPoolOcr-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SmartPoolOcr_GetPageByValue2_1262E70164E1", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/SmartPoolOcr/DeleteByFilter": { "post": { "tags": [ "SmartPoolOcr" ], "summary": "SmartPoolOcr: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SmartPoolOcr-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SmartPoolOcr_DeleteByFilter_269970DB048C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/SmartPoolOcr/GetAllByValue": { "post": { "tags": [ "SmartPoolOcr" ], "summary": "SmartPoolOcr: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SmartPoolOcr-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SmartPoolOcr_GetAllByValue_988715CDB836", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SmartPoolOcr" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SmartPoolOcr" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SmartPoolOcr" } } } } } } }, "/api/SmartPoolOcr/GetAllGraphByValue": { "post": { "tags": [ "SmartPoolOcr" ], "summary": "SmartPoolOcr: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SmartPoolOcr-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SmartPoolOcr_GetAllGraphByValue_B5FFC3C680C1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SmartPoolOcr" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SmartPoolOcr" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SmartPoolOcr" } } } } } } }, "/api/SmartPoolOcr/GetByValue": { "post": { "tags": [ "SmartPoolOcr" ], "summary": "SmartPoolOcr: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SmartPoolOcr-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SmartPoolOcr_GetByValue_0F25A2681C31", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SmartPoolOcr" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SmartPoolOcr" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SmartPoolOcr" } } } } } } }, "/api/SmartPoolOcr/GetLookup": { "post": { "tags": [ "SmartPoolOcr" ], "summary": "SmartPoolOcr: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SmartPoolOcr-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SmartPoolOcr_GetLookup_FEC50FA67B94", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/SmartPoolOcr/GetLookupByValue": { "post": { "tags": [ "SmartPoolOcr" ], "summary": "SmartPoolOcr: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SmartPoolOcr-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SmartPoolOcr_GetLookupByValue_74691999D824", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/SmartPoolOcr/Page": { "get": { "tags": [ "SmartPoolOcr" ], "summary": "SmartPoolOcr: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SmartPoolOcr-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SmartPoolOcr_GetPage_7A87A7AE4CC2", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/SmartPoolOcr/PageAsc": { "get": { "tags": [ "SmartPoolOcr" ], "summary": "SmartPoolOcr: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SmartPoolOcr-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SmartPoolOcr_GetPageAsc_94957B5987C0", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/SmartPoolOcr/SearchByValue": { "post": { "tags": [ "SmartPoolOcr" ], "summary": "SmartPoolOcr: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SmartPoolOcr-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SmartPoolOcr_SearchByValue_6C56945F44A8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.SmartPoolOcr" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.SmartPoolOcr" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.SmartPoolOcr" } } } } } } }, "/api/SmartPoolOcr/TryGetByValue": { "post": { "tags": [ "SmartPoolOcr" ], "summary": "SmartPoolOcr: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SmartPoolOcr-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SmartPoolOcr_TryGetByValue_DDA63F3E6864", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SmartPoolOcr" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SmartPoolOcr" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SmartPoolOcr" } } } } } } }, "/api/SmartPoolOcr/UpsertGraph": { "put": { "tags": [ "SmartPoolOcr" ], "summary": "SmartPoolOcr: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SmartPoolOcr-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SmartPoolOcr_UpsertGraph_DE81CDDEF428", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SmartPoolOcr" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SmartPoolOcr" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SmartPoolOcr" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SmartPoolOcr" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SmartPoolOcr" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SmartPoolOcr" } } } } } } }, "/api/SmartPoolOcr/UpsertGraphWithExtraFields": { "put": { "tags": [ "SmartPoolOcr" ], "summary": "SmartPoolOcr: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SmartPoolOcr-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SmartPoolOcr_UpsertGraphWithExtraFields_5B284E51E2A6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SmartPoolOcr" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SmartPoolOcr" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SmartPoolOcr" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SmartPoolOcr" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SmartPoolOcr" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SmartPoolOcr" } } } } } } }, "/api/SmartSearch/Search": { "post": { "tags": [ "SmartSearch" ], "summary": "SmartSearch: Search", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SmartSearch-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SmartSearch_Search_B9B1F4FB19F6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SmartSearchRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SmartSearchRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SmartSearchRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SmartSearchResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SmartSearchResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SmartSearchResponse" } } } } } } }, "/api/StickyNote": { "get": { "tags": [ "StickyNote" ], "summary": "StickyNote: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: StickyNote-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "StickyNote_GetAll_31CD716DC094", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.StickyNote" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.StickyNote" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.StickyNote" } } } } } }, "post": { "tags": [ "StickyNote" ], "summary": "StickyNote: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: StickyNote-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "StickyNote_Post_C838A0FFC84D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.StickyNote" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.StickyNote" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.StickyNote" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.StickyNote" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.StickyNote" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.StickyNote" } } } } } }, "put": { "tags": [ "StickyNote" ], "summary": "StickyNote: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: StickyNote-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "StickyNote_Put_CF983CF43AD5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.StickyNote" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.StickyNote" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.StickyNote" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.StickyNote" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.StickyNote" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.StickyNote" } } } } } } }, "/api/StickyNote/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "StickyNote" ], "summary": "StickyNote: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: StickyNote-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "StickyNote_GetPageByValue_C55509304B80", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/StickyNote/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "StickyNote" ], "summary": "StickyNote: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: StickyNote-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "StickyNote_GetPageByValue2_A58AC4A63577", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/StickyNote/DeleteByFilter": { "post": { "tags": [ "StickyNote" ], "summary": "StickyNote: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: StickyNote-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "StickyNote_DeleteByFilter_4D4FC6A37BB5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/StickyNote/GetAllByValue": { "post": { "tags": [ "StickyNote" ], "summary": "StickyNote: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: StickyNote-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "StickyNote_GetAllByValue_985054D91DF3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.StickyNote" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.StickyNote" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.StickyNote" } } } } } } }, "/api/StickyNote/GetAllGraphByValue": { "post": { "tags": [ "StickyNote" ], "summary": "StickyNote: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: StickyNote-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "StickyNote_GetAllGraphByValue_17CA37CD0B98", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.StickyNote" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.StickyNote" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.StickyNote" } } } } } } }, "/api/StickyNote/GetByValue": { "post": { "tags": [ "StickyNote" ], "summary": "StickyNote: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: StickyNote-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "StickyNote_GetByValue_BCD60D679B94", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.StickyNote" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.StickyNote" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.StickyNote" } } } } } } }, "/api/StickyNote/GetLookup": { "post": { "tags": [ "StickyNote" ], "summary": "StickyNote: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: StickyNote-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "StickyNote_GetLookup_BDA770D31A5C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/StickyNote/GetLookupByValue": { "post": { "tags": [ "StickyNote" ], "summary": "StickyNote: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: StickyNote-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "StickyNote_GetLookupByValue_536E00E26E7B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/StickyNote/Page": { "get": { "tags": [ "StickyNote" ], "summary": "StickyNote: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: StickyNote-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "StickyNote_GetPage_0A12F9AF7585", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/StickyNote/PageAsc": { "get": { "tags": [ "StickyNote" ], "summary": "StickyNote: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: StickyNote-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "StickyNote_GetPageAsc_235EFFED2BF8", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/StickyNote/SearchByValue": { "post": { "tags": [ "StickyNote" ], "summary": "StickyNote: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: StickyNote-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "StickyNote_SearchByValue_84379FE19201", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.StickyNote" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.StickyNote" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.StickyNote" } } } } } } }, "/api/StickyNote/TryGetByValue": { "post": { "tags": [ "StickyNote" ], "summary": "StickyNote: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: StickyNote-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "StickyNote_TryGetByValue_5458EC749E24", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.StickyNote" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.StickyNote" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.StickyNote" } } } } } } }, "/api/StickyNote/UpsertGraph": { "put": { "tags": [ "StickyNote" ], "summary": "StickyNote: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: StickyNote-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "StickyNote_UpsertGraph_5277936AB2B7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.StickyNote" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.StickyNote" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.StickyNote" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.StickyNote" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.StickyNote" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.StickyNote" } } } } } } }, "/api/StickyNote/UpsertGraphWithExtraFields": { "put": { "tags": [ "StickyNote" ], "summary": "StickyNote: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: StickyNote-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "StickyNote_UpsertGraphWithExtraFields_7D8F725A0660", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.StickyNote" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.StickyNote" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.StickyNote" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.StickyNote" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.StickyNote" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.StickyNote" } } } } } } }, "/api/SupportSetting": { "get": { "tags": [ "SupportSetting" ], "summary": "SupportSetting: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SupportSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SupportSetting_GetAll_1C847B53D6A4", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SupportSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SupportSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SupportSetting" } } } } } }, "post": { "tags": [ "SupportSetting" ], "summary": "SupportSetting: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SupportSetting-Create.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SupportSetting_Post_D3885466AAD6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SupportSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SupportSetting" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SupportSetting" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SupportSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SupportSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SupportSetting" } } } } } }, "put": { "tags": [ "SupportSetting" ], "summary": "SupportSetting: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SupportSetting-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SupportSetting_Put_3EC50F7C6A95", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SupportSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SupportSetting" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SupportSetting" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SupportSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SupportSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SupportSetting" } } } } } } }, "/api/SupportSetting/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "SupportSetting" ], "summary": "SupportSetting: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SupportSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SupportSetting_GetPageByValue_DA96DC38AC19", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/SupportSetting/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "SupportSetting" ], "summary": "SupportSetting: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SupportSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SupportSetting_GetPageByValue2_743557F08C0F", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/SupportSetting/DeleteByFilter": { "post": { "tags": [ "SupportSetting" ], "summary": "SupportSetting: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SupportSetting-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SupportSetting_DeleteByFilter_E42A77F52B72", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/SupportSetting/GetAllByValue": { "post": { "tags": [ "SupportSetting" ], "summary": "SupportSetting: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SupportSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SupportSetting_GetAllByValue_DE604BA3ED07", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SupportSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SupportSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SupportSetting" } } } } } } }, "/api/SupportSetting/GetAllGraphByValue": { "post": { "tags": [ "SupportSetting" ], "summary": "SupportSetting: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SupportSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SupportSetting_GetAllGraphByValue_2292ABF62F0E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SupportSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SupportSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SupportSetting" } } } } } } }, "/api/SupportSetting/GetByValue": { "post": { "tags": [ "SupportSetting" ], "summary": "SupportSetting: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SupportSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SupportSetting_GetByValue_17E03ADD430D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SupportSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SupportSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SupportSetting" } } } } } } }, "/api/SupportSetting/GetLookup": { "post": { "tags": [ "SupportSetting" ], "summary": "SupportSetting: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SupportSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SupportSetting_GetLookup_6E57B18E4FEE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/SupportSetting/GetLookupByValue": { "post": { "tags": [ "SupportSetting" ], "summary": "SupportSetting: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SupportSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SupportSetting_GetLookupByValue_CFA1BE9C4824", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/SupportSetting/Page": { "get": { "tags": [ "SupportSetting" ], "summary": "SupportSetting: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SupportSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SupportSetting_GetPage_81BE7F36FA13", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/SupportSetting/PageAsc": { "get": { "tags": [ "SupportSetting" ], "summary": "SupportSetting: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SupportSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SupportSetting_GetPageAsc_08002DF27F52", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/SupportSetting/SearchByValue": { "post": { "tags": [ "SupportSetting" ], "summary": "SupportSetting: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SupportSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SupportSetting_SearchByValue_05C1343F016A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.SupportSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.SupportSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.SupportSetting" } } } } } } }, "/api/SupportSetting/TryGetByValue": { "post": { "tags": [ "SupportSetting" ], "summary": "SupportSetting: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SupportSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SupportSetting_TryGetByValue_982451A3A967", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SupportSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SupportSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SupportSetting" } } } } } } }, "/api/SupportSetting/UpsertGraph": { "put": { "tags": [ "SupportSetting" ], "summary": "SupportSetting: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SupportSetting-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SupportSetting_UpsertGraph_9DDCA47A7662", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SupportSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SupportSetting" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SupportSetting" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SupportSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SupportSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SupportSetting" } } } } } } }, "/api/SupportSetting/UpsertGraphWithExtraFields": { "put": { "tags": [ "SupportSetting" ], "summary": "SupportSetting: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SupportSetting-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SupportSetting_UpsertGraphWithExtraFields_081CC7AAD922", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SupportSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SupportSetting" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SupportSetting" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SupportSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SupportSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SupportSetting" } } } } } } }, "/api/SystemDatabaseChangeLog": { "get": { "tags": [ "SystemDatabaseChangeLog" ], "summary": "SystemDatabaseChangeLog: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemDatabaseChangeLog-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemDatabaseChangeLog_GetAll_5656C1D86452", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemDatabaseChangeLog" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemDatabaseChangeLog" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemDatabaseChangeLog" } } } } } }, "post": { "tags": [ "SystemDatabaseChangeLog" ], "summary": "SystemDatabaseChangeLog: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemDatabaseChangeLog-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemDatabaseChangeLog_Post_AF3B24A52A7B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemDatabaseChangeLog" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemDatabaseChangeLog" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemDatabaseChangeLog" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemDatabaseChangeLog" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemDatabaseChangeLog" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemDatabaseChangeLog" } } } } } }, "put": { "tags": [ "SystemDatabaseChangeLog" ], "summary": "SystemDatabaseChangeLog: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemDatabaseChangeLog-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemDatabaseChangeLog_Put_48A36EE3006A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemDatabaseChangeLog" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemDatabaseChangeLog" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemDatabaseChangeLog" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemDatabaseChangeLog" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemDatabaseChangeLog" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemDatabaseChangeLog" } } } } } } }, "/api/SystemDatabaseChangeLog/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "SystemDatabaseChangeLog" ], "summary": "SystemDatabaseChangeLog: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemDatabaseChangeLog-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemDatabaseChangeLog_GetPageByValue_F99A25D6E860", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/SystemDatabaseChangeLog/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "SystemDatabaseChangeLog" ], "summary": "SystemDatabaseChangeLog: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemDatabaseChangeLog-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemDatabaseChangeLog_GetPageByValue2_5DDE879C9512", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/SystemDatabaseChangeLog/DeleteByFilter": { "post": { "tags": [ "SystemDatabaseChangeLog" ], "summary": "SystemDatabaseChangeLog: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemDatabaseChangeLog-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemDatabaseChangeLog_DeleteByFilter_CC824BA561E1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/SystemDatabaseChangeLog/GetAllByValue": { "post": { "tags": [ "SystemDatabaseChangeLog" ], "summary": "SystemDatabaseChangeLog: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemDatabaseChangeLog-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemDatabaseChangeLog_GetAllByValue_394D475F3366", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemDatabaseChangeLog" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemDatabaseChangeLog" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemDatabaseChangeLog" } } } } } } }, "/api/SystemDatabaseChangeLog/GetAllGraphByValue": { "post": { "tags": [ "SystemDatabaseChangeLog" ], "summary": "SystemDatabaseChangeLog: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemDatabaseChangeLog-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemDatabaseChangeLog_GetAllGraphByValue_9F250017D95A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemDatabaseChangeLog" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemDatabaseChangeLog" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemDatabaseChangeLog" } } } } } } }, "/api/SystemDatabaseChangeLog/GetByValue": { "post": { "tags": [ "SystemDatabaseChangeLog" ], "summary": "SystemDatabaseChangeLog: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemDatabaseChangeLog-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemDatabaseChangeLog_GetByValue_C810CCD4F4EC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemDatabaseChangeLog" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemDatabaseChangeLog" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemDatabaseChangeLog" } } } } } } }, "/api/SystemDatabaseChangeLog/GetLookup": { "post": { "tags": [ "SystemDatabaseChangeLog" ], "summary": "SystemDatabaseChangeLog: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemDatabaseChangeLog-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemDatabaseChangeLog_GetLookup_3632FE7B66C5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/SystemDatabaseChangeLog/GetLookupByValue": { "post": { "tags": [ "SystemDatabaseChangeLog" ], "summary": "SystemDatabaseChangeLog: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemDatabaseChangeLog-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemDatabaseChangeLog_GetLookupByValue_A1473FAD944F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/SystemDatabaseChangeLog/Page": { "get": { "tags": [ "SystemDatabaseChangeLog" ], "summary": "SystemDatabaseChangeLog: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemDatabaseChangeLog-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemDatabaseChangeLog_GetPage_A26FF9CCCD68", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/SystemDatabaseChangeLog/PageAsc": { "get": { "tags": [ "SystemDatabaseChangeLog" ], "summary": "SystemDatabaseChangeLog: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemDatabaseChangeLog-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemDatabaseChangeLog_GetPageAsc_D2D765F1E237", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/SystemDatabaseChangeLog/SearchByValue": { "post": { "tags": [ "SystemDatabaseChangeLog" ], "summary": "SystemDatabaseChangeLog: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemDatabaseChangeLog-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemDatabaseChangeLog_SearchByValue_C5E46A79B703", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.SystemDatabaseChangeLog" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.SystemDatabaseChangeLog" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.SystemDatabaseChangeLog" } } } } } } }, "/api/SystemDatabaseChangeLog/TryGetByValue": { "post": { "tags": [ "SystemDatabaseChangeLog" ], "summary": "SystemDatabaseChangeLog: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemDatabaseChangeLog-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemDatabaseChangeLog_TryGetByValue_63CF8DE29FCB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemDatabaseChangeLog" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemDatabaseChangeLog" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemDatabaseChangeLog" } } } } } } }, "/api/SystemDatabaseChangeLog/UpsertGraph": { "put": { "tags": [ "SystemDatabaseChangeLog" ], "summary": "SystemDatabaseChangeLog: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemDatabaseChangeLog-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemDatabaseChangeLog_UpsertGraph_D02374038152", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemDatabaseChangeLog" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemDatabaseChangeLog" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemDatabaseChangeLog" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemDatabaseChangeLog" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemDatabaseChangeLog" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemDatabaseChangeLog" } } } } } } }, "/api/SystemDatabaseChangeLog/UpsertGraphWithExtraFields": { "put": { "tags": [ "SystemDatabaseChangeLog" ], "summary": "SystemDatabaseChangeLog: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemDatabaseChangeLog-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemDatabaseChangeLog_UpsertGraphWithExtraFields_C7FEDD777F52", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemDatabaseChangeLog" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemDatabaseChangeLog" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemDatabaseChangeLog" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemDatabaseChangeLog" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemDatabaseChangeLog" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemDatabaseChangeLog" } } } } } } }, "/api/SystemDatabaseLanguage": { "get": { "tags": [ "SystemDatabaseLanguage" ], "summary": "SystemDatabaseLanguage: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemDatabaseLanguage-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemDatabaseLanguage_GetAll_51F015CC45CD", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemDatabaseLanguage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemDatabaseLanguage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemDatabaseLanguage" } } } } } }, "post": { "tags": [ "SystemDatabaseLanguage" ], "summary": "SystemDatabaseLanguage: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemDatabaseLanguage-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemDatabaseLanguage_Post_AC1156BB00DB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemDatabaseLanguage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemDatabaseLanguage" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemDatabaseLanguage" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemDatabaseLanguage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemDatabaseLanguage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemDatabaseLanguage" } } } } } }, "put": { "tags": [ "SystemDatabaseLanguage" ], "summary": "SystemDatabaseLanguage: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemDatabaseLanguage-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemDatabaseLanguage_Put_3DCAED28CCD2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemDatabaseLanguage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemDatabaseLanguage" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemDatabaseLanguage" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemDatabaseLanguage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemDatabaseLanguage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemDatabaseLanguage" } } } } } } }, "/api/SystemDatabaseLanguage/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "SystemDatabaseLanguage" ], "summary": "SystemDatabaseLanguage: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemDatabaseLanguage-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemDatabaseLanguage_GetPageByValue_9D6F5D9FC8B5", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/SystemDatabaseLanguage/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "SystemDatabaseLanguage" ], "summary": "SystemDatabaseLanguage: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemDatabaseLanguage-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemDatabaseLanguage_GetPageByValue2_034DC775105A", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/SystemDatabaseLanguage/DeleteByFilter": { "post": { "tags": [ "SystemDatabaseLanguage" ], "summary": "SystemDatabaseLanguage: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemDatabaseLanguage-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemDatabaseLanguage_DeleteByFilter_CF39151C1A3D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/SystemDatabaseLanguage/GetAllByValue": { "post": { "tags": [ "SystemDatabaseLanguage" ], "summary": "SystemDatabaseLanguage: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemDatabaseLanguage-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemDatabaseLanguage_GetAllByValue_0181A47D4137", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemDatabaseLanguage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemDatabaseLanguage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemDatabaseLanguage" } } } } } } }, "/api/SystemDatabaseLanguage/GetAllGraphByValue": { "post": { "tags": [ "SystemDatabaseLanguage" ], "summary": "SystemDatabaseLanguage: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemDatabaseLanguage-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemDatabaseLanguage_GetAllGraphByValue_0E06E47AA3F1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemDatabaseLanguage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemDatabaseLanguage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemDatabaseLanguage" } } } } } } }, "/api/SystemDatabaseLanguage/GetByValue": { "post": { "tags": [ "SystemDatabaseLanguage" ], "summary": "SystemDatabaseLanguage: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemDatabaseLanguage-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemDatabaseLanguage_GetByValue_A04DE0DF9934", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemDatabaseLanguage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemDatabaseLanguage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemDatabaseLanguage" } } } } } } }, "/api/SystemDatabaseLanguage/GetLookup": { "post": { "tags": [ "SystemDatabaseLanguage" ], "summary": "SystemDatabaseLanguage: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemDatabaseLanguage-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemDatabaseLanguage_GetLookup_EDD341F6B6E3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/SystemDatabaseLanguage/GetLookupByValue": { "post": { "tags": [ "SystemDatabaseLanguage" ], "summary": "SystemDatabaseLanguage: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemDatabaseLanguage-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemDatabaseLanguage_GetLookupByValue_AC9B13DFF739", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/SystemDatabaseLanguage/Page": { "get": { "tags": [ "SystemDatabaseLanguage" ], "summary": "SystemDatabaseLanguage: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemDatabaseLanguage-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemDatabaseLanguage_GetPage_3E899C276BBE", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/SystemDatabaseLanguage/PageAsc": { "get": { "tags": [ "SystemDatabaseLanguage" ], "summary": "SystemDatabaseLanguage: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemDatabaseLanguage-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemDatabaseLanguage_GetPageAsc_00B82A52282D", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/SystemDatabaseLanguage/SearchByValue": { "post": { "tags": [ "SystemDatabaseLanguage" ], "summary": "SystemDatabaseLanguage: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemDatabaseLanguage-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemDatabaseLanguage_SearchByValue_C02A12105A49", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.SystemDatabaseLanguage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.SystemDatabaseLanguage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.SystemDatabaseLanguage" } } } } } } }, "/api/SystemDatabaseLanguage/TryGetByValue": { "post": { "tags": [ "SystemDatabaseLanguage" ], "summary": "SystemDatabaseLanguage: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemDatabaseLanguage-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemDatabaseLanguage_TryGetByValue_0F12BA635D55", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemDatabaseLanguage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemDatabaseLanguage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemDatabaseLanguage" } } } } } } }, "/api/SystemDatabaseLanguage/UpsertGraph": { "put": { "tags": [ "SystemDatabaseLanguage" ], "summary": "SystemDatabaseLanguage: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemDatabaseLanguage-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemDatabaseLanguage_UpsertGraph_F40A265CBB2F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemDatabaseLanguage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemDatabaseLanguage" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemDatabaseLanguage" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemDatabaseLanguage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemDatabaseLanguage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemDatabaseLanguage" } } } } } } }, "/api/SystemDatabaseLanguage/UpsertGraphWithExtraFields": { "put": { "tags": [ "SystemDatabaseLanguage" ], "summary": "SystemDatabaseLanguage: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemDatabaseLanguage-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemDatabaseLanguage_UpsertGraphWithExtraFields_992708C65B12", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemDatabaseLanguage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemDatabaseLanguage" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemDatabaseLanguage" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemDatabaseLanguage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemDatabaseLanguage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemDatabaseLanguage" } } } } } } }, "/api/SystemDataType": { "get": { "tags": [ "SystemDataType" ], "summary": "SystemDataType: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemDataType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemDataType_GetAll_9CF6D7C6CBDF", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemDataType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemDataType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemDataType" } } } } } }, "post": { "tags": [ "SystemDataType" ], "summary": "SystemDataType: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemDataType-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemDataType_Post_F3C78364D68C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemDataType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemDataType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemDataType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemDataType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemDataType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemDataType" } } } } } }, "put": { "tags": [ "SystemDataType" ], "summary": "SystemDataType: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemDataType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemDataType_Put_7D826414D3C7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemDataType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemDataType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemDataType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemDataType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemDataType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemDataType" } } } } } } }, "/api/SystemDataType/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "SystemDataType" ], "summary": "SystemDataType: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemDataType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemDataType_GetPageByValue_546895E62A0C", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/SystemDataType/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "SystemDataType" ], "summary": "SystemDataType: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemDataType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemDataType_GetPageByValue2_51DD4DDBD7DC", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/SystemDataType/DeleteByFilter": { "post": { "tags": [ "SystemDataType" ], "summary": "SystemDataType: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemDataType-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemDataType_DeleteByFilter_5CE35091A939", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/SystemDataType/GetAllByValue": { "post": { "tags": [ "SystemDataType" ], "summary": "SystemDataType: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemDataType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemDataType_GetAllByValue_2EF0FAC611D7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemDataType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemDataType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemDataType" } } } } } } }, "/api/SystemDataType/GetAllGraphByValue": { "post": { "tags": [ "SystemDataType" ], "summary": "SystemDataType: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemDataType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemDataType_GetAllGraphByValue_760B5CA6FB6D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemDataType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemDataType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemDataType" } } } } } } }, "/api/SystemDataType/GetByValue": { "post": { "tags": [ "SystemDataType" ], "summary": "SystemDataType: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemDataType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemDataType_GetByValue_4B4A36A9707B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemDataType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemDataType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemDataType" } } } } } } }, "/api/SystemDataType/GetLookup": { "post": { "tags": [ "SystemDataType" ], "summary": "SystemDataType: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemDataType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemDataType_GetLookup_188012F4F272", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/SystemDataType/GetLookupByValue": { "post": { "tags": [ "SystemDataType" ], "summary": "SystemDataType: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemDataType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemDataType_GetLookupByValue_FA655EB737F8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/SystemDataType/Page": { "get": { "tags": [ "SystemDataType" ], "summary": "SystemDataType: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemDataType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemDataType_GetPage_ADDD1814B079", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/SystemDataType/PageAsc": { "get": { "tags": [ "SystemDataType" ], "summary": "SystemDataType: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemDataType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemDataType_GetPageAsc_99AFED5FF82C", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/SystemDataType/SearchByValue": { "post": { "tags": [ "SystemDataType" ], "summary": "SystemDataType: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemDataType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemDataType_SearchByValue_864A8283B8FB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.SystemDataType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.SystemDataType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.SystemDataType" } } } } } } }, "/api/SystemDataType/TryGetByValue": { "post": { "tags": [ "SystemDataType" ], "summary": "SystemDataType: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemDataType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemDataType_TryGetByValue_B393EE806C06", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemDataType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemDataType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemDataType" } } } } } } }, "/api/SystemDataType/UpsertGraph": { "put": { "tags": [ "SystemDataType" ], "summary": "SystemDataType: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemDataType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemDataType_UpsertGraph_C94C6A2C4412", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemDataType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemDataType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemDataType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemDataType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemDataType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemDataType" } } } } } } }, "/api/SystemDataType/UpsertGraphWithExtraFields": { "put": { "tags": [ "SystemDataType" ], "summary": "SystemDataType: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemDataType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemDataType_UpsertGraphWithExtraFields_9FAC0876CA7B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemDataType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemDataType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemDataType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemDataType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemDataType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemDataType" } } } } } } }, "/api/SystemDesktop": { "get": { "tags": [ "SystemDesktop" ], "summary": "SystemDesktop: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemDesktop-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemDesktop_GetAll_1FD56FF1E908", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemDesktop" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemDesktop" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemDesktop" } } } } } }, "post": { "tags": [ "SystemDesktop" ], "summary": "SystemDesktop: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemDesktop-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemDesktop_Post_5C36B461B466", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemDesktop" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemDesktop" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemDesktop" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemDesktop" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemDesktop" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemDesktop" } } } } } }, "put": { "tags": [ "SystemDesktop" ], "summary": "SystemDesktop: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemDesktop-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemDesktop_Put_BCA3C2D08917", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemDesktop" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemDesktop" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemDesktop" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemDesktop" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemDesktop" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemDesktop" } } } } } } }, "/api/SystemDesktop/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "SystemDesktop" ], "summary": "SystemDesktop: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemDesktop-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemDesktop_GetPageByValue_71F00048C3ED", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/SystemDesktop/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "SystemDesktop" ], "summary": "SystemDesktop: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemDesktop-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemDesktop_GetPageByValue2_FB03B23CD302", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/SystemDesktop/DeleteByFilter": { "post": { "tags": [ "SystemDesktop" ], "summary": "SystemDesktop: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemDesktop-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemDesktop_DeleteByFilter_2DF1972D59D0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/SystemDesktop/GetAllByValue": { "post": { "tags": [ "SystemDesktop" ], "summary": "SystemDesktop: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemDesktop-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemDesktop_GetAllByValue_F9D96995370B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemDesktop" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemDesktop" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemDesktop" } } } } } } }, "/api/SystemDesktop/GetAllGraphByValue": { "post": { "tags": [ "SystemDesktop" ], "summary": "SystemDesktop: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemDesktop-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemDesktop_GetAllGraphByValue_31A6375FC455", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemDesktop" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemDesktop" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemDesktop" } } } } } } }, "/api/SystemDesktop/GetByValue": { "post": { "tags": [ "SystemDesktop" ], "summary": "SystemDesktop: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemDesktop-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemDesktop_GetByValue_8B4478EC684E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemDesktop" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemDesktop" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemDesktop" } } } } } } }, "/api/SystemDesktop/GetLookup": { "post": { "tags": [ "SystemDesktop" ], "summary": "SystemDesktop: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemDesktop-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemDesktop_GetLookup_966E564FDB2F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/SystemDesktop/GetLookupByValue": { "post": { "tags": [ "SystemDesktop" ], "summary": "SystemDesktop: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemDesktop-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemDesktop_GetLookupByValue_FDDC3A821372", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/SystemDesktop/Page": { "get": { "tags": [ "SystemDesktop" ], "summary": "SystemDesktop: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemDesktop-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemDesktop_GetPage_567613D93668", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/SystemDesktop/PageAsc": { "get": { "tags": [ "SystemDesktop" ], "summary": "SystemDesktop: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemDesktop-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemDesktop_GetPageAsc_01D2DB853855", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/SystemDesktop/SearchByValue": { "post": { "tags": [ "SystemDesktop" ], "summary": "SystemDesktop: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemDesktop-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemDesktop_SearchByValue_BEBF18638D7C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.SystemDesktop" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.SystemDesktop" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.SystemDesktop" } } } } } } }, "/api/SystemDesktop/TryGetByValue": { "post": { "tags": [ "SystemDesktop" ], "summary": "SystemDesktop: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemDesktop-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemDesktop_TryGetByValue_6CC0A6EDC7F9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemDesktop" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemDesktop" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemDesktop" } } } } } } }, "/api/SystemDesktop/UpsertGraph": { "put": { "tags": [ "SystemDesktop" ], "summary": "SystemDesktop: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemDesktop-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemDesktop_UpsertGraph_8E11481937B7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemDesktop" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemDesktop" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemDesktop" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemDesktop" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemDesktop" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemDesktop" } } } } } } }, "/api/SystemDesktop/UpsertGraphWithExtraFields": { "put": { "tags": [ "SystemDesktop" ], "summary": "SystemDesktop: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemDesktop-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemDesktop_UpsertGraphWithExtraFields_04514BA630CF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemDesktop" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemDesktop" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemDesktop" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemDesktop" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemDesktop" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemDesktop" } } } } } } }, "/api/SystemDesktopColumn": { "get": { "tags": [ "SystemDesktopColumn" ], "summary": "SystemDesktopColumn: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemDesktopColumn-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemDesktopColumn_GetAll_39640E3BB4D1", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemDesktopColumn" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemDesktopColumn" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemDesktopColumn" } } } } } }, "post": { "tags": [ "SystemDesktopColumn" ], "summary": "SystemDesktopColumn: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemDesktopColumn-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemDesktopColumn_Post_A181E1C9732F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemDesktopColumn" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemDesktopColumn" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemDesktopColumn" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemDesktopColumn" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemDesktopColumn" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemDesktopColumn" } } } } } }, "put": { "tags": [ "SystemDesktopColumn" ], "summary": "SystemDesktopColumn: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemDesktopColumn-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemDesktopColumn_Put_F7C3A69F0B52", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemDesktopColumn" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemDesktopColumn" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemDesktopColumn" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemDesktopColumn" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemDesktopColumn" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemDesktopColumn" } } } } } } }, "/api/SystemDesktopColumn/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "SystemDesktopColumn" ], "summary": "SystemDesktopColumn: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemDesktopColumn-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemDesktopColumn_GetPageByValue_1E3700C27E2B", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/SystemDesktopColumn/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "SystemDesktopColumn" ], "summary": "SystemDesktopColumn: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemDesktopColumn-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemDesktopColumn_GetPageByValue2_D59C09CDEC64", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/SystemDesktopColumn/DeleteByFilter": { "post": { "tags": [ "SystemDesktopColumn" ], "summary": "SystemDesktopColumn: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemDesktopColumn-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemDesktopColumn_DeleteByFilter_1A311E265AD6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/SystemDesktopColumn/GetAllByValue": { "post": { "tags": [ "SystemDesktopColumn" ], "summary": "SystemDesktopColumn: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemDesktopColumn-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemDesktopColumn_GetAllByValue_8A6CDA7BCBA0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemDesktopColumn" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemDesktopColumn" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemDesktopColumn" } } } } } } }, "/api/SystemDesktopColumn/GetAllGraphByValue": { "post": { "tags": [ "SystemDesktopColumn" ], "summary": "SystemDesktopColumn: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemDesktopColumn-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemDesktopColumn_GetAllGraphByValue_26F93C2C81C4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemDesktopColumn" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemDesktopColumn" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemDesktopColumn" } } } } } } }, "/api/SystemDesktopColumn/GetByValue": { "post": { "tags": [ "SystemDesktopColumn" ], "summary": "SystemDesktopColumn: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemDesktopColumn-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemDesktopColumn_GetByValue_565FA6A188BE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemDesktopColumn" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemDesktopColumn" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemDesktopColumn" } } } } } } }, "/api/SystemDesktopColumn/GetLookup": { "post": { "tags": [ "SystemDesktopColumn" ], "summary": "SystemDesktopColumn: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemDesktopColumn-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemDesktopColumn_GetLookup_01CE1D49E708", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/SystemDesktopColumn/GetLookupByValue": { "post": { "tags": [ "SystemDesktopColumn" ], "summary": "SystemDesktopColumn: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemDesktopColumn-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemDesktopColumn_GetLookupByValue_A2FBDF186C1F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/SystemDesktopColumn/Page": { "get": { "tags": [ "SystemDesktopColumn" ], "summary": "SystemDesktopColumn: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemDesktopColumn-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemDesktopColumn_GetPage_8E1D1A197097", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/SystemDesktopColumn/PageAsc": { "get": { "tags": [ "SystemDesktopColumn" ], "summary": "SystemDesktopColumn: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemDesktopColumn-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemDesktopColumn_GetPageAsc_7A920008CF2F", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/SystemDesktopColumn/SearchByValue": { "post": { "tags": [ "SystemDesktopColumn" ], "summary": "SystemDesktopColumn: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemDesktopColumn-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemDesktopColumn_SearchByValue_3C9FDB9BD8B4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.SystemDesktopColumn" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.SystemDesktopColumn" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.SystemDesktopColumn" } } } } } } }, "/api/SystemDesktopColumn/TryGetByValue": { "post": { "tags": [ "SystemDesktopColumn" ], "summary": "SystemDesktopColumn: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemDesktopColumn-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemDesktopColumn_TryGetByValue_FA0FC974657B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemDesktopColumn" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemDesktopColumn" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemDesktopColumn" } } } } } } }, "/api/SystemDesktopColumn/UpsertGraph": { "put": { "tags": [ "SystemDesktopColumn" ], "summary": "SystemDesktopColumn: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemDesktopColumn-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemDesktopColumn_UpsertGraph_8973BC7030CD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemDesktopColumn" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemDesktopColumn" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemDesktopColumn" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemDesktopColumn" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemDesktopColumn" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemDesktopColumn" } } } } } } }, "/api/SystemDesktopColumn/UpsertGraphWithExtraFields": { "put": { "tags": [ "SystemDesktopColumn" ], "summary": "SystemDesktopColumn: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemDesktopColumn-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemDesktopColumn_UpsertGraphWithExtraFields_96625BF7779C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemDesktopColumn" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemDesktopColumn" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemDesktopColumn" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemDesktopColumn" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemDesktopColumn" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemDesktopColumn" } } } } } } }, "/api/SystemKeyCombination": { "get": { "tags": [ "SystemKeyCombination" ], "summary": "SystemKeyCombination: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemKeyCombination-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemKeyCombination_GetAll_E1CBEAED8C7A", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemKeyCombination" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemKeyCombination" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemKeyCombination" } } } } } }, "post": { "tags": [ "SystemKeyCombination" ], "summary": "SystemKeyCombination: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemKeyCombination-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemKeyCombination_Post_0DE8DB505A9A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemKeyCombination" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemKeyCombination" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemKeyCombination" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemKeyCombination" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemKeyCombination" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemKeyCombination" } } } } } }, "put": { "tags": [ "SystemKeyCombination" ], "summary": "SystemKeyCombination: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemKeyCombination-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemKeyCombination_Put_DC730C807624", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemKeyCombination" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemKeyCombination" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemKeyCombination" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemKeyCombination" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemKeyCombination" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemKeyCombination" } } } } } } }, "/api/SystemKeyCombination/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "SystemKeyCombination" ], "summary": "SystemKeyCombination: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemKeyCombination-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemKeyCombination_GetPageByValue_47D430156064", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/SystemKeyCombination/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "SystemKeyCombination" ], "summary": "SystemKeyCombination: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemKeyCombination-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemKeyCombination_GetPageByValue2_FECB23CC3991", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/SystemKeyCombination/DeleteByFilter": { "post": { "tags": [ "SystemKeyCombination" ], "summary": "SystemKeyCombination: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemKeyCombination-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemKeyCombination_DeleteByFilter_F0BC09C71E80", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/SystemKeyCombination/GetAllByValue": { "post": { "tags": [ "SystemKeyCombination" ], "summary": "SystemKeyCombination: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemKeyCombination-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemKeyCombination_GetAllByValue_949132C8F7B4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemKeyCombination" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemKeyCombination" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemKeyCombination" } } } } } } }, "/api/SystemKeyCombination/GetAllGraphByValue": { "post": { "tags": [ "SystemKeyCombination" ], "summary": "SystemKeyCombination: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemKeyCombination-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemKeyCombination_GetAllGraphByValue_FE0D6ADE1ED9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemKeyCombination" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemKeyCombination" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemKeyCombination" } } } } } } }, "/api/SystemKeyCombination/GetByValue": { "post": { "tags": [ "SystemKeyCombination" ], "summary": "SystemKeyCombination: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemKeyCombination-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemKeyCombination_GetByValue_00E6F7291298", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemKeyCombination" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemKeyCombination" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemKeyCombination" } } } } } } }, "/api/SystemKeyCombination/GetLookup": { "post": { "tags": [ "SystemKeyCombination" ], "summary": "SystemKeyCombination: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemKeyCombination-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemKeyCombination_GetLookup_3DD161EF258F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/SystemKeyCombination/GetLookupByValue": { "post": { "tags": [ "SystemKeyCombination" ], "summary": "SystemKeyCombination: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemKeyCombination-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemKeyCombination_GetLookupByValue_47357568FD1B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/SystemKeyCombination/Page": { "get": { "tags": [ "SystemKeyCombination" ], "summary": "SystemKeyCombination: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemKeyCombination-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemKeyCombination_GetPage_F19704A172AD", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/SystemKeyCombination/PageAsc": { "get": { "tags": [ "SystemKeyCombination" ], "summary": "SystemKeyCombination: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemKeyCombination-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemKeyCombination_GetPageAsc_F5C42C07E53D", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/SystemKeyCombination/SearchByValue": { "post": { "tags": [ "SystemKeyCombination" ], "summary": "SystemKeyCombination: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemKeyCombination-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemKeyCombination_SearchByValue_B31E26A5C42F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.SystemKeyCombination" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.SystemKeyCombination" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.SystemKeyCombination" } } } } } } }, "/api/SystemKeyCombination/TryGetByValue": { "post": { "tags": [ "SystemKeyCombination" ], "summary": "SystemKeyCombination: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemKeyCombination-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemKeyCombination_TryGetByValue_B035EE08A2BD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemKeyCombination" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemKeyCombination" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemKeyCombination" } } } } } } }, "/api/SystemKeyCombination/UpsertGraph": { "put": { "tags": [ "SystemKeyCombination" ], "summary": "SystemKeyCombination: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemKeyCombination-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemKeyCombination_UpsertGraph_CB5FCE4C5DA2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemKeyCombination" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemKeyCombination" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemKeyCombination" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemKeyCombination" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemKeyCombination" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemKeyCombination" } } } } } } }, "/api/SystemKeyCombination/UpsertGraphWithExtraFields": { "put": { "tags": [ "SystemKeyCombination" ], "summary": "SystemKeyCombination: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemKeyCombination-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemKeyCombination_UpsertGraphWithExtraFields_8695B86C9FBF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemKeyCombination" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemKeyCombination" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemKeyCombination" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemKeyCombination" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemKeyCombination" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemKeyCombination" } } } } } } }, "/api/SystemMapping": { "get": { "tags": [ "SystemMapping" ], "summary": "SystemMapping: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemMapping-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemMapping_GetAll_28831B4EE83F", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemMapping" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemMapping" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemMapping" } } } } } }, "post": { "tags": [ "SystemMapping" ], "summary": "SystemMapping: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemMapping-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemMapping_Post_038EE12A843D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemMapping" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemMapping" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemMapping" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemMapping" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemMapping" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemMapping" } } } } } }, "put": { "tags": [ "SystemMapping" ], "summary": "SystemMapping: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemMapping-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemMapping_Put_027B386D57F5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemMapping" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemMapping" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemMapping" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemMapping" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemMapping" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemMapping" } } } } } } }, "/api/SystemMapping/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "SystemMapping" ], "summary": "SystemMapping: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemMapping-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemMapping_GetPageByValue_C68F5A63A516", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/SystemMapping/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "SystemMapping" ], "summary": "SystemMapping: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemMapping-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemMapping_GetPageByValue2_02DB93DBB911", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/SystemMapping/DeleteByFilter": { "post": { "tags": [ "SystemMapping" ], "summary": "SystemMapping: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemMapping-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemMapping_DeleteByFilter_09F8FF06BC6A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/SystemMapping/GetAllByValue": { "post": { "tags": [ "SystemMapping" ], "summary": "SystemMapping: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemMapping-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemMapping_GetAllByValue_1E2BC3010498", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemMapping" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemMapping" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemMapping" } } } } } } }, "/api/SystemMapping/GetAllGraphByValue": { "post": { "tags": [ "SystemMapping" ], "summary": "SystemMapping: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemMapping-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemMapping_GetAllGraphByValue_4443D7156E24", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemMapping" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemMapping" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemMapping" } } } } } } }, "/api/SystemMapping/GetByValue": { "post": { "tags": [ "SystemMapping" ], "summary": "SystemMapping: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemMapping-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemMapping_GetByValue_3E266E798DE2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemMapping" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemMapping" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemMapping" } } } } } } }, "/api/SystemMapping/GetLookup": { "post": { "tags": [ "SystemMapping" ], "summary": "SystemMapping: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemMapping-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemMapping_GetLookup_B380E98912A4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/SystemMapping/GetLookupByValue": { "post": { "tags": [ "SystemMapping" ], "summary": "SystemMapping: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemMapping-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemMapping_GetLookupByValue_D113CA9C6401", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/SystemMapping/Page": { "get": { "tags": [ "SystemMapping" ], "summary": "SystemMapping: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemMapping-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemMapping_GetPage_24842A0C8304", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/SystemMapping/PageAsc": { "get": { "tags": [ "SystemMapping" ], "summary": "SystemMapping: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemMapping-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemMapping_GetPageAsc_736690E76105", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/SystemMapping/SearchByValue": { "post": { "tags": [ "SystemMapping" ], "summary": "SystemMapping: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemMapping-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemMapping_SearchByValue_6B269A47E979", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.SystemMapping" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.SystemMapping" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.SystemMapping" } } } } } } }, "/api/SystemMapping/TryGetByValue": { "post": { "tags": [ "SystemMapping" ], "summary": "SystemMapping: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemMapping-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemMapping_TryGetByValue_6F8FE6956523", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemMapping" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemMapping" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemMapping" } } } } } } }, "/api/SystemMapping/UpsertGraph": { "put": { "tags": [ "SystemMapping" ], "summary": "SystemMapping: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemMapping-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemMapping_UpsertGraph_A8292F5612FC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemMapping" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemMapping" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemMapping" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemMapping" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemMapping" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemMapping" } } } } } } }, "/api/SystemMapping/UpsertGraphWithExtraFields": { "put": { "tags": [ "SystemMapping" ], "summary": "SystemMapping: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemMapping-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemMapping_UpsertGraphWithExtraFields_0325181E82BB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemMapping" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemMapping" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemMapping" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemMapping" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemMapping" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemMapping" } } } } } } }, "/api/SystemMappingFileType": { "get": { "tags": [ "SystemMappingFileType" ], "summary": "SystemMappingFileType: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemMappingFileType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemMappingFileType_GetAll_C1EA0B23EE67", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemMappingFileType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemMappingFileType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemMappingFileType" } } } } } }, "post": { "tags": [ "SystemMappingFileType" ], "summary": "SystemMappingFileType: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemMappingFileType-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemMappingFileType_Post_ECDDF65F9670", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemMappingFileType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemMappingFileType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemMappingFileType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemMappingFileType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemMappingFileType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemMappingFileType" } } } } } }, "put": { "tags": [ "SystemMappingFileType" ], "summary": "SystemMappingFileType: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemMappingFileType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemMappingFileType_Put_8FD1B088C188", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemMappingFileType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemMappingFileType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemMappingFileType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemMappingFileType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemMappingFileType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemMappingFileType" } } } } } } }, "/api/SystemMappingFileType/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "SystemMappingFileType" ], "summary": "SystemMappingFileType: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemMappingFileType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemMappingFileType_GetPageByValue_5BB7FDF36A4D", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/SystemMappingFileType/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "SystemMappingFileType" ], "summary": "SystemMappingFileType: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemMappingFileType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemMappingFileType_GetPageByValue2_86EF2B6ED4F8", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/SystemMappingFileType/DeleteByFilter": { "post": { "tags": [ "SystemMappingFileType" ], "summary": "SystemMappingFileType: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemMappingFileType-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemMappingFileType_DeleteByFilter_3F50D0CFD27A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/SystemMappingFileType/GetAllByValue": { "post": { "tags": [ "SystemMappingFileType" ], "summary": "SystemMappingFileType: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemMappingFileType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemMappingFileType_GetAllByValue_508472C68595", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemMappingFileType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemMappingFileType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemMappingFileType" } } } } } } }, "/api/SystemMappingFileType/GetAllGraphByValue": { "post": { "tags": [ "SystemMappingFileType" ], "summary": "SystemMappingFileType: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemMappingFileType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemMappingFileType_GetAllGraphByValue_5B1D1EA6662D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemMappingFileType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemMappingFileType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemMappingFileType" } } } } } } }, "/api/SystemMappingFileType/GetByValue": { "post": { "tags": [ "SystemMappingFileType" ], "summary": "SystemMappingFileType: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemMappingFileType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemMappingFileType_GetByValue_999B7E183E2C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemMappingFileType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemMappingFileType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemMappingFileType" } } } } } } }, "/api/SystemMappingFileType/GetLookup": { "post": { "tags": [ "SystemMappingFileType" ], "summary": "SystemMappingFileType: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemMappingFileType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemMappingFileType_GetLookup_B84DEFCAD44B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/SystemMappingFileType/GetLookupByValue": { "post": { "tags": [ "SystemMappingFileType" ], "summary": "SystemMappingFileType: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemMappingFileType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemMappingFileType_GetLookupByValue_9A07897B7A03", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/SystemMappingFileType/Page": { "get": { "tags": [ "SystemMappingFileType" ], "summary": "SystemMappingFileType: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemMappingFileType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemMappingFileType_GetPage_B2F16CD296FD", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/SystemMappingFileType/PageAsc": { "get": { "tags": [ "SystemMappingFileType" ], "summary": "SystemMappingFileType: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemMappingFileType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemMappingFileType_GetPageAsc_330A55E8CFE8", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/SystemMappingFileType/SearchByValue": { "post": { "tags": [ "SystemMappingFileType" ], "summary": "SystemMappingFileType: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemMappingFileType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemMappingFileType_SearchByValue_9AE21A8CF8D5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.SystemMappingFileType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.SystemMappingFileType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.SystemMappingFileType" } } } } } } }, "/api/SystemMappingFileType/TryGetByValue": { "post": { "tags": [ "SystemMappingFileType" ], "summary": "SystemMappingFileType: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemMappingFileType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemMappingFileType_TryGetByValue_2C51C90D538F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemMappingFileType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemMappingFileType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemMappingFileType" } } } } } } }, "/api/SystemMappingFileType/UpsertGraph": { "put": { "tags": [ "SystemMappingFileType" ], "summary": "SystemMappingFileType: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemMappingFileType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemMappingFileType_UpsertGraph_E289A741B36E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemMappingFileType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemMappingFileType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemMappingFileType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemMappingFileType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemMappingFileType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemMappingFileType" } } } } } } }, "/api/SystemMappingFileType/UpsertGraphWithExtraFields": { "put": { "tags": [ "SystemMappingFileType" ], "summary": "SystemMappingFileType: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemMappingFileType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemMappingFileType_UpsertGraphWithExtraFields_D07C5923FDE5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemMappingFileType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemMappingFileType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemMappingFileType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemMappingFileType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemMappingFileType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemMappingFileType" } } } } } } }, "/api/SystemMappingFormatName": { "get": { "tags": [ "SystemMappingFormatName" ], "summary": "SystemMappingFormatName: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemMappingFormatName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemMappingFormatName_GetAll_1E5C1829BBB5", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemMappingFormatName" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemMappingFormatName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemMappingFormatName" } } } } } }, "post": { "tags": [ "SystemMappingFormatName" ], "summary": "SystemMappingFormatName: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemMappingFormatName-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemMappingFormatName_Post_8E24E1F56982", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemMappingFormatName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemMappingFormatName" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemMappingFormatName" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemMappingFormatName" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemMappingFormatName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemMappingFormatName" } } } } } }, "put": { "tags": [ "SystemMappingFormatName" ], "summary": "SystemMappingFormatName: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemMappingFormatName-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemMappingFormatName_Put_094533595829", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemMappingFormatName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemMappingFormatName" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemMappingFormatName" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemMappingFormatName" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemMappingFormatName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemMappingFormatName" } } } } } } }, "/api/SystemMappingFormatName/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "SystemMappingFormatName" ], "summary": "SystemMappingFormatName: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemMappingFormatName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemMappingFormatName_GetPageByValue_A9EF462A20FA", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/SystemMappingFormatName/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "SystemMappingFormatName" ], "summary": "SystemMappingFormatName: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemMappingFormatName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemMappingFormatName_GetPageByValue2_88D1D6FBA432", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/SystemMappingFormatName/DeleteByFilter": { "post": { "tags": [ "SystemMappingFormatName" ], "summary": "SystemMappingFormatName: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemMappingFormatName-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemMappingFormatName_DeleteByFilter_36E28966716A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/SystemMappingFormatName/GetAllByValue": { "post": { "tags": [ "SystemMappingFormatName" ], "summary": "SystemMappingFormatName: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemMappingFormatName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemMappingFormatName_GetAllByValue_0AFE2611F10C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemMappingFormatName" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemMappingFormatName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemMappingFormatName" } } } } } } }, "/api/SystemMappingFormatName/GetAllGraphByValue": { "post": { "tags": [ "SystemMappingFormatName" ], "summary": "SystemMappingFormatName: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemMappingFormatName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemMappingFormatName_GetAllGraphByValue_0E64DE5C3269", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemMappingFormatName" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemMappingFormatName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemMappingFormatName" } } } } } } }, "/api/SystemMappingFormatName/GetByValue": { "post": { "tags": [ "SystemMappingFormatName" ], "summary": "SystemMappingFormatName: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemMappingFormatName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemMappingFormatName_GetByValue_1FD04D23F856", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemMappingFormatName" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemMappingFormatName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemMappingFormatName" } } } } } } }, "/api/SystemMappingFormatName/GetLookup": { "post": { "tags": [ "SystemMappingFormatName" ], "summary": "SystemMappingFormatName: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemMappingFormatName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemMappingFormatName_GetLookup_EC2F9AEE5A27", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/SystemMappingFormatName/GetLookupByValue": { "post": { "tags": [ "SystemMappingFormatName" ], "summary": "SystemMappingFormatName: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemMappingFormatName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemMappingFormatName_GetLookupByValue_6325B480DE86", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/SystemMappingFormatName/Page": { "get": { "tags": [ "SystemMappingFormatName" ], "summary": "SystemMappingFormatName: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemMappingFormatName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemMappingFormatName_GetPage_D160DDAF7DBA", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/SystemMappingFormatName/PageAsc": { "get": { "tags": [ "SystemMappingFormatName" ], "summary": "SystemMappingFormatName: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemMappingFormatName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemMappingFormatName_GetPageAsc_C83811850883", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/SystemMappingFormatName/SearchByValue": { "post": { "tags": [ "SystemMappingFormatName" ], "summary": "SystemMappingFormatName: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemMappingFormatName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemMappingFormatName_SearchByValue_27AA2C2B9BD4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.SystemMappingFormatName" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.SystemMappingFormatName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.SystemMappingFormatName" } } } } } } }, "/api/SystemMappingFormatName/TryGetByValue": { "post": { "tags": [ "SystemMappingFormatName" ], "summary": "SystemMappingFormatName: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemMappingFormatName-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemMappingFormatName_TryGetByValue_95AB301FFA87", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemMappingFormatName" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemMappingFormatName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemMappingFormatName" } } } } } } }, "/api/SystemMappingFormatName/UpsertGraph": { "put": { "tags": [ "SystemMappingFormatName" ], "summary": "SystemMappingFormatName: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemMappingFormatName-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemMappingFormatName_UpsertGraph_5A39E466818E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemMappingFormatName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemMappingFormatName" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemMappingFormatName" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemMappingFormatName" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemMappingFormatName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemMappingFormatName" } } } } } } }, "/api/SystemMappingFormatName/UpsertGraphWithExtraFields": { "put": { "tags": [ "SystemMappingFormatName" ], "summary": "SystemMappingFormatName: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemMappingFormatName-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemMappingFormatName_UpsertGraphWithExtraFields_86271A044645", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemMappingFormatName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemMappingFormatName" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemMappingFormatName" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemMappingFormatName" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemMappingFormatName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemMappingFormatName" } } } } } } }, "/api/SystemMappingSystemColumn": { "get": { "tags": [ "SystemMappingSystemColumn" ], "summary": "SystemMappingSystemColumn: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemMappingSystemColumn-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemMappingSystemColumn_GetAll_E78D708D2D15", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemMappingSystemColumn" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemMappingSystemColumn" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemMappingSystemColumn" } } } } } }, "post": { "tags": [ "SystemMappingSystemColumn" ], "summary": "SystemMappingSystemColumn: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemMappingSystemColumn-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemMappingSystemColumn_Post_4A504D355035", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemMappingSystemColumn" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemMappingSystemColumn" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemMappingSystemColumn" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemMappingSystemColumn" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemMappingSystemColumn" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemMappingSystemColumn" } } } } } }, "put": { "tags": [ "SystemMappingSystemColumn" ], "summary": "SystemMappingSystemColumn: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemMappingSystemColumn-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemMappingSystemColumn_Put_9070B4D8B60B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemMappingSystemColumn" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemMappingSystemColumn" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemMappingSystemColumn" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemMappingSystemColumn" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemMappingSystemColumn" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemMappingSystemColumn" } } } } } } }, "/api/SystemMappingSystemColumn/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "SystemMappingSystemColumn" ], "summary": "SystemMappingSystemColumn: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemMappingSystemColumn-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemMappingSystemColumn_GetPageByValue_250077D6723A", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/SystemMappingSystemColumn/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "SystemMappingSystemColumn" ], "summary": "SystemMappingSystemColumn: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemMappingSystemColumn-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemMappingSystemColumn_GetPageByValue2_BA3BABA4923E", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/SystemMappingSystemColumn/DeleteByFilter": { "post": { "tags": [ "SystemMappingSystemColumn" ], "summary": "SystemMappingSystemColumn: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemMappingSystemColumn-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemMappingSystemColumn_DeleteByFilter_43690AC867D4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/SystemMappingSystemColumn/GetAllByValue": { "post": { "tags": [ "SystemMappingSystemColumn" ], "summary": "SystemMappingSystemColumn: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemMappingSystemColumn-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemMappingSystemColumn_GetAllByValue_EA2C8D160AE0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemMappingSystemColumn" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemMappingSystemColumn" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemMappingSystemColumn" } } } } } } }, "/api/SystemMappingSystemColumn/GetAllGraphByValue": { "post": { "tags": [ "SystemMappingSystemColumn" ], "summary": "SystemMappingSystemColumn: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemMappingSystemColumn-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemMappingSystemColumn_GetAllGraphByValue_B385531B1D8F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemMappingSystemColumn" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemMappingSystemColumn" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemMappingSystemColumn" } } } } } } }, "/api/SystemMappingSystemColumn/GetByValue": { "post": { "tags": [ "SystemMappingSystemColumn" ], "summary": "SystemMappingSystemColumn: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemMappingSystemColumn-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemMappingSystemColumn_GetByValue_D49BE64C8BBE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemMappingSystemColumn" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemMappingSystemColumn" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemMappingSystemColumn" } } } } } } }, "/api/SystemMappingSystemColumn/GetLookup": { "post": { "tags": [ "SystemMappingSystemColumn" ], "summary": "SystemMappingSystemColumn: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemMappingSystemColumn-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemMappingSystemColumn_GetLookup_C6D7299C0860", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/SystemMappingSystemColumn/GetLookupByValue": { "post": { "tags": [ "SystemMappingSystemColumn" ], "summary": "SystemMappingSystemColumn: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemMappingSystemColumn-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemMappingSystemColumn_GetLookupByValue_B0CDC8CE5F8A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/SystemMappingSystemColumn/Page": { "get": { "tags": [ "SystemMappingSystemColumn" ], "summary": "SystemMappingSystemColumn: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemMappingSystemColumn-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemMappingSystemColumn_GetPage_A2771665C075", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/SystemMappingSystemColumn/PageAsc": { "get": { "tags": [ "SystemMappingSystemColumn" ], "summary": "SystemMappingSystemColumn: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemMappingSystemColumn-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemMappingSystemColumn_GetPageAsc_F772354E78D4", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/SystemMappingSystemColumn/SearchByValue": { "post": { "tags": [ "SystemMappingSystemColumn" ], "summary": "SystemMappingSystemColumn: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemMappingSystemColumn-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemMappingSystemColumn_SearchByValue_5CC0894EC956", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.SystemMappingSystemColumn" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.SystemMappingSystemColumn" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.SystemMappingSystemColumn" } } } } } } }, "/api/SystemMappingSystemColumn/TryGetByValue": { "post": { "tags": [ "SystemMappingSystemColumn" ], "summary": "SystemMappingSystemColumn: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemMappingSystemColumn-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemMappingSystemColumn_TryGetByValue_75BC61EE75A8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemMappingSystemColumn" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemMappingSystemColumn" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemMappingSystemColumn" } } } } } } }, "/api/SystemMappingSystemColumn/UpsertGraph": { "put": { "tags": [ "SystemMappingSystemColumn" ], "summary": "SystemMappingSystemColumn: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemMappingSystemColumn-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemMappingSystemColumn_UpsertGraph_7F109403955F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemMappingSystemColumn" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemMappingSystemColumn" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemMappingSystemColumn" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemMappingSystemColumn" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemMappingSystemColumn" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemMappingSystemColumn" } } } } } } }, "/api/SystemMappingSystemColumn/UpsertGraphWithExtraFields": { "put": { "tags": [ "SystemMappingSystemColumn" ], "summary": "SystemMappingSystemColumn: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemMappingSystemColumn-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemMappingSystemColumn_UpsertGraphWithExtraFields_E1EA8A744C79", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemMappingSystemColumn" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemMappingSystemColumn" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemMappingSystemColumn" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemMappingSystemColumn" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemMappingSystemColumn" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemMappingSystemColumn" } } } } } } }, "/api/SystemTable": { "get": { "tags": [ "SystemTable" ], "summary": "SystemTable: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemTable_GetAll_17F1F4A95709", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemTable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemTable" } } } } } }, "post": { "tags": [ "SystemTable" ], "summary": "SystemTable: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemTable-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemTable_Post_9FD53C94792E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemTable" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemTable" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemTable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemTable" } } } } } }, "put": { "tags": [ "SystemTable" ], "summary": "SystemTable: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemTable-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemTable_Put_5C6BC3BCACB2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemTable" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemTable" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemTable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemTable" } } } } } } }, "/api/SystemTable/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "SystemTable" ], "summary": "SystemTable: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemTable_GetPageByValue_03CA075FD569", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/SystemTable/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "SystemTable" ], "summary": "SystemTable: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemTable_GetPageByValue2_B79306DE517D", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/SystemTable/DeleteByFilter": { "post": { "tags": [ "SystemTable" ], "summary": "SystemTable: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemTable-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemTable_DeleteByFilter_70F26F9026EC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/SystemTable/GetAllByValue": { "post": { "tags": [ "SystemTable" ], "summary": "SystemTable: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemTable_GetAllByValue_033015D823DF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemTable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemTable" } } } } } } }, "/api/SystemTable/GetAllGraphByValue": { "post": { "tags": [ "SystemTable" ], "summary": "SystemTable: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemTable_GetAllGraphByValue_9B75E289D2BA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemTable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemTable" } } } } } } }, "/api/SystemTable/GetByValue": { "post": { "tags": [ "SystemTable" ], "summary": "SystemTable: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemTable_GetByValue_77325FA3C23E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemTable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemTable" } } } } } } }, "/api/SystemTable/GetLookup": { "post": { "tags": [ "SystemTable" ], "summary": "SystemTable: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemTable_GetLookup_347FA70464A3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/SystemTable/GetLookupByValue": { "post": { "tags": [ "SystemTable" ], "summary": "SystemTable: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemTable_GetLookupByValue_2B477266BDE6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/SystemTable/Page": { "get": { "tags": [ "SystemTable" ], "summary": "SystemTable: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemTable_GetPage_BCAE05866736", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/SystemTable/PageAsc": { "get": { "tags": [ "SystemTable" ], "summary": "SystemTable: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemTable_GetPageAsc_323648E16BC3", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/SystemTable/SearchByValue": { "post": { "tags": [ "SystemTable" ], "summary": "SystemTable: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemTable_SearchByValue_EEF3C4DC56FF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.SystemTable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.SystemTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.SystemTable" } } } } } } }, "/api/SystemTable/TryGetByValue": { "post": { "tags": [ "SystemTable" ], "summary": "SystemTable: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemTable_TryGetByValue_79095F68D4AF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemTable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemTable" } } } } } } }, "/api/SystemTable/UpsertGraph": { "put": { "tags": [ "SystemTable" ], "summary": "SystemTable: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemTable-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemTable_UpsertGraph_6E66917B6AB5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemTable" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemTable" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemTable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemTable" } } } } } } }, "/api/SystemTable/UpsertGraphWithExtraFields": { "put": { "tags": [ "SystemTable" ], "summary": "SystemTable: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemTable-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemTable_UpsertGraphWithExtraFields_51179E10066F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemTable" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemTable" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemTable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemTable" } } } } } } }, "/api/SystemTableField": { "get": { "tags": [ "SystemTableField" ], "summary": "SystemTableField: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemTableField-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemTableField_GetAll_3BC2965FFFEB", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemTableField" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemTableField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemTableField" } } } } } }, "post": { "tags": [ "SystemTableField" ], "summary": "SystemTableField: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemTableField-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemTableField_Post_BF9360344524", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemTableField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemTableField" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemTableField" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemTableField" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemTableField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemTableField" } } } } } }, "put": { "tags": [ "SystemTableField" ], "summary": "SystemTableField: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemTableField-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemTableField_Put_5C70B728AE72", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemTableField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemTableField" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemTableField" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemTableField" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemTableField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemTableField" } } } } } } }, "/api/SystemTableField/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "SystemTableField" ], "summary": "SystemTableField: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemTableField-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemTableField_GetPageByValue_D4C22D841271", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/SystemTableField/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "SystemTableField" ], "summary": "SystemTableField: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemTableField-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemTableField_GetPageByValue2_D39C6FDA5B97", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/SystemTableField/DeleteByFilter": { "post": { "tags": [ "SystemTableField" ], "summary": "SystemTableField: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemTableField-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemTableField_DeleteByFilter_F01A7C55F105", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/SystemTableField/GetAllByValue": { "post": { "tags": [ "SystemTableField" ], "summary": "SystemTableField: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemTableField-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemTableField_GetAllByValue_F354F215BBC3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemTableField" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemTableField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemTableField" } } } } } } }, "/api/SystemTableField/GetAllGraphByValue": { "post": { "tags": [ "SystemTableField" ], "summary": "SystemTableField: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemTableField-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemTableField_GetAllGraphByValue_8B3C76803700", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemTableField" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemTableField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemTableField" } } } } } } }, "/api/SystemTableField/GetByValue": { "post": { "tags": [ "SystemTableField" ], "summary": "SystemTableField: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemTableField-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemTableField_GetByValue_96FC03411AF0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemTableField" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemTableField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemTableField" } } } } } } }, "/api/SystemTableField/GetLookup": { "post": { "tags": [ "SystemTableField" ], "summary": "SystemTableField: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemTableField-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemTableField_GetLookup_651B48A06A07", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/SystemTableField/GetLookupByValue": { "post": { "tags": [ "SystemTableField" ], "summary": "SystemTableField: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemTableField-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemTableField_GetLookupByValue_15E69EC9F458", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/SystemTableField/Page": { "get": { "tags": [ "SystemTableField" ], "summary": "SystemTableField: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemTableField-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemTableField_GetPage_E018C22C50E6", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/SystemTableField/PageAsc": { "get": { "tags": [ "SystemTableField" ], "summary": "SystemTableField: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemTableField-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemTableField_GetPageAsc_4BC0EDCF1AE5", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/SystemTableField/SearchByValue": { "post": { "tags": [ "SystemTableField" ], "summary": "SystemTableField: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemTableField-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemTableField_SearchByValue_795F15611470", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.SystemTableField" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.SystemTableField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.SystemTableField" } } } } } } }, "/api/SystemTableField/TryGetByValue": { "post": { "tags": [ "SystemTableField" ], "summary": "SystemTableField: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemTableField-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemTableField_TryGetByValue_BB34E69EE18C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemTableField" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemTableField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemTableField" } } } } } } }, "/api/SystemTableField/UpsertGraph": { "put": { "tags": [ "SystemTableField" ], "summary": "SystemTableField: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemTableField-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemTableField_UpsertGraph_2D2224E11A5B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemTableField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemTableField" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemTableField" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemTableField" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemTableField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemTableField" } } } } } } }, "/api/SystemTableField/UpsertGraphWithExtraFields": { "put": { "tags": [ "SystemTableField" ], "summary": "SystemTableField: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemTableField-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemTableField_UpsertGraphWithExtraFields_2BBCFBEB0279", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemTableField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemTableField" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemTableField" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemTableField" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemTableField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemTableField" } } } } } } }, "/api/SystemVersion": { "get": { "tags": [ "SystemVersion" ], "summary": "SystemVersion: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemVersion-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemVersion_GetAll_F17B8F0B253B", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemVersion" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemVersion" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemVersion" } } } } } }, "post": { "tags": [ "SystemVersion" ], "summary": "SystemVersion: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemVersion-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemVersion_Post_95750FB52CB2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemVersion" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemVersion" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemVersion" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemVersion" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemVersion" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemVersion" } } } } } }, "put": { "tags": [ "SystemVersion" ], "summary": "SystemVersion: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemVersion-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemVersion_Put_93A161E809DA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemVersion" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemVersion" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemVersion" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemVersion" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemVersion" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemVersion" } } } } } } }, "/api/SystemVersion/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "SystemVersion" ], "summary": "SystemVersion: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemVersion-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemVersion_GetPageByValue_C00FC3825C0F", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/SystemVersion/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "SystemVersion" ], "summary": "SystemVersion: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemVersion-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemVersion_GetPageByValue2_5D377A79CCDD", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/SystemVersion/DeleteByFilter": { "post": { "tags": [ "SystemVersion" ], "summary": "SystemVersion: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemVersion-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemVersion_DeleteByFilter_5FF8DDF28166", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/SystemVersion/GetAllByValue": { "post": { "tags": [ "SystemVersion" ], "summary": "SystemVersion: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemVersion-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemVersion_GetAllByValue_FFC9CFF4B6F9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemVersion" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemVersion" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemVersion" } } } } } } }, "/api/SystemVersion/GetAllGraphByValue": { "post": { "tags": [ "SystemVersion" ], "summary": "SystemVersion: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemVersion-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemVersion_GetAllGraphByValue_EC156A34032B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemVersion" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemVersion" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemVersion" } } } } } } }, "/api/SystemVersion/GetByValue": { "post": { "tags": [ "SystemVersion" ], "summary": "SystemVersion: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemVersion-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemVersion_GetByValue_9F37E7E49610", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemVersion" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemVersion" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemVersion" } } } } } } }, "/api/SystemVersion/GetLookup": { "post": { "tags": [ "SystemVersion" ], "summary": "SystemVersion: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemVersion-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemVersion_GetLookup_4E74F36FBF29", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/SystemVersion/GetLookupByValue": { "post": { "tags": [ "SystemVersion" ], "summary": "SystemVersion: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemVersion-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemVersion_GetLookupByValue_337CCB5EA5DB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/SystemVersion/IsDbUpdateRequired": { "get": { "tags": [ "SystemVersion" ], "summary": "SystemVersion: IsDbUpdateRequired", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemVersion-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemVersion_IsDbUpdateRequired_6646EBE34742", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/SystemVersion/Page": { "get": { "tags": [ "SystemVersion" ], "summary": "SystemVersion: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemVersion-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemVersion_GetPage_631F1BA8D2FF", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/SystemVersion/PageAsc": { "get": { "tags": [ "SystemVersion" ], "summary": "SystemVersion: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemVersion-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemVersion_GetPageAsc_5A15A8E19812", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/SystemVersion/SearchByValue": { "post": { "tags": [ "SystemVersion" ], "summary": "SystemVersion: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemVersion-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemVersion_SearchByValue_BB958A05526C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.SystemVersion" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.SystemVersion" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.SystemVersion" } } } } } } }, "/api/SystemVersion/TryGetByValue": { "post": { "tags": [ "SystemVersion" ], "summary": "SystemVersion: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemVersion-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemVersion_TryGetByValue_71A991DD93B3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemVersion" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemVersion" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemVersion" } } } } } } }, "/api/SystemVersion/UpdateDatabase": { "post": { "tags": [ "SystemVersion" ], "summary": "SystemVersion: UpdateDb", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemVersion-Create.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemVersion_UpdateDb_3C5449F65851", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.String" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.String" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.String" } } } } } } }, "/api/SystemVersion/UpsertGraph": { "put": { "tags": [ "SystemVersion" ], "summary": "SystemVersion: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemVersion-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemVersion_UpsertGraph_05240C7FFF63", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemVersion" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemVersion" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemVersion" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemVersion" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemVersion" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemVersion" } } } } } } }, "/api/SystemVersion/UpsertGraphWithExtraFields": { "put": { "tags": [ "SystemVersion" ], "summary": "SystemVersion: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemVersion-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemVersion_UpsertGraphWithExtraFields_75C8948CC4C7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemVersion" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemVersion" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemVersion" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemVersion" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemVersion" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemVersion" } } } } } } }, "/api/SystemView": { "get": { "tags": [ "SystemView" ], "summary": "SystemView: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemView-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemView_GetAll_E0E22E8C6815", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemView" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemView" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemView" } } } } } }, "post": { "tags": [ "SystemView" ], "summary": "SystemView: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemView-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemView_Post_6D98614CACA7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemView" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemView" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemView" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemView" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemView" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemView" } } } } } }, "put": { "tags": [ "SystemView" ], "summary": "SystemView: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemView-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemView_Put_45D3F4F20379", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemView" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemView" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemView" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemView" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemView" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemView" } } } } } } }, "/api/SystemView/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "SystemView" ], "summary": "SystemView: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemView-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemView_GetPageByValue_B845AC73C8F5", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/SystemView/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "SystemView" ], "summary": "SystemView: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemView-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemView_GetPageByValue2_DB5A29E432C4", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/SystemView/DeleteByFilter": { "post": { "tags": [ "SystemView" ], "summary": "SystemView: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemView-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemView_DeleteByFilter_5ED1A6E2D7D3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/SystemView/GetAllByValue": { "post": { "tags": [ "SystemView" ], "summary": "SystemView: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemView-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemView_GetAllByValue_3C62D1883676", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemView" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemView" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemView" } } } } } } }, "/api/SystemView/GetAllGraphByValue": { "post": { "tags": [ "SystemView" ], "summary": "SystemView: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemView-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemView_GetAllGraphByValue_173E93510F5B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemView" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemView" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemView" } } } } } } }, "/api/SystemView/GetByValue": { "post": { "tags": [ "SystemView" ], "summary": "SystemView: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemView-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemView_GetByValue_927DE3AF4D25", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemView" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemView" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemView" } } } } } } }, "/api/SystemView/GetLookup": { "post": { "tags": [ "SystemView" ], "summary": "SystemView: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemView-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemView_GetLookup_AA2B1E1BDC06", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/SystemView/GetLookupByValue": { "post": { "tags": [ "SystemView" ], "summary": "SystemView: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemView-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemView_GetLookupByValue_3572C46D2422", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/SystemView/Page": { "get": { "tags": [ "SystemView" ], "summary": "SystemView: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemView-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemView_GetPage_DE8CB8823D19", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/SystemView/PageAsc": { "get": { "tags": [ "SystemView" ], "summary": "SystemView: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemView-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemView_GetPageAsc_E5F2453E14BD", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/SystemView/SearchByValue": { "post": { "tags": [ "SystemView" ], "summary": "SystemView: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemView-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemView_SearchByValue_DC0C960844AE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.SystemView" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.SystemView" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.SystemView" } } } } } } }, "/api/SystemView/TryGetByValue": { "post": { "tags": [ "SystemView" ], "summary": "SystemView: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemView-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemView_TryGetByValue_A3A87C984D09", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemView" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemView" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemView" } } } } } } }, "/api/SystemView/UpsertGraph": { "put": { "tags": [ "SystemView" ], "summary": "SystemView: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemView-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemView_UpsertGraph_2E3D017EFF5E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemView" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemView" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemView" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemView" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemView" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemView" } } } } } } }, "/api/SystemView/UpsertGraphWithExtraFields": { "put": { "tags": [ "SystemView" ], "summary": "SystemView: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: SystemView-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "SystemView_UpsertGraphWithExtraFields_B7030E23BFF7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemView" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemView" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemView" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemView" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemView" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemView" } } } } } } }, "/api/TextBlock": { "get": { "tags": [ "TextBlock" ], "summary": "TextBlock: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TextBlock-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TextBlock_GetAll_992EA5A034BB", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TextBlock" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TextBlock" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TextBlock" } } } } } }, "post": { "tags": [ "TextBlock" ], "summary": "TextBlock: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TextBlock-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TextBlock_Post_8EED9BA5EA35", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TextBlock" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TextBlock" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TextBlock" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TextBlock" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TextBlock" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TextBlock" } } } } } }, "put": { "tags": [ "TextBlock" ], "summary": "TextBlock: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TextBlock-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TextBlock_Put_8B1A33AB4BA5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TextBlock" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TextBlock" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TextBlock" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TextBlock" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TextBlock" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TextBlock" } } } } } } }, "/api/TextBlock/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "TextBlock" ], "summary": "TextBlock: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TextBlock-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TextBlock_GetPageByValue_9A3DB7DFC44C", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/TextBlock/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "TextBlock" ], "summary": "TextBlock: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TextBlock-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TextBlock_GetPageByValue2_546BFEF7F092", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/TextBlock/DeleteByFilter": { "post": { "tags": [ "TextBlock" ], "summary": "TextBlock: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TextBlock-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TextBlock_DeleteByFilter_FFBECCAA3BBA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/TextBlock/GetAllByValue": { "post": { "tags": [ "TextBlock" ], "summary": "TextBlock: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TextBlock-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TextBlock_GetAllByValue_D55B12BBA678", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TextBlock" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TextBlock" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TextBlock" } } } } } } }, "/api/TextBlock/GetAllGraphByValue": { "post": { "tags": [ "TextBlock" ], "summary": "TextBlock: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TextBlock-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TextBlock_GetAllGraphByValue_BC167A8872D4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TextBlock" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TextBlock" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TextBlock" } } } } } } }, "/api/TextBlock/GetByValue": { "post": { "tags": [ "TextBlock" ], "summary": "TextBlock: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TextBlock-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TextBlock_GetByValue_76CD00AFA4C6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TextBlock" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TextBlock" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TextBlock" } } } } } } }, "/api/TextBlock/GetLookup": { "post": { "tags": [ "TextBlock" ], "summary": "TextBlock: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TextBlock-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TextBlock_GetLookup_966C66CF47A0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/TextBlock/GetLookupByValue": { "post": { "tags": [ "TextBlock" ], "summary": "TextBlock: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TextBlock-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TextBlock_GetLookupByValue_A893EC6AFFDD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/TextBlock/Page": { "get": { "tags": [ "TextBlock" ], "summary": "TextBlock: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TextBlock-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TextBlock_GetPage_B63B19806A22", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/TextBlock/PageAsc": { "get": { "tags": [ "TextBlock" ], "summary": "TextBlock: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TextBlock-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TextBlock_GetPageAsc_9C616ED883FC", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/TextBlock/PageTextBlocksByGroup/{GroupId}/{IncludeSubNodes}": { "get": { "tags": [ "TextBlock" ], "summary": "TextBlock: GetPageTextBlocksByGroup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TextBlock-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TextBlock_GetPageTextBlocksByGroup_65180914876C", "parameters": [ { "name": "GroupId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "IncludeSubNodes", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/TextBlock/SearchByValue": { "post": { "tags": [ "TextBlock" ], "summary": "TextBlock: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TextBlock-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TextBlock_SearchByValue_9983B929AB7B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.TextBlock" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.TextBlock" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.TextBlock" } } } } } } }, "/api/TextBlock/TryGetByValue": { "post": { "tags": [ "TextBlock" ], "summary": "TextBlock: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TextBlock-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TextBlock_TryGetByValue_0C157E78889B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TextBlock" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TextBlock" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TextBlock" } } } } } } }, "/api/TextBlock/UpsertGraph": { "put": { "tags": [ "TextBlock" ], "summary": "TextBlock: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TextBlock-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TextBlock_UpsertGraph_E5BA728F53E9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TextBlock" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TextBlock" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TextBlock" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TextBlock" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TextBlock" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TextBlock" } } } } } } }, "/api/TextBlock/UpsertGraphWithExtraFields": { "put": { "tags": [ "TextBlock" ], "summary": "TextBlock: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TextBlock-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TextBlock_UpsertGraphWithExtraFields_DF468E0BE85E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TextBlock" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TextBlock" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TextBlock" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TextBlock" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TextBlock" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TextBlock" } } } } } } }, "/api/TextBlockGroup": { "get": { "tags": [ "TextBlockGroup" ], "summary": "TextBlockGroup: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TextBlockGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TextBlockGroup_GetAll_8FF3AC972E51", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TextBlockGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TextBlockGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TextBlockGroup" } } } } } }, "post": { "tags": [ "TextBlockGroup" ], "summary": "TextBlockGroup: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TextBlockGroup-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TextBlockGroup_Post_69DED5B0B896", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TextBlockGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TextBlockGroup" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TextBlockGroup" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TextBlockGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TextBlockGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TextBlockGroup" } } } } } }, "put": { "tags": [ "TextBlockGroup" ], "summary": "TextBlockGroup: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TextBlockGroup-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TextBlockGroup_Put_DC586856E7C5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TextBlockGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TextBlockGroup" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TextBlockGroup" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TextBlockGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TextBlockGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TextBlockGroup" } } } } } } }, "/api/TextBlockGroup/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "TextBlockGroup" ], "summary": "TextBlockGroup: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TextBlockGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TextBlockGroup_GetPageByValue_9641F8BF48BB", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/TextBlockGroup/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "TextBlockGroup" ], "summary": "TextBlockGroup: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TextBlockGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TextBlockGroup_GetPageByValue2_6448E55C68CF", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/TextBlockGroup/DeleteByFilter": { "post": { "tags": [ "TextBlockGroup" ], "summary": "TextBlockGroup: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TextBlockGroup-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TextBlockGroup_DeleteByFilter_F978CA6FC152", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/TextBlockGroup/GetAllByValue": { "post": { "tags": [ "TextBlockGroup" ], "summary": "TextBlockGroup: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TextBlockGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TextBlockGroup_GetAllByValue_147C54B4437E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TextBlockGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TextBlockGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TextBlockGroup" } } } } } } }, "/api/TextBlockGroup/GetAllGraphByValue": { "post": { "tags": [ "TextBlockGroup" ], "summary": "TextBlockGroup: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TextBlockGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TextBlockGroup_GetAllGraphByValue_7DADB3B0E8BD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TextBlockGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TextBlockGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TextBlockGroup" } } } } } } }, "/api/TextBlockGroup/GetByValue": { "post": { "tags": [ "TextBlockGroup" ], "summary": "TextBlockGroup: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TextBlockGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TextBlockGroup_GetByValue_9B44FFF5C756", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TextBlockGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TextBlockGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TextBlockGroup" } } } } } } }, "/api/TextBlockGroup/GetLookup": { "post": { "tags": [ "TextBlockGroup" ], "summary": "TextBlockGroup: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TextBlockGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TextBlockGroup_GetLookup_F9BDE96F2F06", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/TextBlockGroup/GetLookupByValue": { "post": { "tags": [ "TextBlockGroup" ], "summary": "TextBlockGroup: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TextBlockGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TextBlockGroup_GetLookupByValue_2DAF9FFCE337", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/TextBlockGroup/Page": { "get": { "tags": [ "TextBlockGroup" ], "summary": "TextBlockGroup: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TextBlockGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TextBlockGroup_GetPage_1FFF33579865", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/TextBlockGroup/PageAsc": { "get": { "tags": [ "TextBlockGroup" ], "summary": "TextBlockGroup: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TextBlockGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TextBlockGroup_GetPageAsc_0EF00EE416B1", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/TextBlockGroup/PageTextBlockGroupsByParent/{ParentId}/{IncludeSubNodes}/{TopParentsOnly}": { "get": { "tags": [ "TextBlockGroup" ], "summary": "TextBlockGroup: GetPageTextBlockGroupsByParent", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TextBlockGroup-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TextBlockGroup_GetPageTextBlockGroupsByParent_F2CF3D9130B9", "parameters": [ { "name": "ParentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "IncludeSubNodes", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "TopParentsOnly", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/TextBlockGroup/SearchByValue": { "post": { "tags": [ "TextBlockGroup" ], "summary": "TextBlockGroup: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TextBlockGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TextBlockGroup_SearchByValue_876A8C37D9B1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.TextBlockGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.TextBlockGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.TextBlockGroup" } } } } } } }, "/api/TextBlockGroup/TryGetByValue": { "post": { "tags": [ "TextBlockGroup" ], "summary": "TextBlockGroup: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TextBlockGroup-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TextBlockGroup_TryGetByValue_EBB07E935181", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TextBlockGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TextBlockGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TextBlockGroup" } } } } } } }, "/api/TextBlockGroup/UpsertGraph": { "put": { "tags": [ "TextBlockGroup" ], "summary": "TextBlockGroup: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TextBlockGroup-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TextBlockGroup_UpsertGraph_388EB8401481", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TextBlockGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TextBlockGroup" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TextBlockGroup" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TextBlockGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TextBlockGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TextBlockGroup" } } } } } } }, "/api/TextBlockGroup/UpsertGraphWithExtraFields": { "put": { "tags": [ "TextBlockGroup" ], "summary": "TextBlockGroup: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TextBlockGroup-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TextBlockGroup_UpsertGraphWithExtraFields_78D336F1E037", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TextBlockGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TextBlockGroup" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TextBlockGroup" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TextBlockGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TextBlockGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TextBlockGroup" } } } } } } }, "/api/TextVariable": { "get": { "tags": [ "TextVariable" ], "summary": "TextVariable: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TextVariable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TextVariable_GetAll_BAF1DDBA6502", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TextVariable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TextVariable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TextVariable" } } } } } }, "post": { "tags": [ "TextVariable" ], "summary": "TextVariable: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TextVariable-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TextVariable_Post_A8123AFE9795", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TextVariable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TextVariable" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TextVariable" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TextVariable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TextVariable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TextVariable" } } } } } }, "put": { "tags": [ "TextVariable" ], "summary": "TextVariable: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TextVariable-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TextVariable_Put_B828D3648625", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TextVariable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TextVariable" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TextVariable" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TextVariable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TextVariable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TextVariable" } } } } } } }, "/api/TextVariable/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "TextVariable" ], "summary": "TextVariable: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TextVariable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TextVariable_GetPageByValue_3902276F5798", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/TextVariable/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "TextVariable" ], "summary": "TextVariable: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TextVariable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TextVariable_GetPageByValue2_16F302A5E0A2", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/TextVariable/DeleteByFilter": { "post": { "tags": [ "TextVariable" ], "summary": "TextVariable: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TextVariable-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TextVariable_DeleteByFilter_E4019151A2C3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/TextVariable/GetAllByValue": { "post": { "tags": [ "TextVariable" ], "summary": "TextVariable: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TextVariable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TextVariable_GetAllByValue_EAEDDB765C92", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TextVariable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TextVariable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TextVariable" } } } } } } }, "/api/TextVariable/GetAllGraphByValue": { "post": { "tags": [ "TextVariable" ], "summary": "TextVariable: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TextVariable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TextVariable_GetAllGraphByValue_A497DFD5367F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TextVariable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TextVariable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TextVariable" } } } } } } }, "/api/TextVariable/GetByValue": { "post": { "tags": [ "TextVariable" ], "summary": "TextVariable: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TextVariable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TextVariable_GetByValue_35B7F6DD4402", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TextVariable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TextVariable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TextVariable" } } } } } } }, "/api/TextVariable/GetLookup": { "post": { "tags": [ "TextVariable" ], "summary": "TextVariable: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TextVariable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TextVariable_GetLookup_5DD8C646B7B1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/TextVariable/GetLookupByValue": { "post": { "tags": [ "TextVariable" ], "summary": "TextVariable: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TextVariable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TextVariable_GetLookupByValue_C3704986F702", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/TextVariable/Page": { "get": { "tags": [ "TextVariable" ], "summary": "TextVariable: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TextVariable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TextVariable_GetPage_10A8424C0740", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/TextVariable/PageAsc": { "get": { "tags": [ "TextVariable" ], "summary": "TextVariable: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TextVariable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TextVariable_GetPageAsc_0D4FA3965F26", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/TextVariable/SearchByValue": { "post": { "tags": [ "TextVariable" ], "summary": "TextVariable: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TextVariable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TextVariable_SearchByValue_87B0B5A7C06F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.TextVariable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.TextVariable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.TextVariable" } } } } } } }, "/api/TextVariable/TryGetByValue": { "post": { "tags": [ "TextVariable" ], "summary": "TextVariable: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TextVariable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TextVariable_TryGetByValue_F65AFD1632D8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TextVariable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TextVariable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TextVariable" } } } } } } }, "/api/TextVariable/UpsertGraph": { "put": { "tags": [ "TextVariable" ], "summary": "TextVariable: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TextVariable-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TextVariable_UpsertGraph_8AF6F452407E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TextVariable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TextVariable" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TextVariable" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TextVariable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TextVariable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TextVariable" } } } } } } }, "/api/TextVariable/UpsertGraphWithExtraFields": { "put": { "tags": [ "TextVariable" ], "summary": "TextVariable: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TextVariable-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TextVariable_UpsertGraphWithExtraFields_ED7C05FA2FA4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TextVariable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TextVariable" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TextVariable" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TextVariable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TextVariable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TextVariable" } } } } } } }, "/api/TimeTracking": { "get": { "tags": [ "TimeTracking" ], "summary": "TimeTracking: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TimeTracking-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TimeTracking_GetAll_6E2F534C6A4E", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TimeTracking" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TimeTracking" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TimeTracking" } } } } } }, "post": { "tags": [ "TimeTracking" ], "summary": "TimeTracking: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TimeTracking-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TimeTracking_Post_75817C39F133", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TimeTracking" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TimeTracking" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TimeTracking" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TimeTracking" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TimeTracking" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TimeTracking" } } } } } }, "put": { "tags": [ "TimeTracking" ], "summary": "TimeTracking: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TimeTracking-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TimeTracking_Put_3C8E13410B6D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TimeTracking" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TimeTracking" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TimeTracking" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TimeTracking" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TimeTracking" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TimeTracking" } } } } } } }, "/api/TimeTracking/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "TimeTracking" ], "summary": "TimeTracking: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TimeTracking-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TimeTracking_GetPageByValue_08C236DBD93C", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/TimeTracking/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "TimeTracking" ], "summary": "TimeTracking: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TimeTracking-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TimeTracking_GetPageByValue2_3BDBC69736E2", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/TimeTracking/DeleteByFilter": { "post": { "tags": [ "TimeTracking" ], "summary": "TimeTracking: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TimeTracking-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TimeTracking_DeleteByFilter_C4DD586CF58C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/TimeTracking/GetAllByValue": { "post": { "tags": [ "TimeTracking" ], "summary": "TimeTracking: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TimeTracking-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TimeTracking_GetAllByValue_C51286BDD9F8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TimeTracking" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TimeTracking" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TimeTracking" } } } } } } }, "/api/TimeTracking/GetAllGraphByValue": { "post": { "tags": [ "TimeTracking" ], "summary": "TimeTracking: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TimeTracking-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TimeTracking_GetAllGraphByValue_55B065C7FB4F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TimeTracking" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TimeTracking" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TimeTracking" } } } } } } }, "/api/TimeTracking/GetByValue": { "post": { "tags": [ "TimeTracking" ], "summary": "TimeTracking: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TimeTracking-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TimeTracking_GetByValue_3D5D30779123", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TimeTracking" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TimeTracking" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TimeTracking" } } } } } } }, "/api/TimeTracking/GetLookup": { "post": { "tags": [ "TimeTracking" ], "summary": "TimeTracking: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TimeTracking-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TimeTracking_GetLookup_34262EE16F7D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/TimeTracking/GetLookupByValue": { "post": { "tags": [ "TimeTracking" ], "summary": "TimeTracking: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TimeTracking-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TimeTracking_GetLookupByValue_407A3C292433", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/TimeTracking/GetRunningTimeTracking": { "get": { "tags": [ "TimeTracking" ], "summary": "TimeTracking: GetRunningTimeTracking", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TimeTracking-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TimeTracking_GetRunningTimeTracking_7D05D211A297", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TimeTracking" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TimeTracking" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TimeTracking" } } } } } } }, "/api/TimeTracking/Page": { "get": { "tags": [ "TimeTracking" ], "summary": "TimeTracking: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TimeTracking-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TimeTracking_GetPage_D545691AB013", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/TimeTracking/PageAsc": { "get": { "tags": [ "TimeTracking" ], "summary": "TimeTracking: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TimeTracking-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TimeTracking_GetPageAsc_88F393D5B764", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/TimeTracking/PageFromView": { "get": { "tags": [ "TimeTracking" ], "summary": "TimeTracking: GetPageFromView", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TimeTracking-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TimeTracking_GetPageFromView_FF71EC1C5C16", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/TimeTracking/SearchByValue": { "post": { "tags": [ "TimeTracking" ], "summary": "TimeTracking: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TimeTracking-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TimeTracking_SearchByValue_5E24FFA7DAE4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.TimeTracking" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.TimeTracking" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.TimeTracking" } } } } } } }, "/api/TimeTracking/TryGetByValue": { "post": { "tags": [ "TimeTracking" ], "summary": "TimeTracking: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TimeTracking-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TimeTracking_TryGetByValue_4FD2EA10294F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TimeTracking" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TimeTracking" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TimeTracking" } } } } } } }, "/api/TimeTracking/UpsertGraph": { "put": { "tags": [ "TimeTracking" ], "summary": "TimeTracking: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TimeTracking-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TimeTracking_UpsertGraph_9FBB0E8C3067", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TimeTracking" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TimeTracking" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TimeTracking" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TimeTracking" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TimeTracking" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TimeTracking" } } } } } } }, "/api/TimeTracking/UpsertGraphWithExtraFields": { "put": { "tags": [ "TimeTracking" ], "summary": "TimeTracking: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TimeTracking-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TimeTracking_UpsertGraphWithExtraFields_17F443633020", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TimeTracking" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TimeTracking" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TimeTracking" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TimeTracking" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TimeTracking" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TimeTracking" } } } } } } }, "/api/TimeTrackingSetting": { "get": { "tags": [ "TimeTrackingSetting" ], "summary": "TimeTrackingSetting: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TimeTrackingSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TimeTrackingSetting_GetAll_74C312A69A47", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TimeTrackingSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TimeTrackingSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TimeTrackingSetting" } } } } } }, "post": { "tags": [ "TimeTrackingSetting" ], "summary": "TimeTrackingSetting: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TimeTrackingSetting-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TimeTrackingSetting_Post_87AD1ED0511B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TimeTrackingSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TimeTrackingSetting" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TimeTrackingSetting" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TimeTrackingSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TimeTrackingSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TimeTrackingSetting" } } } } } }, "put": { "tags": [ "TimeTrackingSetting" ], "summary": "TimeTrackingSetting: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TimeTrackingSetting-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TimeTrackingSetting_Put_9AC92D1523D5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TimeTrackingSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TimeTrackingSetting" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TimeTrackingSetting" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TimeTrackingSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TimeTrackingSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TimeTrackingSetting" } } } } } } }, "/api/TimeTrackingSetting/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "TimeTrackingSetting" ], "summary": "TimeTrackingSetting: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TimeTrackingSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TimeTrackingSetting_GetPageByValue_CC055B62D3D9", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/TimeTrackingSetting/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "TimeTrackingSetting" ], "summary": "TimeTrackingSetting: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TimeTrackingSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TimeTrackingSetting_GetPageByValue2_D5057F65EEB1", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/TimeTrackingSetting/DeleteByFilter": { "post": { "tags": [ "TimeTrackingSetting" ], "summary": "TimeTrackingSetting: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TimeTrackingSetting-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TimeTrackingSetting_DeleteByFilter_56C148D1A799", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/TimeTrackingSetting/GetAllByValue": { "post": { "tags": [ "TimeTrackingSetting" ], "summary": "TimeTrackingSetting: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TimeTrackingSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TimeTrackingSetting_GetAllByValue_172D5895183C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TimeTrackingSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TimeTrackingSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TimeTrackingSetting" } } } } } } }, "/api/TimeTrackingSetting/GetAllGraphByValue": { "post": { "tags": [ "TimeTrackingSetting" ], "summary": "TimeTrackingSetting: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TimeTrackingSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TimeTrackingSetting_GetAllGraphByValue_4F0C9950D752", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TimeTrackingSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TimeTrackingSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TimeTrackingSetting" } } } } } } }, "/api/TimeTrackingSetting/GetByValue": { "post": { "tags": [ "TimeTrackingSetting" ], "summary": "TimeTrackingSetting: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TimeTrackingSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TimeTrackingSetting_GetByValue_717BD09FC23C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TimeTrackingSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TimeTrackingSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TimeTrackingSetting" } } } } } } }, "/api/TimeTrackingSetting/GetLookup": { "post": { "tags": [ "TimeTrackingSetting" ], "summary": "TimeTrackingSetting: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TimeTrackingSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TimeTrackingSetting_GetLookup_1596A0067E4C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/TimeTrackingSetting/GetLookupByValue": { "post": { "tags": [ "TimeTrackingSetting" ], "summary": "TimeTrackingSetting: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TimeTrackingSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TimeTrackingSetting_GetLookupByValue_DF3571EA9489", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/TimeTrackingSetting/Page": { "get": { "tags": [ "TimeTrackingSetting" ], "summary": "TimeTrackingSetting: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TimeTrackingSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TimeTrackingSetting_GetPage_ED2650E48142", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/TimeTrackingSetting/PageAsc": { "get": { "tags": [ "TimeTrackingSetting" ], "summary": "TimeTrackingSetting: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TimeTrackingSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TimeTrackingSetting_GetPageAsc_4CC97E01A04F", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/TimeTrackingSetting/SearchByValue": { "post": { "tags": [ "TimeTrackingSetting" ], "summary": "TimeTrackingSetting: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TimeTrackingSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TimeTrackingSetting_SearchByValue_4659920FE887", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.TimeTrackingSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.TimeTrackingSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.TimeTrackingSetting" } } } } } } }, "/api/TimeTrackingSetting/TryGetByValue": { "post": { "tags": [ "TimeTrackingSetting" ], "summary": "TimeTrackingSetting: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TimeTrackingSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TimeTrackingSetting_TryGetByValue_806E0C24ACB9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TimeTrackingSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TimeTrackingSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TimeTrackingSetting" } } } } } } }, "/api/TimeTrackingSetting/UpsertGraph": { "put": { "tags": [ "TimeTrackingSetting" ], "summary": "TimeTrackingSetting: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TimeTrackingSetting-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TimeTrackingSetting_UpsertGraph_059457CD085B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TimeTrackingSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TimeTrackingSetting" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TimeTrackingSetting" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TimeTrackingSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TimeTrackingSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TimeTrackingSetting" } } } } } } }, "/api/TimeTrackingSetting/UpsertGraphWithExtraFields": { "put": { "tags": [ "TimeTrackingSetting" ], "summary": "TimeTrackingSetting: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TimeTrackingSetting-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TimeTrackingSetting_UpsertGraphWithExtraFields_A52948C14724", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TimeTrackingSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TimeTrackingSetting" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TimeTrackingSetting" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TimeTrackingSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TimeTrackingSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TimeTrackingSetting" } } } } } } }, "/api/ToolboxButton": { "get": { "tags": [ "ToolboxButton" ], "summary": "ToolboxButton: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ToolboxButton-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ToolboxButton_GetAll_A7BC62587166", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ToolboxButton" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ToolboxButton" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ToolboxButton" } } } } } }, "post": { "tags": [ "ToolboxButton" ], "summary": "ToolboxButton: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ToolboxButton-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ToolboxButton_Post_514394E6EEE7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxButton" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxButton" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxButton" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ToolboxButton" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ToolboxButton" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ToolboxButton" } } } } } }, "put": { "tags": [ "ToolboxButton" ], "summary": "ToolboxButton: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ToolboxButton-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ToolboxButton_Put_037D8BF9F921", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxButton" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxButton" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxButton" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ToolboxButton" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ToolboxButton" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ToolboxButton" } } } } } } }, "/api/ToolboxButton/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "ToolboxButton" ], "summary": "ToolboxButton: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ToolboxButton-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ToolboxButton_GetPageByValue_C8B2A47462CE", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ToolboxButton/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "ToolboxButton" ], "summary": "ToolboxButton: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ToolboxButton-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ToolboxButton_GetPageByValue2_3B3C9C9094F0", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ToolboxButton/{targetPageId}/GetRuntimeButtons": { "get": { "tags": [ "ToolboxButton" ], "summary": "ToolboxButton: GetRuntimeButtons", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ToolboxButton_GetRuntimeButtons_B537950EABA4", "parameters": [ { "name": "targetPageId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ToolboxButton" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ToolboxButton" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ToolboxButton" } } } } } } }, "/api/ToolboxButton/DeleteByFilter": { "post": { "tags": [ "ToolboxButton" ], "summary": "ToolboxButton: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ToolboxButton-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ToolboxButton_DeleteByFilter_076DBFA85954", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/ToolboxButton/GetAllByValue": { "post": { "tags": [ "ToolboxButton" ], "summary": "ToolboxButton: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ToolboxButton-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ToolboxButton_GetAllByValue_F1507B402DA4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ToolboxButton" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ToolboxButton" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ToolboxButton" } } } } } } }, "/api/ToolboxButton/GetAllGraphByValue": { "post": { "tags": [ "ToolboxButton" ], "summary": "ToolboxButton: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ToolboxButton-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ToolboxButton_GetAllGraphByValue_A8663D8306E5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ToolboxButton" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ToolboxButton" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ToolboxButton" } } } } } } }, "/api/ToolboxButton/GetByValue": { "post": { "tags": [ "ToolboxButton" ], "summary": "ToolboxButton: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ToolboxButton-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ToolboxButton_GetByValue_1DC76D4FC1E7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ToolboxButton" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ToolboxButton" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ToolboxButton" } } } } } } }, "/api/ToolboxButton/GetLookup": { "post": { "tags": [ "ToolboxButton" ], "summary": "ToolboxButton: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ToolboxButton-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ToolboxButton_GetLookup_62B1A96149A6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ToolboxButton/GetLookupByValue": { "post": { "tags": [ "ToolboxButton" ], "summary": "ToolboxButton: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ToolboxButton-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ToolboxButton_GetLookupByValue_198D2EAF63A3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ToolboxButton/Page": { "get": { "tags": [ "ToolboxButton" ], "summary": "ToolboxButton: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ToolboxButton-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ToolboxButton_GetPage_BABCD84FE59D", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ToolboxButton/PageAsc": { "get": { "tags": [ "ToolboxButton" ], "summary": "ToolboxButton: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ToolboxButton-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ToolboxButton_GetPageAsc_B34F48C795BB", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ToolboxButton/SearchByValue": { "post": { "tags": [ "ToolboxButton" ], "summary": "ToolboxButton: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ToolboxButton-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ToolboxButton_SearchByValue_55CA0EE18563", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ToolboxButton" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ToolboxButton" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ToolboxButton" } } } } } } }, "/api/ToolboxButton/TryGetByValue": { "post": { "tags": [ "ToolboxButton" ], "summary": "ToolboxButton: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ToolboxButton-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ToolboxButton_TryGetByValue_EE85B3639B7E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ToolboxButton" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ToolboxButton" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ToolboxButton" } } } } } } }, "/api/ToolboxButton/UpsertGraph": { "put": { "tags": [ "ToolboxButton" ], "summary": "ToolboxButton: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ToolboxButton-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ToolboxButton_UpsertGraph_E40770F5B126", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxButton" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxButton" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxButton" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ToolboxButton" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ToolboxButton" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ToolboxButton" } } } } } } }, "/api/ToolboxButton/UpsertGraphWithExtraFields": { "put": { "tags": [ "ToolboxButton" ], "summary": "ToolboxButton: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ToolboxButton-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ToolboxButton_UpsertGraphWithExtraFields_24666EE56EB3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ToolboxButton" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ToolboxButton" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ToolboxButton" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ToolboxButton" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ToolboxButton" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ToolboxButton" } } } } } } }, "/api/ToolboxField": { "get": { "tags": [ "ToolboxField" ], "summary": "ToolboxField: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ToolboxField-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ToolboxField_GetAll_C120CA69AB37", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ToolboxField" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ToolboxField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ToolboxField" } } } } } }, "post": { "tags": [ "ToolboxField" ], "summary": "ToolboxField: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ToolboxField-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ToolboxField_Post_A8FB2F6915B9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxField" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxField" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ToolboxField" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ToolboxField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ToolboxField" } } } } } }, "put": { "tags": [ "ToolboxField" ], "summary": "ToolboxField: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ToolboxField-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ToolboxField_Put_FDC664CC2A91", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxField" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxField" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ToolboxField" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ToolboxField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ToolboxField" } } } } } } }, "/api/ToolboxField/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "ToolboxField" ], "summary": "ToolboxField: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ToolboxField-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ToolboxField_GetPageByValue_68286D40EC82", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ToolboxField/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "ToolboxField" ], "summary": "ToolboxField: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ToolboxField-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ToolboxField_GetPageByValue2_517FFE4BED14", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ToolboxField/DeleteByFilter": { "post": { "tags": [ "ToolboxField" ], "summary": "ToolboxField: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ToolboxField-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ToolboxField_DeleteByFilter_519E23E40F85", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/ToolboxField/GetAllByValue": { "post": { "tags": [ "ToolboxField" ], "summary": "ToolboxField: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ToolboxField-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ToolboxField_GetAllByValue_E5ABB90EBC61", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ToolboxField" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ToolboxField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ToolboxField" } } } } } } }, "/api/ToolboxField/GetAllGraphByValue": { "post": { "tags": [ "ToolboxField" ], "summary": "ToolboxField: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ToolboxField-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ToolboxField_GetAllGraphByValue_571732DF5637", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ToolboxField" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ToolboxField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ToolboxField" } } } } } } }, "/api/ToolboxField/GetByValue": { "post": { "tags": [ "ToolboxField" ], "summary": "ToolboxField: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ToolboxField-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ToolboxField_GetByValue_C2338A0F25FD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ToolboxField" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ToolboxField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ToolboxField" } } } } } } }, "/api/ToolboxField/GetLookup": { "post": { "tags": [ "ToolboxField" ], "summary": "ToolboxField: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ToolboxField-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ToolboxField_GetLookup_972441EBC160", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ToolboxField/GetLookupByValue": { "post": { "tags": [ "ToolboxField" ], "summary": "ToolboxField: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ToolboxField-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ToolboxField_GetLookupByValue_FFF009E5D361", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/ToolboxField/options/{toolboxFieldId}": { "get": { "tags": [ "ToolboxField" ], "summary": "ToolboxField: GetOptions", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ToolboxField_GetOptions_750EBDF9E09C", "parameters": [ { "name": "toolboxFieldId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ToolboxFieldOptionDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ToolboxFieldOptionDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ToolboxFieldOptionDto" } } } } } }, "put": { "tags": [ "ToolboxField" ], "summary": "ToolboxField: SaveOptions", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ToolboxField-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ToolboxField_SaveOptions_8714B830D66A", "parameters": [ { "name": "toolboxFieldId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldOptionDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldOptionDto" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldOptionDto" } } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/ToolboxField/Page": { "get": { "tags": [ "ToolboxField" ], "summary": "ToolboxField: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ToolboxField-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ToolboxField_GetPage_FADFED7AD622", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ToolboxField/PageAsc": { "get": { "tags": [ "ToolboxField" ], "summary": "ToolboxField: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ToolboxField-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ToolboxField_GetPageAsc_C3883CC8E293", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ToolboxField/runtime/{targetPageId}/{recordId}": { "get": { "tags": [ "ToolboxField" ], "summary": "ToolboxField: GetRuntimeFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ToolboxField_GetRuntimeFields_86C95AB92E74", "parameters": [ { "name": "targetPageId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ToolboxFieldRuntimeValue" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ToolboxFieldRuntimeValue" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ToolboxFieldRuntimeValue" } } } } } } }, "/api/ToolboxField/runtime/save": { "post": { "tags": [ "ToolboxField" ], "summary": "ToolboxField: SaveRuntimeFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ToolboxField-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ToolboxField_SaveRuntimeFields_1C8E1ED23D0F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/ToolboxField/SearchByValue": { "post": { "tags": [ "ToolboxField" ], "summary": "ToolboxField: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ToolboxField-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ToolboxField_SearchByValue_6B5010B156DD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ToolboxField" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ToolboxField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ToolboxField" } } } } } } }, "/api/ToolboxField/sources": { "get": { "tags": [ "ToolboxField" ], "summary": "ToolboxField: GetSourceTables", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ToolboxField_GetSourceTables_93C2AA1416C7", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_System.String" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_System.String" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_System.String" } } } } } } }, "/api/ToolboxField/sources/{tableName}/columns": { "get": { "tags": [ "ToolboxField" ], "summary": "ToolboxField: GetSourceColumns", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ToolboxField_GetSourceColumns_F95BACEC38ED", "parameters": [ { "name": "tableName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_System.String" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_System.String" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_System.String" } } } } } } }, "/api/ToolboxField/sources/{tableName}/entries": { "get": { "tags": [ "ToolboxField" ], "summary": "ToolboxField: GetSourceEntries", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ToolboxField_GetSourceEntries_54ABB91CD301", "parameters": [ { "name": "tableName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "idFieldName", "in": "query", "schema": { "type": "string" } }, { "name": "nameFieldName", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ToolboxFieldOptionDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ToolboxFieldOptionDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ToolboxFieldOptionDto" } } } } } } }, "/api/ToolboxField/TryGetByValue": { "post": { "tags": [ "ToolboxField" ], "summary": "ToolboxField: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ToolboxField-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ToolboxField_TryGetByValue_1D9E4335DFF3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ToolboxField" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ToolboxField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ToolboxField" } } } } } } }, "/api/ToolboxField/UpsertGraph": { "put": { "tags": [ "ToolboxField" ], "summary": "ToolboxField: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ToolboxField-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ToolboxField_UpsertGraph_930D64528C9C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxField" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxField" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ToolboxField" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ToolboxField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ToolboxField" } } } } } } }, "/api/ToolboxField/UpsertGraphWithExtraFields": { "put": { "tags": [ "ToolboxField" ], "summary": "ToolboxField: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: ToolboxField-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "ToolboxField_UpsertGraphWithExtraFields_F0CC93770E5D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ToolboxField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ToolboxField" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ToolboxField" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ToolboxField" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ToolboxField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ToolboxField" } } } } } } }, "/api/TranslationArticleInfoText": { "get": { "tags": [ "TranslationArticleInfoText" ], "summary": "TranslationArticleInfoText: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationArticleInfoText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationArticleInfoText_GetAll_5C96FBA3A6C2", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TranslationArticleInfoText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TranslationArticleInfoText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TranslationArticleInfoText" } } } } } }, "post": { "tags": [ "TranslationArticleInfoText" ], "summary": "TranslationArticleInfoText: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationArticleInfoText-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationArticleInfoText_Post_5970ACBFB836", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationArticleInfoText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationArticleInfoText" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationArticleInfoText" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationArticleInfoText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationArticleInfoText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationArticleInfoText" } } } } } }, "put": { "tags": [ "TranslationArticleInfoText" ], "summary": "TranslationArticleInfoText: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationArticleInfoText-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationArticleInfoText_Put_7B4A4BBE18E3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationArticleInfoText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationArticleInfoText" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationArticleInfoText" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationArticleInfoText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationArticleInfoText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationArticleInfoText" } } } } } } }, "/api/TranslationArticleInfoText/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "TranslationArticleInfoText" ], "summary": "TranslationArticleInfoText: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationArticleInfoText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationArticleInfoText_GetPageByValue_7F6BB6183091", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/TranslationArticleInfoText/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "TranslationArticleInfoText" ], "summary": "TranslationArticleInfoText: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationArticleInfoText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationArticleInfoText_GetPageByValue2_2F6212D9F915", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/TranslationArticleInfoText/DeleteByFilter": { "post": { "tags": [ "TranslationArticleInfoText" ], "summary": "TranslationArticleInfoText: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationArticleInfoText-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationArticleInfoText_DeleteByFilter_32596F9648EE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/TranslationArticleInfoText/GetAllByValue": { "post": { "tags": [ "TranslationArticleInfoText" ], "summary": "TranslationArticleInfoText: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationArticleInfoText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationArticleInfoText_GetAllByValue_92D16E4110FE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TranslationArticleInfoText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TranslationArticleInfoText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TranslationArticleInfoText" } } } } } } }, "/api/TranslationArticleInfoText/GetAllGraphByValue": { "post": { "tags": [ "TranslationArticleInfoText" ], "summary": "TranslationArticleInfoText: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationArticleInfoText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationArticleInfoText_GetAllGraphByValue_171365277646", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TranslationArticleInfoText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TranslationArticleInfoText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TranslationArticleInfoText" } } } } } } }, "/api/TranslationArticleInfoText/GetByValue": { "post": { "tags": [ "TranslationArticleInfoText" ], "summary": "TranslationArticleInfoText: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationArticleInfoText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationArticleInfoText_GetByValue_F00F096D8BD9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationArticleInfoText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationArticleInfoText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationArticleInfoText" } } } } } } }, "/api/TranslationArticleInfoText/GetLookup": { "post": { "tags": [ "TranslationArticleInfoText" ], "summary": "TranslationArticleInfoText: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationArticleInfoText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationArticleInfoText_GetLookup_4A5756F5D23D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/TranslationArticleInfoText/GetLookupByValue": { "post": { "tags": [ "TranslationArticleInfoText" ], "summary": "TranslationArticleInfoText: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationArticleInfoText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationArticleInfoText_GetLookupByValue_EE3E6C492446", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/TranslationArticleInfoText/Page": { "get": { "tags": [ "TranslationArticleInfoText" ], "summary": "TranslationArticleInfoText: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationArticleInfoText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationArticleInfoText_GetPage_1CADBA23A56E", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/TranslationArticleInfoText/PageAsc": { "get": { "tags": [ "TranslationArticleInfoText" ], "summary": "TranslationArticleInfoText: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationArticleInfoText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationArticleInfoText_GetPageAsc_A18F0AC8C432", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/TranslationArticleInfoText/SearchByValue": { "post": { "tags": [ "TranslationArticleInfoText" ], "summary": "TranslationArticleInfoText: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationArticleInfoText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationArticleInfoText_SearchByValue_85EC323F865F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.TranslationArticleInfoText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.TranslationArticleInfoText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.TranslationArticleInfoText" } } } } } } }, "/api/TranslationArticleInfoText/TryGetByValue": { "post": { "tags": [ "TranslationArticleInfoText" ], "summary": "TranslationArticleInfoText: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationArticleInfoText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationArticleInfoText_TryGetByValue_AD43473453C0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationArticleInfoText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationArticleInfoText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationArticleInfoText" } } } } } } }, "/api/TranslationArticleInfoText/UpsertGraph": { "put": { "tags": [ "TranslationArticleInfoText" ], "summary": "TranslationArticleInfoText: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationArticleInfoText-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationArticleInfoText_UpsertGraph_262B5E921BB7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationArticleInfoText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationArticleInfoText" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationArticleInfoText" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationArticleInfoText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationArticleInfoText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationArticleInfoText" } } } } } } }, "/api/TranslationArticleInfoText/UpsertGraphWithExtraFields": { "put": { "tags": [ "TranslationArticleInfoText" ], "summary": "TranslationArticleInfoText: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationArticleInfoText-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationArticleInfoText_UpsertGraphWithExtraFields_6150F7328166", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TranslationArticleInfoText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TranslationArticleInfoText" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TranslationArticleInfoText" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TranslationArticleInfoText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TranslationArticleInfoText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TranslationArticleInfoText" } } } } } } }, "/api/TranslationArticleName1": { "get": { "tags": [ "TranslationArticleName1" ], "summary": "TranslationArticleName1: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationArticleName1-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationArticleName1_GetAll_4B82F3E712E6", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TranslationArticleName1" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TranslationArticleName1" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TranslationArticleName1" } } } } } }, "post": { "tags": [ "TranslationArticleName1" ], "summary": "TranslationArticleName1: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationArticleName1-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationArticleName1_Post_674ACABDCFAD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationArticleName1" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationArticleName1" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationArticleName1" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationArticleName1" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationArticleName1" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationArticleName1" } } } } } }, "put": { "tags": [ "TranslationArticleName1" ], "summary": "TranslationArticleName1: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationArticleName1-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationArticleName1_Put_994610BF0549", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationArticleName1" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationArticleName1" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationArticleName1" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationArticleName1" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationArticleName1" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationArticleName1" } } } } } } }, "/api/TranslationArticleName1/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "TranslationArticleName1" ], "summary": "TranslationArticleName1: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationArticleName1-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationArticleName1_GetPageByValue_F24DBED15A64", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/TranslationArticleName1/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "TranslationArticleName1" ], "summary": "TranslationArticleName1: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationArticleName1-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationArticleName1_GetPageByValue2_8B26C25B5BDB", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/TranslationArticleName1/DeleteByFilter": { "post": { "tags": [ "TranslationArticleName1" ], "summary": "TranslationArticleName1: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationArticleName1-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationArticleName1_DeleteByFilter_7C1DE94E7C7E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/TranslationArticleName1/GetAllByValue": { "post": { "tags": [ "TranslationArticleName1" ], "summary": "TranslationArticleName1: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationArticleName1-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationArticleName1_GetAllByValue_FEE88EC6C3A7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TranslationArticleName1" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TranslationArticleName1" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TranslationArticleName1" } } } } } } }, "/api/TranslationArticleName1/GetAllGraphByValue": { "post": { "tags": [ "TranslationArticleName1" ], "summary": "TranslationArticleName1: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationArticleName1-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationArticleName1_GetAllGraphByValue_F0CB1330C618", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TranslationArticleName1" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TranslationArticleName1" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TranslationArticleName1" } } } } } } }, "/api/TranslationArticleName1/GetByValue": { "post": { "tags": [ "TranslationArticleName1" ], "summary": "TranslationArticleName1: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationArticleName1-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationArticleName1_GetByValue_D7CAB176173D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationArticleName1" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationArticleName1" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationArticleName1" } } } } } } }, "/api/TranslationArticleName1/GetLookup": { "post": { "tags": [ "TranslationArticleName1" ], "summary": "TranslationArticleName1: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationArticleName1-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationArticleName1_GetLookup_83336150A4F3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/TranslationArticleName1/GetLookupByValue": { "post": { "tags": [ "TranslationArticleName1" ], "summary": "TranslationArticleName1: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationArticleName1-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationArticleName1_GetLookupByValue_0C8555CE6DDD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/TranslationArticleName1/Page": { "get": { "tags": [ "TranslationArticleName1" ], "summary": "TranslationArticleName1: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationArticleName1-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationArticleName1_GetPage_865F16D85EC2", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/TranslationArticleName1/PageAsc": { "get": { "tags": [ "TranslationArticleName1" ], "summary": "TranslationArticleName1: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationArticleName1-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationArticleName1_GetPageAsc_363F5F4CD585", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/TranslationArticleName1/SearchByValue": { "post": { "tags": [ "TranslationArticleName1" ], "summary": "TranslationArticleName1: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationArticleName1-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationArticleName1_SearchByValue_C36CFDD30D52", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.TranslationArticleName1" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.TranslationArticleName1" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.TranslationArticleName1" } } } } } } }, "/api/TranslationArticleName1/TryGetByValue": { "post": { "tags": [ "TranslationArticleName1" ], "summary": "TranslationArticleName1: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationArticleName1-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationArticleName1_TryGetByValue_854D49568985", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationArticleName1" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationArticleName1" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationArticleName1" } } } } } } }, "/api/TranslationArticleName1/UpsertGraph": { "put": { "tags": [ "TranslationArticleName1" ], "summary": "TranslationArticleName1: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationArticleName1-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationArticleName1_UpsertGraph_B0A4D74F026F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationArticleName1" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationArticleName1" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationArticleName1" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationArticleName1" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationArticleName1" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationArticleName1" } } } } } } }, "/api/TranslationArticleName1/UpsertGraphWithExtraFields": { "put": { "tags": [ "TranslationArticleName1" ], "summary": "TranslationArticleName1: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationArticleName1-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationArticleName1_UpsertGraphWithExtraFields_B76D6B8F53DC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TranslationArticleName1" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TranslationArticleName1" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TranslationArticleName1" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TranslationArticleName1" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TranslationArticleName1" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TranslationArticleName1" } } } } } } }, "/api/TranslationArticleName2": { "get": { "tags": [ "TranslationArticleName2" ], "summary": "TranslationArticleName2: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationArticleName2-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationArticleName2_GetAll_831EE27EF92A", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TranslationArticleName2" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TranslationArticleName2" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TranslationArticleName2" } } } } } }, "post": { "tags": [ "TranslationArticleName2" ], "summary": "TranslationArticleName2: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationArticleName2-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationArticleName2_Post_EF7363E10B86", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationArticleName2" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationArticleName2" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationArticleName2" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationArticleName2" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationArticleName2" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationArticleName2" } } } } } }, "put": { "tags": [ "TranslationArticleName2" ], "summary": "TranslationArticleName2: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationArticleName2-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationArticleName2_Put_66C8C9D303EA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationArticleName2" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationArticleName2" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationArticleName2" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationArticleName2" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationArticleName2" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationArticleName2" } } } } } } }, "/api/TranslationArticleName2/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "TranslationArticleName2" ], "summary": "TranslationArticleName2: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationArticleName2-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationArticleName2_GetPageByValue_8AC7882AB64C", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/TranslationArticleName2/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "TranslationArticleName2" ], "summary": "TranslationArticleName2: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationArticleName2-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationArticleName2_GetPageByValue2_90BE950ADAB8", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/TranslationArticleName2/DeleteByFilter": { "post": { "tags": [ "TranslationArticleName2" ], "summary": "TranslationArticleName2: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationArticleName2-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationArticleName2_DeleteByFilter_5C52900AEB0B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/TranslationArticleName2/GetAllByValue": { "post": { "tags": [ "TranslationArticleName2" ], "summary": "TranslationArticleName2: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationArticleName2-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationArticleName2_GetAllByValue_50FF4E2E0EF7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TranslationArticleName2" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TranslationArticleName2" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TranslationArticleName2" } } } } } } }, "/api/TranslationArticleName2/GetAllGraphByValue": { "post": { "tags": [ "TranslationArticleName2" ], "summary": "TranslationArticleName2: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationArticleName2-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationArticleName2_GetAllGraphByValue_E5EC0D8CD3EF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TranslationArticleName2" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TranslationArticleName2" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TranslationArticleName2" } } } } } } }, "/api/TranslationArticleName2/GetByValue": { "post": { "tags": [ "TranslationArticleName2" ], "summary": "TranslationArticleName2: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationArticleName2-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationArticleName2_GetByValue_220D99B17B7E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationArticleName2" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationArticleName2" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationArticleName2" } } } } } } }, "/api/TranslationArticleName2/GetLookup": { "post": { "tags": [ "TranslationArticleName2" ], "summary": "TranslationArticleName2: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationArticleName2-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationArticleName2_GetLookup_70840D359961", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/TranslationArticleName2/GetLookupByValue": { "post": { "tags": [ "TranslationArticleName2" ], "summary": "TranslationArticleName2: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationArticleName2-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationArticleName2_GetLookupByValue_E4785C2592D6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/TranslationArticleName2/Page": { "get": { "tags": [ "TranslationArticleName2" ], "summary": "TranslationArticleName2: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationArticleName2-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationArticleName2_GetPage_D34336A3DCCD", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/TranslationArticleName2/PageAsc": { "get": { "tags": [ "TranslationArticleName2" ], "summary": "TranslationArticleName2: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationArticleName2-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationArticleName2_GetPageAsc_A4C9564E5BA7", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/TranslationArticleName2/SearchByValue": { "post": { "tags": [ "TranslationArticleName2" ], "summary": "TranslationArticleName2: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationArticleName2-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationArticleName2_SearchByValue_7C7546180B36", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.TranslationArticleName2" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.TranslationArticleName2" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.TranslationArticleName2" } } } } } } }, "/api/TranslationArticleName2/TryGetByValue": { "post": { "tags": [ "TranslationArticleName2" ], "summary": "TranslationArticleName2: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationArticleName2-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationArticleName2_TryGetByValue_324CDE215AA0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationArticleName2" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationArticleName2" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationArticleName2" } } } } } } }, "/api/TranslationArticleName2/UpsertGraph": { "put": { "tags": [ "TranslationArticleName2" ], "summary": "TranslationArticleName2: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationArticleName2-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationArticleName2_UpsertGraph_295D778CD602", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationArticleName2" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationArticleName2" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationArticleName2" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationArticleName2" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationArticleName2" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationArticleName2" } } } } } } }, "/api/TranslationArticleName2/UpsertGraphWithExtraFields": { "put": { "tags": [ "TranslationArticleName2" ], "summary": "TranslationArticleName2: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationArticleName2-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationArticleName2_UpsertGraphWithExtraFields_BC8C4AC0C27C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TranslationArticleName2" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TranslationArticleName2" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TranslationArticleName2" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TranslationArticleName2" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TranslationArticleName2" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TranslationArticleName2" } } } } } } }, "/api/TranslationArticleOrderText": { "get": { "tags": [ "TranslationArticleOrderText" ], "summary": "TranslationArticleOrderText: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationArticleOrderText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationArticleOrderText_GetAll_DD1B8ECD208A", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TranslationArticleOrderText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TranslationArticleOrderText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TranslationArticleOrderText" } } } } } }, "post": { "tags": [ "TranslationArticleOrderText" ], "summary": "TranslationArticleOrderText: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationArticleOrderText-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationArticleOrderText_Post_12E6ABC55980", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationArticleOrderText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationArticleOrderText" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationArticleOrderText" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationArticleOrderText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationArticleOrderText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationArticleOrderText" } } } } } }, "put": { "tags": [ "TranslationArticleOrderText" ], "summary": "TranslationArticleOrderText: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationArticleOrderText-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationArticleOrderText_Put_5A46C809D083", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationArticleOrderText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationArticleOrderText" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationArticleOrderText" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationArticleOrderText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationArticleOrderText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationArticleOrderText" } } } } } } }, "/api/TranslationArticleOrderText/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "TranslationArticleOrderText" ], "summary": "TranslationArticleOrderText: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationArticleOrderText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationArticleOrderText_GetPageByValue_62A7A3A69D39", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/TranslationArticleOrderText/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "TranslationArticleOrderText" ], "summary": "TranslationArticleOrderText: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationArticleOrderText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationArticleOrderText_GetPageByValue2_C29BF302B8D8", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/TranslationArticleOrderText/DeleteByFilter": { "post": { "tags": [ "TranslationArticleOrderText" ], "summary": "TranslationArticleOrderText: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationArticleOrderText-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationArticleOrderText_DeleteByFilter_CC69462A57E3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/TranslationArticleOrderText/GetAllByValue": { "post": { "tags": [ "TranslationArticleOrderText" ], "summary": "TranslationArticleOrderText: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationArticleOrderText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationArticleOrderText_GetAllByValue_1AA8C191C5E0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TranslationArticleOrderText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TranslationArticleOrderText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TranslationArticleOrderText" } } } } } } }, "/api/TranslationArticleOrderText/GetAllGraphByValue": { "post": { "tags": [ "TranslationArticleOrderText" ], "summary": "TranslationArticleOrderText: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationArticleOrderText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationArticleOrderText_GetAllGraphByValue_ABEFD0037364", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TranslationArticleOrderText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TranslationArticleOrderText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TranslationArticleOrderText" } } } } } } }, "/api/TranslationArticleOrderText/GetByValue": { "post": { "tags": [ "TranslationArticleOrderText" ], "summary": "TranslationArticleOrderText: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationArticleOrderText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationArticleOrderText_GetByValue_B38F5B4B84CB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationArticleOrderText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationArticleOrderText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationArticleOrderText" } } } } } } }, "/api/TranslationArticleOrderText/GetLookup": { "post": { "tags": [ "TranslationArticleOrderText" ], "summary": "TranslationArticleOrderText: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationArticleOrderText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationArticleOrderText_GetLookup_68A4E007C395", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/TranslationArticleOrderText/GetLookupByValue": { "post": { "tags": [ "TranslationArticleOrderText" ], "summary": "TranslationArticleOrderText: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationArticleOrderText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationArticleOrderText_GetLookupByValue_6840413E4A0E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/TranslationArticleOrderText/Page": { "get": { "tags": [ "TranslationArticleOrderText" ], "summary": "TranslationArticleOrderText: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationArticleOrderText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationArticleOrderText_GetPage_F21009C8C232", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/TranslationArticleOrderText/PageAsc": { "get": { "tags": [ "TranslationArticleOrderText" ], "summary": "TranslationArticleOrderText: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationArticleOrderText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationArticleOrderText_GetPageAsc_9E68BA5814F0", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/TranslationArticleOrderText/SearchByValue": { "post": { "tags": [ "TranslationArticleOrderText" ], "summary": "TranslationArticleOrderText: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationArticleOrderText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationArticleOrderText_SearchByValue_105A07352707", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.TranslationArticleOrderText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.TranslationArticleOrderText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.TranslationArticleOrderText" } } } } } } }, "/api/TranslationArticleOrderText/TryGetByValue": { "post": { "tags": [ "TranslationArticleOrderText" ], "summary": "TranslationArticleOrderText: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationArticleOrderText-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationArticleOrderText_TryGetByValue_DC76DD5C6BC7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationArticleOrderText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationArticleOrderText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationArticleOrderText" } } } } } } }, "/api/TranslationArticleOrderText/UpsertGraph": { "put": { "tags": [ "TranslationArticleOrderText" ], "summary": "TranslationArticleOrderText: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationArticleOrderText-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationArticleOrderText_UpsertGraph_C3F38ACC2C8C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationArticleOrderText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationArticleOrderText" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationArticleOrderText" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationArticleOrderText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationArticleOrderText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationArticleOrderText" } } } } } } }, "/api/TranslationArticleOrderText/UpsertGraphWithExtraFields": { "put": { "tags": [ "TranslationArticleOrderText" ], "summary": "TranslationArticleOrderText: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationArticleOrderText-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationArticleOrderText_UpsertGraphWithExtraFields_BC87C78EE35E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TranslationArticleOrderText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TranslationArticleOrderText" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TranslationArticleOrderText" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TranslationArticleOrderText" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TranslationArticleOrderText" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TranslationArticleOrderText" } } } } } } }, "/api/TranslationArticleUoM": { "get": { "tags": [ "TranslationArticleUoM" ], "summary": "TranslationArticleUoM: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationArticleUoM-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationArticleUoM_GetAll_077DB79A74F5", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TranslationArticleUoM" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TranslationArticleUoM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TranslationArticleUoM" } } } } } }, "post": { "tags": [ "TranslationArticleUoM" ], "summary": "TranslationArticleUoM: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationArticleUoM-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationArticleUoM_Post_01B726CA7A12", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationArticleUoM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationArticleUoM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationArticleUoM" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationArticleUoM" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationArticleUoM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationArticleUoM" } } } } } }, "put": { "tags": [ "TranslationArticleUoM" ], "summary": "TranslationArticleUoM: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationArticleUoM-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationArticleUoM_Put_3BC11BF57693", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationArticleUoM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationArticleUoM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationArticleUoM" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationArticleUoM" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationArticleUoM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationArticleUoM" } } } } } } }, "/api/TranslationArticleUoM/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "TranslationArticleUoM" ], "summary": "TranslationArticleUoM: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationArticleUoM-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationArticleUoM_GetPageByValue_9DECD360A5E1", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/TranslationArticleUoM/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "TranslationArticleUoM" ], "summary": "TranslationArticleUoM: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationArticleUoM-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationArticleUoM_GetPageByValue2_566F923BDB3D", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/TranslationArticleUoM/DeleteByFilter": { "post": { "tags": [ "TranslationArticleUoM" ], "summary": "TranslationArticleUoM: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationArticleUoM-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationArticleUoM_DeleteByFilter_E7EB938CC8F8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/TranslationArticleUoM/GetAllByValue": { "post": { "tags": [ "TranslationArticleUoM" ], "summary": "TranslationArticleUoM: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationArticleUoM-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationArticleUoM_GetAllByValue_9D10CD0ABC1A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TranslationArticleUoM" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TranslationArticleUoM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TranslationArticleUoM" } } } } } } }, "/api/TranslationArticleUoM/GetAllGraphByValue": { "post": { "tags": [ "TranslationArticleUoM" ], "summary": "TranslationArticleUoM: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationArticleUoM-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationArticleUoM_GetAllGraphByValue_FFF529F4FB40", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TranslationArticleUoM" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TranslationArticleUoM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TranslationArticleUoM" } } } } } } }, "/api/TranslationArticleUoM/GetByValue": { "post": { "tags": [ "TranslationArticleUoM" ], "summary": "TranslationArticleUoM: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationArticleUoM-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationArticleUoM_GetByValue_CBA31C246EFD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationArticleUoM" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationArticleUoM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationArticleUoM" } } } } } } }, "/api/TranslationArticleUoM/GetLookup": { "post": { "tags": [ "TranslationArticleUoM" ], "summary": "TranslationArticleUoM: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationArticleUoM-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationArticleUoM_GetLookup_3C8615819C42", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/TranslationArticleUoM/GetLookupByValue": { "post": { "tags": [ "TranslationArticleUoM" ], "summary": "TranslationArticleUoM: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationArticleUoM-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationArticleUoM_GetLookupByValue_041366A2A521", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/TranslationArticleUoM/Page": { "get": { "tags": [ "TranslationArticleUoM" ], "summary": "TranslationArticleUoM: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationArticleUoM-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationArticleUoM_GetPage_0E2BE1D644D2", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/TranslationArticleUoM/PageAsc": { "get": { "tags": [ "TranslationArticleUoM" ], "summary": "TranslationArticleUoM: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationArticleUoM-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationArticleUoM_GetPageAsc_D432634CF1F9", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/TranslationArticleUoM/SearchByValue": { "post": { "tags": [ "TranslationArticleUoM" ], "summary": "TranslationArticleUoM: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationArticleUoM-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationArticleUoM_SearchByValue_FC740275F168", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.TranslationArticleUoM" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.TranslationArticleUoM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.TranslationArticleUoM" } } } } } } }, "/api/TranslationArticleUoM/TryGetByValue": { "post": { "tags": [ "TranslationArticleUoM" ], "summary": "TranslationArticleUoM: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationArticleUoM-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationArticleUoM_TryGetByValue_7712640F0CF8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationArticleUoM" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationArticleUoM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationArticleUoM" } } } } } } }, "/api/TranslationArticleUoM/UpsertGraph": { "put": { "tags": [ "TranslationArticleUoM" ], "summary": "TranslationArticleUoM: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationArticleUoM-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationArticleUoM_UpsertGraph_8387FD0B7CB2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationArticleUoM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationArticleUoM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationArticleUoM" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationArticleUoM" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationArticleUoM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationArticleUoM" } } } } } } }, "/api/TranslationArticleUoM/UpsertGraphWithExtraFields": { "put": { "tags": [ "TranslationArticleUoM" ], "summary": "TranslationArticleUoM: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationArticleUoM-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationArticleUoM_UpsertGraphWithExtraFields_A0051A422721", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TranslationArticleUoM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TranslationArticleUoM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TranslationArticleUoM" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TranslationArticleUoM" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TranslationArticleUoM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TranslationArticleUoM" } } } } } } }, "/api/TranslationDocType": { "get": { "tags": [ "TranslationDocType" ], "summary": "TranslationDocType: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationDocType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationDocType_GetAll_67E9821E2E18", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TranslationDocType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TranslationDocType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TranslationDocType" } } } } } }, "post": { "tags": [ "TranslationDocType" ], "summary": "TranslationDocType: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationDocType-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationDocType_Post_03B6B2FFF0CE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationDocType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationDocType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationDocType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationDocType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationDocType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationDocType" } } } } } }, "put": { "tags": [ "TranslationDocType" ], "summary": "TranslationDocType: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationDocType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationDocType_Put_EF4F76631C62", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationDocType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationDocType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationDocType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationDocType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationDocType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationDocType" } } } } } } }, "/api/TranslationDocType/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "TranslationDocType" ], "summary": "TranslationDocType: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationDocType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationDocType_GetPageByValue_CBF521EF87BB", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/TranslationDocType/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "TranslationDocType" ], "summary": "TranslationDocType: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationDocType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationDocType_GetPageByValue2_2630484859DB", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/TranslationDocType/DeleteByFilter": { "post": { "tags": [ "TranslationDocType" ], "summary": "TranslationDocType: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationDocType-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationDocType_DeleteByFilter_12BEC9E50EA7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/TranslationDocType/GetAllByValue": { "post": { "tags": [ "TranslationDocType" ], "summary": "TranslationDocType: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationDocType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationDocType_GetAllByValue_E96D2577D919", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TranslationDocType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TranslationDocType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TranslationDocType" } } } } } } }, "/api/TranslationDocType/GetAllGraphByValue": { "post": { "tags": [ "TranslationDocType" ], "summary": "TranslationDocType: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationDocType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationDocType_GetAllGraphByValue_6B5A9F844BAD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TranslationDocType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TranslationDocType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TranslationDocType" } } } } } } }, "/api/TranslationDocType/GetByValue": { "post": { "tags": [ "TranslationDocType" ], "summary": "TranslationDocType: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationDocType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationDocType_GetByValue_EF56188EAE80", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationDocType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationDocType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationDocType" } } } } } } }, "/api/TranslationDocType/GetLookup": { "post": { "tags": [ "TranslationDocType" ], "summary": "TranslationDocType: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationDocType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationDocType_GetLookup_7B06CE54737F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/TranslationDocType/GetLookupByValue": { "post": { "tags": [ "TranslationDocType" ], "summary": "TranslationDocType: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationDocType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationDocType_GetLookupByValue_EBB31BF5239E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/TranslationDocType/Page": { "get": { "tags": [ "TranslationDocType" ], "summary": "TranslationDocType: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationDocType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationDocType_GetPage_1EF722490D71", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/TranslationDocType/PageAsc": { "get": { "tags": [ "TranslationDocType" ], "summary": "TranslationDocType: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationDocType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationDocType_GetPageAsc_53B1B129149C", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/TranslationDocType/SearchByValue": { "post": { "tags": [ "TranslationDocType" ], "summary": "TranslationDocType: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationDocType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationDocType_SearchByValue_39AADC8BA099", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.TranslationDocType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.TranslationDocType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.TranslationDocType" } } } } } } }, "/api/TranslationDocType/TryGetByValue": { "post": { "tags": [ "TranslationDocType" ], "summary": "TranslationDocType: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationDocType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationDocType_TryGetByValue_55B113BA97BF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationDocType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationDocType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationDocType" } } } } } } }, "/api/TranslationDocType/UpsertGraph": { "put": { "tags": [ "TranslationDocType" ], "summary": "TranslationDocType: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationDocType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationDocType_UpsertGraph_F07E3A251BFC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationDocType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationDocType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationDocType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationDocType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationDocType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationDocType" } } } } } } }, "/api/TranslationDocType/UpsertGraphWithExtraFields": { "put": { "tags": [ "TranslationDocType" ], "summary": "TranslationDocType: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: TranslationDocType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "TranslationDocType_UpsertGraphWithExtraFields_C6DBB98112C6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TranslationDocType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TranslationDocType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TranslationDocType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TranslationDocType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TranslationDocType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TranslationDocType" } } } } } } }, "/api/Warehouse": { "get": { "tags": [ "Warehouse" ], "summary": "Warehouse: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Warehouse-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Warehouse_GetAll_F6C4CCE3CC5B", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Warehouse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Warehouse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Warehouse" } } } } } }, "post": { "tags": [ "Warehouse" ], "summary": "Warehouse: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Warehouse-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Warehouse_Post_BEEA2D3D3280", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Warehouse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Warehouse" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Warehouse" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Warehouse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Warehouse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Warehouse" } } } } } }, "put": { "tags": [ "Warehouse" ], "summary": "Warehouse: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Warehouse-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Warehouse_Put_83AF04FD64AF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Warehouse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Warehouse" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Warehouse" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Warehouse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Warehouse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Warehouse" } } } } } } }, "/api/Warehouse/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "Warehouse" ], "summary": "Warehouse: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Warehouse-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Warehouse_GetPageByValue_B285CE72F676", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Warehouse/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "Warehouse" ], "summary": "Warehouse: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Warehouse-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Warehouse_GetPageByValue2_59C7FFF1A3A8", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Warehouse/DeleteByFilter": { "post": { "tags": [ "Warehouse" ], "summary": "Warehouse: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Warehouse-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Warehouse_DeleteByFilter_E1121A8B4ACC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/Warehouse/GetAllByValue": { "post": { "tags": [ "Warehouse" ], "summary": "Warehouse: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Warehouse-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Warehouse_GetAllByValue_3A772356A625", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Warehouse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Warehouse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Warehouse" } } } } } } }, "/api/Warehouse/GetAllGraphByValue": { "post": { "tags": [ "Warehouse" ], "summary": "Warehouse: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Warehouse-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Warehouse_GetAllGraphByValue_B1124A57F166", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Warehouse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Warehouse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Warehouse" } } } } } } }, "/api/Warehouse/GetByValue": { "post": { "tags": [ "Warehouse" ], "summary": "Warehouse: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Warehouse-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Warehouse_GetByValue_B6B7D2BBF364", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Warehouse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Warehouse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Warehouse" } } } } } } }, "/api/Warehouse/GetLookup": { "post": { "tags": [ "Warehouse" ], "summary": "Warehouse: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Warehouse-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Warehouse_GetLookup_58C6A52D45BC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/Warehouse/GetLookupByValue": { "post": { "tags": [ "Warehouse" ], "summary": "Warehouse: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Warehouse-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Warehouse_GetLookupByValue_FFE3734329B2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/Warehouse/Page": { "get": { "tags": [ "Warehouse" ], "summary": "Warehouse: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Warehouse-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Warehouse_GetPage_3858DAF4D2B2", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Warehouse/PageAsc": { "get": { "tags": [ "Warehouse" ], "summary": "Warehouse: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Warehouse-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Warehouse_GetPageAsc_F6E1BF55817E", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Warehouse/SearchByValue": { "post": { "tags": [ "Warehouse" ], "summary": "Warehouse: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Warehouse-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Warehouse_SearchByValue_54BA6E68526A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.Warehouse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.Warehouse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.Warehouse" } } } } } } }, "/api/Warehouse/TryGetByValue": { "post": { "tags": [ "Warehouse" ], "summary": "Warehouse: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Warehouse-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Warehouse_TryGetByValue_492028061D43", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Warehouse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Warehouse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Warehouse" } } } } } } }, "/api/Warehouse/UpsertGraph": { "put": { "tags": [ "Warehouse" ], "summary": "Warehouse: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Warehouse-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Warehouse_UpsertGraph_31FBF2E3EE88", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Warehouse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Warehouse" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Warehouse" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Warehouse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Warehouse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Warehouse" } } } } } } }, "/api/Warehouse/UpsertGraphWithExtraFields": { "put": { "tags": [ "Warehouse" ], "summary": "Warehouse: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Warehouse-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Warehouse_UpsertGraphWithExtraFields_71FD4E05ABC9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Warehouse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Warehouse" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Warehouse" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Warehouse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Warehouse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Warehouse" } } } } } } }, "/api/WarehouseBinLocation": { "get": { "tags": [ "WarehouseBinLocation" ], "summary": "WarehouseBinLocation: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseBinLocation-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseBinLocation_GetAll_183514F8BC1E", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseBinLocation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseBinLocation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseBinLocation" } } } } } }, "post": { "tags": [ "WarehouseBinLocation" ], "summary": "WarehouseBinLocation: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseBinLocation-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseBinLocation_Post_032DFFF9EDF1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseBinLocation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseBinLocation" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseBinLocation" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseBinLocation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseBinLocation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseBinLocation" } } } } } }, "put": { "tags": [ "WarehouseBinLocation" ], "summary": "WarehouseBinLocation: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseBinLocation-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseBinLocation_Put_9DA04C4B56B6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseBinLocation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseBinLocation" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseBinLocation" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseBinLocation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseBinLocation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseBinLocation" } } } } } } }, "/api/WarehouseBinLocation/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "WarehouseBinLocation" ], "summary": "WarehouseBinLocation: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseBinLocation-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseBinLocation_GetPageByValue_3A9F1F8E2E3C", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WarehouseBinLocation/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "WarehouseBinLocation" ], "summary": "WarehouseBinLocation: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseBinLocation-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseBinLocation_GetPageByValue2_63051B48D902", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WarehouseBinLocation/{WarehouseId}/GetWarehouseBinLocationHierarchy": { "get": { "tags": [ "WarehouseBinLocation" ], "summary": "WarehouseBinLocation: GetWarehouseBinLocationHierarchy", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseBinLocation-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseBinLocation_GetWarehouseBinLocationHierarchy_717F4767A986", "parameters": [ { "name": "WarehouseId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW192_WarehouseWarehouseBinLocationHierarchy" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW192_WarehouseWarehouseBinLocationHierarchy" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW192_WarehouseWarehouseBinLocationHierarchy" } } } } } } }, "/api/WarehouseBinLocation/DeleteByFilter": { "post": { "tags": [ "WarehouseBinLocation" ], "summary": "WarehouseBinLocation: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseBinLocation-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseBinLocation_DeleteByFilter_6F6C51A3275F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/WarehouseBinLocation/GetAllByValue": { "post": { "tags": [ "WarehouseBinLocation" ], "summary": "WarehouseBinLocation: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseBinLocation-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseBinLocation_GetAllByValue_C3BF305DCFA4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseBinLocation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseBinLocation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseBinLocation" } } } } } } }, "/api/WarehouseBinLocation/GetAllGraphByValue": { "post": { "tags": [ "WarehouseBinLocation" ], "summary": "WarehouseBinLocation: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseBinLocation-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseBinLocation_GetAllGraphByValue_6D2F7604A969", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseBinLocation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseBinLocation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseBinLocation" } } } } } } }, "/api/WarehouseBinLocation/GetByValue": { "post": { "tags": [ "WarehouseBinLocation" ], "summary": "WarehouseBinLocation: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseBinLocation-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseBinLocation_GetByValue_1E5DDF1A5CB5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseBinLocation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseBinLocation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseBinLocation" } } } } } } }, "/api/WarehouseBinLocation/GetChildWarehouseBinLocations/{ParentId}/{WarehouseId}": { "get": { "tags": [ "WarehouseBinLocation" ], "summary": "WarehouseBinLocation: GetChildWarehouseBinLocations", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseBinLocation-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseBinLocation_GetChildWarehouseBinLocations_4F9BB4B604E4", "parameters": [ { "name": "ParentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "WarehouseId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW192_WarehouseWarehouseBinLocationHierarchy" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW192_WarehouseWarehouseBinLocationHierarchy" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW192_WarehouseWarehouseBinLocationHierarchy" } } } } } } }, "/api/WarehouseBinLocation/GetLookup": { "post": { "tags": [ "WarehouseBinLocation" ], "summary": "WarehouseBinLocation: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseBinLocation-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseBinLocation_GetLookup_057942E32653", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/WarehouseBinLocation/GetLookupByValue": { "post": { "tags": [ "WarehouseBinLocation" ], "summary": "WarehouseBinLocation: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseBinLocation-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseBinLocation_GetLookupByValue_F1D3627879A9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/WarehouseBinLocation/GetRootWarehouseBinLocations/{WarehouseId}": { "get": { "tags": [ "WarehouseBinLocation" ], "summary": "WarehouseBinLocation: GetRootWarehouseBinLocations", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseBinLocation-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseBinLocation_GetRootWarehouseBinLocations_186E7BAFCEF4", "parameters": [ { "name": "WarehouseId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW192_WarehouseWarehouseBinLocationHierarchy" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW192_WarehouseWarehouseBinLocationHierarchy" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW192_WarehouseWarehouseBinLocationHierarchy" } } } } } } }, "/api/WarehouseBinLocation/Page": { "get": { "tags": [ "WarehouseBinLocation" ], "summary": "WarehouseBinLocation: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseBinLocation-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseBinLocation_GetPage_42156BCAB8A3", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WarehouseBinLocation/PageAsc": { "get": { "tags": [ "WarehouseBinLocation" ], "summary": "WarehouseBinLocation: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseBinLocation-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseBinLocation_GetPageAsc_F00E7D62D2B9", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WarehouseBinLocation/PageList": { "get": { "tags": [ "WarehouseBinLocation" ], "summary": "WarehouseBinLocation: GetPageList", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseBinLocation-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseBinLocation_GetPageList_2CD0A99E77E6", "parameters": [ { "name": "filterWarehouseId", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WarehouseBinLocation/PageListByArticle/{articleId}/{filterWarehouseId}": { "get": { "tags": [ "WarehouseBinLocation" ], "summary": "WarehouseBinLocation: GetPageListByArticle", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseBinLocation-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseBinLocation_GetPageListByArticle_D562AFD4E49B", "parameters": [ { "name": "articleId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "filterWarehouseId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WarehouseBinLocation/PageListByIndividualization/{individualizationId}/{filterWarehouseId}": { "get": { "tags": [ "WarehouseBinLocation" ], "summary": "WarehouseBinLocation: GetPageListByIndividualization", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseBinLocation-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseBinLocation_GetPageListByIndividualization_147CD67089B6", "parameters": [ { "name": "individualizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "filterWarehouseId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WarehouseBinLocation/PageWarehouseBinLocationsByParent/{ParentId}/{IncludeSubNodes}": { "get": { "tags": [ "WarehouseBinLocation" ], "summary": "WarehouseBinLocation: GetPageWarehouseBinLocationsByParent", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseBinLocation-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseBinLocation_GetPageWarehouseBinLocationsByParent_05AF899CFCDC", "parameters": [ { "name": "ParentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "IncludeSubNodes", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WarehouseBinLocation/PageWarehouseBinLocationsByParentByWarehouse/{ParentId}/{IncludeSubNodes}/{TopParentsOnly}/{FilterWarehouseId}": { "get": { "tags": [ "WarehouseBinLocation" ], "summary": "WarehouseBinLocation: GetPageWarehouseBinLocationsByParentByWarehouse", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseBinLocation-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseBinLocation_GetPageWarehouseBinLocationsByParentByWarehouse_E28D523F3729", "parameters": [ { "name": "ParentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "IncludeSubNodes", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "TopParentsOnly", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "FilterWarehouseId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WarehouseBinLocation/RunWizard": { "post": { "tags": [ "WarehouseBinLocation" ], "summary": "WarehouseBinLocation: RunWizard", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseBinLocation-Create.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseBinLocation_RunWizard_91A2D7C8A902", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseBinLocation_RunWizardRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseBinLocation_RunWizardRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseBinLocation_RunWizardRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/WarehouseBinLocation/SearchByValue": { "post": { "tags": [ "WarehouseBinLocation" ], "summary": "WarehouseBinLocation: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseBinLocation-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseBinLocation_SearchByValue_C833F40A004D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WarehouseBinLocation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WarehouseBinLocation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WarehouseBinLocation" } } } } } } }, "/api/WarehouseBinLocation/TryGetByValue": { "post": { "tags": [ "WarehouseBinLocation" ], "summary": "WarehouseBinLocation: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseBinLocation-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseBinLocation_TryGetByValue_0F023758A6C6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseBinLocation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseBinLocation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseBinLocation" } } } } } } }, "/api/WarehouseBinLocation/UpsertGraph": { "put": { "tags": [ "WarehouseBinLocation" ], "summary": "WarehouseBinLocation: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseBinLocation-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseBinLocation_UpsertGraph_4C9FD20026E7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseBinLocation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseBinLocation" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseBinLocation" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseBinLocation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseBinLocation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseBinLocation" } } } } } } }, "/api/WarehouseBinLocation/UpsertGraphWithExtraFields": { "put": { "tags": [ "WarehouseBinLocation" ], "summary": "WarehouseBinLocation: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseBinLocation-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseBinLocation_UpsertGraphWithExtraFields_44E146636AD4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseBinLocation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseBinLocation" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseBinLocation" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseBinLocation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseBinLocation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseBinLocation" } } } } } } }, "/api/WarehouseInfo": { "get": { "tags": [ "WarehouseInfo" ], "summary": "WarehouseInfo: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInfo-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInfo_GetAll_FB485A3557A2", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseInfo" } } } } } }, "post": { "tags": [ "WarehouseInfo" ], "summary": "WarehouseInfo: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInfo-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInfo_Post_EB253B8371E9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInfo" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInfo" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInfo" } } } } } }, "put": { "tags": [ "WarehouseInfo" ], "summary": "WarehouseInfo: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInfo-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInfo_Put_BD12630F862E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInfo" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInfo" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInfo" } } } } } } }, "/api/WarehouseInfo/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "WarehouseInfo" ], "summary": "WarehouseInfo: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInfo-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInfo_GetPageByValue_152DD3B8E9C6", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WarehouseInfo/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "WarehouseInfo" ], "summary": "WarehouseInfo: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInfo-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInfo_GetPageByValue2_D401ACE398CF", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WarehouseInfo/DeleteByFilter": { "post": { "tags": [ "WarehouseInfo" ], "summary": "WarehouseInfo: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInfo-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInfo_DeleteByFilter_D203A6643E6C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/WarehouseInfo/GetAllByValue": { "post": { "tags": [ "WarehouseInfo" ], "summary": "WarehouseInfo: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInfo-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInfo_GetAllByValue_B9DA5D9881BB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseInfo" } } } } } } }, "/api/WarehouseInfo/GetAllGraphByValue": { "post": { "tags": [ "WarehouseInfo" ], "summary": "WarehouseInfo: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInfo-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInfo_GetAllGraphByValue_38C0323BEC04", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseInfo" } } } } } } }, "/api/WarehouseInfo/GetAllSortedByHierarchy": { "get": { "tags": [ "WarehouseInfo" ], "summary": "WarehouseInfo: GetAllSortedByHierarchy", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInfo-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInfo_GetAllSortedByHierarchy_C79604FB62F8", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseInfo" } } } } } } }, "/api/WarehouseInfo/GetByValue": { "post": { "tags": [ "WarehouseInfo" ], "summary": "WarehouseInfo: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInfo-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInfo_GetByValue_70D1F78EEDA4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInfo" } } } } } } }, "/api/WarehouseInfo/GetChildWarehouseInfos/{ParentId}": { "get": { "tags": [ "WarehouseInfo" ], "summary": "WarehouseInfo: GetChildWarehouseInfos", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInfo-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInfo_GetChildWarehouseInfos_E4E8120FAB76", "parameters": [ { "name": "ParentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseInfo" } } } } } } }, "/api/WarehouseInfo/GetLookup": { "post": { "tags": [ "WarehouseInfo" ], "summary": "WarehouseInfo: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInfo-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInfo_GetLookup_0562EBAE44B9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/WarehouseInfo/GetLookupByValue": { "post": { "tags": [ "WarehouseInfo" ], "summary": "WarehouseInfo: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInfo-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInfo_GetLookupByValue_314FF9F9EF65", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/WarehouseInfo/GetRootWarehouseInfos": { "get": { "tags": [ "WarehouseInfo" ], "summary": "WarehouseInfo: GetRootWarehouseInfos", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInfo-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInfo_GetRootWarehouseInfos_294E87BDEA50", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseInfo" } } } } } } }, "/api/WarehouseInfo/Page": { "get": { "tags": [ "WarehouseInfo" ], "summary": "WarehouseInfo: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInfo-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInfo_GetPage_59689F40CEBA", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WarehouseInfo/PageAsc": { "get": { "tags": [ "WarehouseInfo" ], "summary": "WarehouseInfo: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInfo-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInfo_GetPageAsc_4F8C30361946", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WarehouseInfo/PageWarehouseInfosByParent/{ParentId}/{IncludeSubNodes}/{TopParentsOnly}": { "get": { "tags": [ "WarehouseInfo" ], "summary": "WarehouseInfo: GetPageWarehouseInfosByParent", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInfo-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInfo_GetPageWarehouseInfosByParent_FEEE8BDB93D4", "parameters": [ { "name": "ParentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "IncludeSubNodes", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "TopParentsOnly", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WarehouseInfo/SearchByValue": { "post": { "tags": [ "WarehouseInfo" ], "summary": "WarehouseInfo: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInfo-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInfo_SearchByValue_744D783466D7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WarehouseInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WarehouseInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WarehouseInfo" } } } } } } }, "/api/WarehouseInfo/TryGetByValue": { "post": { "tags": [ "WarehouseInfo" ], "summary": "WarehouseInfo: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInfo-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInfo_TryGetByValue_AABE09E5F007", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInfo" } } } } } } }, "/api/WarehouseInfo/UpsertGraph": { "put": { "tags": [ "WarehouseInfo" ], "summary": "WarehouseInfo: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInfo-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInfo_UpsertGraph_B570FA6E7705", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInfo" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInfo" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInfo" } } } } } } }, "/api/WarehouseInfo/UpsertGraphWithExtraFields": { "put": { "tags": [ "WarehouseInfo" ], "summary": "WarehouseInfo: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInfo-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInfo_UpsertGraphWithExtraFields_7D54A2F62AEF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseInfo" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseInfo" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseInfo" } } } } } } }, "/api/WarehouseInventoryCounting": { "get": { "tags": [ "WarehouseInventoryCounting" ], "summary": "WarehouseInventoryCounting: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInventoryCounting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInventoryCounting_GetAll_7254CEFB0319", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseInventoryCounting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseInventoryCounting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseInventoryCounting" } } } } } }, "post": { "tags": [ "WarehouseInventoryCounting" ], "summary": "WarehouseInventoryCounting: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInventoryCounting-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInventoryCounting_Post_99CB3826C10A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryCounting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryCounting" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryCounting" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInventoryCounting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInventoryCounting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInventoryCounting" } } } } } }, "put": { "tags": [ "WarehouseInventoryCounting" ], "summary": "WarehouseInventoryCounting: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInventoryCounting-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInventoryCounting_Put_6CBB7427B010", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryCounting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryCounting" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryCounting" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInventoryCounting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInventoryCounting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInventoryCounting" } } } } } } }, "/api/WarehouseInventoryCounting/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "WarehouseInventoryCounting" ], "summary": "WarehouseInventoryCounting: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInventoryCounting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInventoryCounting_GetPageByValue_077D234D43F8", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WarehouseInventoryCounting/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "WarehouseInventoryCounting" ], "summary": "WarehouseInventoryCounting: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInventoryCounting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInventoryCounting_GetPageByValue2_784E19F9753C", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WarehouseInventoryCounting/CopyCalculatedToCounted": { "post": { "tags": [ "WarehouseInventoryCounting" ], "summary": "WarehouseInventoryCounting: CopyCalculatedToCounted", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInventoryCounting-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInventoryCounting_CopyCalculatedToCounted_D644F70D3679", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryCounting_IdRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryCounting_IdRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryCounting_IdRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/WarehouseInventoryCounting/CreateNewWarehouseInventoryCounting": { "post": { "tags": [ "WarehouseInventoryCounting" ], "summary": "WarehouseInventoryCounting: CreateNewWarehouseInventoryCounting", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInventoryCounting-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInventoryCounting_CreateNewWarehouseInventoryCounting_2BD609ACA933", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryCounting_CreateNewRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryCounting_CreateNewRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryCounting_CreateNewRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInventoryCounting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInventoryCounting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInventoryCounting" } } } } } } }, "/api/WarehouseInventoryCounting/DeleteByFilter": { "post": { "tags": [ "WarehouseInventoryCounting" ], "summary": "WarehouseInventoryCounting: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInventoryCounting-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInventoryCounting_DeleteByFilter_3C9DB9EFFB12", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/WarehouseInventoryCounting/DeleteWarehouseInventoryCounting": { "post": { "tags": [ "WarehouseInventoryCounting" ], "summary": "WarehouseInventoryCounting: DeleteWarehouseInventoryCounting", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInventoryCounting-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInventoryCounting_DeleteWarehouseInventoryCounting_EF23569FE823", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryCounting_IdRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryCounting_IdRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryCounting_IdRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/WarehouseInventoryCounting/GetAllByValue": { "post": { "tags": [ "WarehouseInventoryCounting" ], "summary": "WarehouseInventoryCounting: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInventoryCounting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInventoryCounting_GetAllByValue_F494D5958B8C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseInventoryCounting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseInventoryCounting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseInventoryCounting" } } } } } } }, "/api/WarehouseInventoryCounting/GetAllGraphByValue": { "post": { "tags": [ "WarehouseInventoryCounting" ], "summary": "WarehouseInventoryCounting: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInventoryCounting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInventoryCounting_GetAllGraphByValue_05092A533C65", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseInventoryCounting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseInventoryCounting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseInventoryCounting" } } } } } } }, "/api/WarehouseInventoryCounting/GetByValue": { "post": { "tags": [ "WarehouseInventoryCounting" ], "summary": "WarehouseInventoryCounting: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInventoryCounting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInventoryCounting_GetByValue_F1F23F8A8506", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInventoryCounting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInventoryCounting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInventoryCounting" } } } } } } }, "/api/WarehouseInventoryCounting/GetLookup": { "post": { "tags": [ "WarehouseInventoryCounting" ], "summary": "WarehouseInventoryCounting: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInventoryCounting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInventoryCounting_GetLookup_C67712EEF8FB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/WarehouseInventoryCounting/GetLookupByValue": { "post": { "tags": [ "WarehouseInventoryCounting" ], "summary": "WarehouseInventoryCounting: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInventoryCounting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInventoryCounting_GetLookupByValue_4D08F86BA70C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/WarehouseInventoryCounting/Page": { "get": { "tags": [ "WarehouseInventoryCounting" ], "summary": "WarehouseInventoryCounting: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInventoryCounting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInventoryCounting_GetPage_0B6FBEC9226E", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WarehouseInventoryCounting/PageAsc": { "get": { "tags": [ "WarehouseInventoryCounting" ], "summary": "WarehouseInventoryCounting: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInventoryCounting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInventoryCounting_GetPageAsc_8ED8863F4590", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WarehouseInventoryCounting/SearchByValue": { "post": { "tags": [ "WarehouseInventoryCounting" ], "summary": "WarehouseInventoryCounting: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInventoryCounting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInventoryCounting_SearchByValue_4A208F6CF707", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WarehouseInventoryCounting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WarehouseInventoryCounting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WarehouseInventoryCounting" } } } } } } }, "/api/WarehouseInventoryCounting/TryGetByValue": { "post": { "tags": [ "WarehouseInventoryCounting" ], "summary": "WarehouseInventoryCounting: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInventoryCounting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInventoryCounting_TryGetByValue_903DE77FA57D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInventoryCounting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInventoryCounting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInventoryCounting" } } } } } } }, "/api/WarehouseInventoryCounting/UpdateInfo": { "post": { "tags": [ "WarehouseInventoryCounting" ], "summary": "WarehouseInventoryCounting: UpdateInfo", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInventoryCounting-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInventoryCounting_UpdateInfo_1F4BED0F0E5C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryCounting_UpdateInfoRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryCounting_UpdateInfoRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryCounting_UpdateInfoRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/WarehouseInventoryCounting/UpsertGraph": { "put": { "tags": [ "WarehouseInventoryCounting" ], "summary": "WarehouseInventoryCounting: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInventoryCounting-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInventoryCounting_UpsertGraph_D65C6A4C65C0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryCounting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryCounting" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryCounting" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInventoryCounting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInventoryCounting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInventoryCounting" } } } } } } }, "/api/WarehouseInventoryCounting/UpsertGraphWithExtraFields": { "put": { "tags": [ "WarehouseInventoryCounting" ], "summary": "WarehouseInventoryCounting: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInventoryCounting-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInventoryCounting_UpsertGraphWithExtraFields_561F9835FB6A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseInventoryCounting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseInventoryCounting" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseInventoryCounting" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseInventoryCounting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseInventoryCounting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseInventoryCounting" } } } } } } }, "/api/WarehouseInventoryCountingPosition": { "get": { "tags": [ "WarehouseInventoryCountingPosition" ], "summary": "WarehouseInventoryCountingPosition: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInventoryCountingPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInventoryCountingPosition_GetAll_020144D0830C", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseInventoryCountingPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseInventoryCountingPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseInventoryCountingPosition" } } } } } }, "post": { "tags": [ "WarehouseInventoryCountingPosition" ], "summary": "WarehouseInventoryCountingPosition: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInventoryCountingPosition-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInventoryCountingPosition_Post_7C6732F1F0A2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryCountingPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryCountingPosition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryCountingPosition" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInventoryCountingPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInventoryCountingPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInventoryCountingPosition" } } } } } }, "put": { "tags": [ "WarehouseInventoryCountingPosition" ], "summary": "WarehouseInventoryCountingPosition: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInventoryCountingPosition-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInventoryCountingPosition_Put_E8B48188D626", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryCountingPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryCountingPosition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryCountingPosition" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInventoryCountingPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInventoryCountingPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInventoryCountingPosition" } } } } } } }, "/api/WarehouseInventoryCountingPosition/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "WarehouseInventoryCountingPosition" ], "summary": "WarehouseInventoryCountingPosition: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInventoryCountingPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInventoryCountingPosition_GetPageByValue_56C8CD9D0E21", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WarehouseInventoryCountingPosition/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "WarehouseInventoryCountingPosition" ], "summary": "WarehouseInventoryCountingPosition: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInventoryCountingPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInventoryCountingPosition_GetPageByValue2_451B468AB0C6", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WarehouseInventoryCountingPosition/DeleteByFilter": { "post": { "tags": [ "WarehouseInventoryCountingPosition" ], "summary": "WarehouseInventoryCountingPosition: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInventoryCountingPosition-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInventoryCountingPosition_DeleteByFilter_D544C57B006D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/WarehouseInventoryCountingPosition/DeleteWarehouseInventoryCountingPosition": { "post": { "tags": [ "WarehouseInventoryCountingPosition" ], "summary": "WarehouseInventoryCountingPosition: DeleteWarehouseInventoryCountingPosition", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInventoryCountingPosition-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInventoryCountingPosition_DeleteWarehouseInventoryCountingPosition_3246023C6D25", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryCountingPosition_DeleteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryCountingPosition_DeleteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryCountingPosition_DeleteRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/WarehouseInventoryCountingPosition/GetAllByValue": { "post": { "tags": [ "WarehouseInventoryCountingPosition" ], "summary": "WarehouseInventoryCountingPosition: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInventoryCountingPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInventoryCountingPosition_GetAllByValue_32DC5C7FDC47", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseInventoryCountingPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseInventoryCountingPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseInventoryCountingPosition" } } } } } } }, "/api/WarehouseInventoryCountingPosition/GetAllFromViewByValue": { "post": { "tags": [ "WarehouseInventoryCountingPosition" ], "summary": "WarehouseInventoryCountingPosition: GetAllFromViewByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInventoryCountingPosition-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInventoryCountingPosition_GetAllFromViewByValue_4DB0C80B6D53", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryCountingPosition_GetAllFromViewByValueRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryCountingPosition_GetAllFromViewByValueRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryCountingPosition_GetAllFromViewByValueRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW520_WarehouseInventoryCountingPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW520_WarehouseInventoryCountingPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW520_WarehouseInventoryCountingPosition" } } } } } } }, "/api/WarehouseInventoryCountingPosition/GetAllGraphByValue": { "post": { "tags": [ "WarehouseInventoryCountingPosition" ], "summary": "WarehouseInventoryCountingPosition: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInventoryCountingPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInventoryCountingPosition_GetAllGraphByValue_C34CDD6A026B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseInventoryCountingPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseInventoryCountingPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseInventoryCountingPosition" } } } } } } }, "/api/WarehouseInventoryCountingPosition/GetByValue": { "post": { "tags": [ "WarehouseInventoryCountingPosition" ], "summary": "WarehouseInventoryCountingPosition: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInventoryCountingPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInventoryCountingPosition_GetByValue_4A3528AB0ED4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInventoryCountingPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInventoryCountingPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInventoryCountingPosition" } } } } } } }, "/api/WarehouseInventoryCountingPosition/GetLookup": { "post": { "tags": [ "WarehouseInventoryCountingPosition" ], "summary": "WarehouseInventoryCountingPosition: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInventoryCountingPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInventoryCountingPosition_GetLookup_96D1FC060E7C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/WarehouseInventoryCountingPosition/GetLookupByValue": { "post": { "tags": [ "WarehouseInventoryCountingPosition" ], "summary": "WarehouseInventoryCountingPosition: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInventoryCountingPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInventoryCountingPosition_GetLookupByValue_13A1D4173A0A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/WarehouseInventoryCountingPosition/InsertWarehouseInventoryCountingPosition": { "post": { "tags": [ "WarehouseInventoryCountingPosition" ], "summary": "WarehouseInventoryCountingPosition: InsertWarehouseInventoryCountingPosition", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInventoryCountingPosition-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInventoryCountingPosition_InsertWarehouseInventoryCountingPosition_7931A47AFB17", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryCountingPosition_InsertRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryCountingPosition_InsertRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryCountingPosition_InsertRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xPROC520I_WarehouseInventoryCountingPosition_NewArticleResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xPROC520I_WarehouseInventoryCountingPosition_NewArticleResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xPROC520I_WarehouseInventoryCountingPosition_NewArticleResult" } } } } } } }, "/api/WarehouseInventoryCountingPosition/InsertWarehouseInventoryCountingPositionFromWarehouse": { "post": { "tags": [ "WarehouseInventoryCountingPosition" ], "summary": "WarehouseInventoryCountingPosition: InsertWarehouseInventoryCountingPositionFromWarehouse", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInventoryCountingPosition-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInventoryCountingPosition_InsertWarehouseInventoryCountingPositionFromWarehouse_E55176DE29C5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryCountingPosition_InsertFromWarehouseRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryCountingPosition_InsertFromWarehouseRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryCountingPosition_InsertFromWarehouseRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/WarehouseInventoryCountingPosition/Page": { "get": { "tags": [ "WarehouseInventoryCountingPosition" ], "summary": "WarehouseInventoryCountingPosition: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInventoryCountingPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInventoryCountingPosition_GetPage_AFE236012E06", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WarehouseInventoryCountingPosition/PageAsc": { "get": { "tags": [ "WarehouseInventoryCountingPosition" ], "summary": "WarehouseInventoryCountingPosition: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInventoryCountingPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInventoryCountingPosition_GetPageAsc_4E234983DE5C", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WarehouseInventoryCountingPosition/SaveWarehouseInventoryCountingDraft": { "post": { "tags": [ "WarehouseInventoryCountingPosition" ], "summary": "WarehouseInventoryCountingPosition: SaveWarehouseInventoryCountingDraft", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInventoryCountingPosition-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInventoryCountingPosition_SaveWarehouseInventoryCountingDraft_DA2731C45D58", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryCountingPosition_SaveDraftRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryCountingPosition_SaveDraftRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryCountingPosition_SaveDraftRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SaveWarehouseInventoryCountingDraftResult" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SaveWarehouseInventoryCountingDraftResult" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SaveWarehouseInventoryCountingDraftResult" } } } } } } } }, "/api/WarehouseInventoryCountingPosition/SearchByValue": { "post": { "tags": [ "WarehouseInventoryCountingPosition" ], "summary": "WarehouseInventoryCountingPosition: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInventoryCountingPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInventoryCountingPosition_SearchByValue_D74222FB389C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WarehouseInventoryCountingPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WarehouseInventoryCountingPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WarehouseInventoryCountingPosition" } } } } } } }, "/api/WarehouseInventoryCountingPosition/TryGetByValue": { "post": { "tags": [ "WarehouseInventoryCountingPosition" ], "summary": "WarehouseInventoryCountingPosition: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInventoryCountingPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInventoryCountingPosition_TryGetByValue_D0DD00442E87", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInventoryCountingPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInventoryCountingPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInventoryCountingPosition" } } } } } } }, "/api/WarehouseInventoryCountingPosition/UpdateWarehouseInventoryCountingPosition_BinLocationId": { "post": { "tags": [ "WarehouseInventoryCountingPosition" ], "summary": "WarehouseInventoryCountingPosition: UpdateWarehouseInventoryCountingPosition_BinLocationId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInventoryCountingPosition-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInventoryCountingPosition_UpdateWarehouseInventoryCountingPosition_BinLocationId_F1739FA9B2F7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryCountingPosition_UpdateBinLocationIdRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryCountingPosition_UpdateBinLocationIdRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryCountingPosition_UpdateBinLocationIdRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/WarehouseInventoryCountingPosition/UpdateWarehouseInventoryCountingPosition_CountedQuantity": { "post": { "tags": [ "WarehouseInventoryCountingPosition" ], "summary": "WarehouseInventoryCountingPosition: UpdateWarehouseInventoryCountingPosition_CountedQuantity", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInventoryCountingPosition-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInventoryCountingPosition_UpdateWarehouseInventoryCountingPosition_CountedQuantity_0E06A1F8AF89", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryCountingPosition_UpdateCountedQuantityRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryCountingPosition_UpdateCountedQuantityRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryCountingPosition_UpdateCountedQuantityRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/WarehouseInventoryCountingPosition/UpdateWarehouseInventoryCountingPosition_IndividualizationNumberId": { "post": { "tags": [ "WarehouseInventoryCountingPosition" ], "summary": "WarehouseInventoryCountingPosition: UpdateWarehouseInventoryCountingPosition_IndividualizationNumberId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInventoryCountingPosition-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInventoryCountingPosition_UpdateWarehouseInventoryCountingPosition_IndividualizationNumberId_1F095C4F6557", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryCountingPosition_UpdateIndividualizationNumberIdRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryCountingPosition_UpdateIndividualizationNumberIdRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryCountingPosition_UpdateIndividualizationNumberIdRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/WarehouseInventoryCountingPosition/UpsertGraph": { "put": { "tags": [ "WarehouseInventoryCountingPosition" ], "summary": "WarehouseInventoryCountingPosition: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInventoryCountingPosition-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInventoryCountingPosition_UpsertGraph_4FC5788A9D3B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryCountingPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryCountingPosition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryCountingPosition" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInventoryCountingPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInventoryCountingPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInventoryCountingPosition" } } } } } } }, "/api/WarehouseInventoryCountingPosition/UpsertGraphWithExtraFields": { "put": { "tags": [ "WarehouseInventoryCountingPosition" ], "summary": "WarehouseInventoryCountingPosition: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInventoryCountingPosition-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInventoryCountingPosition_UpsertGraphWithExtraFields_735C4D7D7DDA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseInventoryCountingPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseInventoryCountingPosition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseInventoryCountingPosition" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseInventoryCountingPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseInventoryCountingPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseInventoryCountingPosition" } } } } } } }, "/api/WarehouseInventoryRevaluation": { "get": { "tags": [ "WarehouseInventoryRevaluation" ], "summary": "WarehouseInventoryRevaluation: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInventoryRevaluation-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInventoryRevaluation_GetAll_C81634AEA9FB", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseInventoryRevaluation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseInventoryRevaluation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseInventoryRevaluation" } } } } } }, "post": { "tags": [ "WarehouseInventoryRevaluation" ], "summary": "WarehouseInventoryRevaluation: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInventoryRevaluation-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInventoryRevaluation_Post_D0F60DF9658D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryRevaluation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryRevaluation" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryRevaluation" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInventoryRevaluation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInventoryRevaluation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInventoryRevaluation" } } } } } }, "put": { "tags": [ "WarehouseInventoryRevaluation" ], "summary": "WarehouseInventoryRevaluation: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInventoryRevaluation-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInventoryRevaluation_Put_767106FC4D0E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryRevaluation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryRevaluation" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryRevaluation" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInventoryRevaluation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInventoryRevaluation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInventoryRevaluation" } } } } } } }, "/api/WarehouseInventoryRevaluation/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "WarehouseInventoryRevaluation" ], "summary": "WarehouseInventoryRevaluation: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInventoryRevaluation-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInventoryRevaluation_GetPageByValue_11AEF9C7F764", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WarehouseInventoryRevaluation/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "WarehouseInventoryRevaluation" ], "summary": "WarehouseInventoryRevaluation: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInventoryRevaluation-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInventoryRevaluation_GetPageByValue2_58789EAE327B", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WarehouseInventoryRevaluation/CreateNewWarehouseInventoryRevaluation": { "post": { "tags": [ "WarehouseInventoryRevaluation" ], "summary": "WarehouseInventoryRevaluation: CreateNewWarehouseInventoryRevaluation", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInventoryRevaluation-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInventoryRevaluation_CreateNewWarehouseInventoryRevaluation_67871118D1F6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryRevaluation_CreateNewRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryRevaluation_CreateNewRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryRevaluation_CreateNewRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInventoryRevaluation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInventoryRevaluation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInventoryRevaluation" } } } } } } }, "/api/WarehouseInventoryRevaluation/DeleteByFilter": { "post": { "tags": [ "WarehouseInventoryRevaluation" ], "summary": "WarehouseInventoryRevaluation: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInventoryRevaluation-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInventoryRevaluation_DeleteByFilter_8405ED1EF163", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/WarehouseInventoryRevaluation/GetAllByValue": { "post": { "tags": [ "WarehouseInventoryRevaluation" ], "summary": "WarehouseInventoryRevaluation: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInventoryRevaluation-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInventoryRevaluation_GetAllByValue_FCA0C9F92032", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseInventoryRevaluation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseInventoryRevaluation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseInventoryRevaluation" } } } } } } }, "/api/WarehouseInventoryRevaluation/GetAllGraphByValue": { "post": { "tags": [ "WarehouseInventoryRevaluation" ], "summary": "WarehouseInventoryRevaluation: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInventoryRevaluation-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInventoryRevaluation_GetAllGraphByValue_E4D1998E152F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseInventoryRevaluation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseInventoryRevaluation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseInventoryRevaluation" } } } } } } }, "/api/WarehouseInventoryRevaluation/GetByValue": { "post": { "tags": [ "WarehouseInventoryRevaluation" ], "summary": "WarehouseInventoryRevaluation: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInventoryRevaluation-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInventoryRevaluation_GetByValue_85469CE9892F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInventoryRevaluation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInventoryRevaluation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInventoryRevaluation" } } } } } } }, "/api/WarehouseInventoryRevaluation/GetLookup": { "post": { "tags": [ "WarehouseInventoryRevaluation" ], "summary": "WarehouseInventoryRevaluation: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInventoryRevaluation-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInventoryRevaluation_GetLookup_3F9075C0550F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/WarehouseInventoryRevaluation/GetLookupByValue": { "post": { "tags": [ "WarehouseInventoryRevaluation" ], "summary": "WarehouseInventoryRevaluation: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInventoryRevaluation-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInventoryRevaluation_GetLookupByValue_C2F03850027C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/WarehouseInventoryRevaluation/Page": { "get": { "tags": [ "WarehouseInventoryRevaluation" ], "summary": "WarehouseInventoryRevaluation: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInventoryRevaluation-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInventoryRevaluation_GetPage_B9BA4CFB475E", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WarehouseInventoryRevaluation/PageAsc": { "get": { "tags": [ "WarehouseInventoryRevaluation" ], "summary": "WarehouseInventoryRevaluation: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInventoryRevaluation-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInventoryRevaluation_GetPageAsc_E1879F458D69", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WarehouseInventoryRevaluation/SearchByValue": { "post": { "tags": [ "WarehouseInventoryRevaluation" ], "summary": "WarehouseInventoryRevaluation: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInventoryRevaluation-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInventoryRevaluation_SearchByValue_139F56C0D930", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WarehouseInventoryRevaluation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WarehouseInventoryRevaluation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WarehouseInventoryRevaluation" } } } } } } }, "/api/WarehouseInventoryRevaluation/Sproc_UpdateField": { "put": { "tags": [ "WarehouseInventoryRevaluation" ], "summary": "WarehouseInventoryRevaluation: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInventoryRevaluation-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInventoryRevaluation_Put_3DC9FF871396", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryRevaluation_Sproc_UpdateField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryRevaluation_Sproc_UpdateField" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryRevaluation_Sproc_UpdateField" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInventoryRevaluation_Sproc_UpdateField" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInventoryRevaluation_Sproc_UpdateField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInventoryRevaluation_Sproc_UpdateField" } } } } } } }, "/api/WarehouseInventoryRevaluation/TryGetByValue": { "post": { "tags": [ "WarehouseInventoryRevaluation" ], "summary": "WarehouseInventoryRevaluation: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInventoryRevaluation-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInventoryRevaluation_TryGetByValue_773B2CCC9967", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInventoryRevaluation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInventoryRevaluation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInventoryRevaluation" } } } } } } }, "/api/WarehouseInventoryRevaluation/UpsertGraph": { "put": { "tags": [ "WarehouseInventoryRevaluation" ], "summary": "WarehouseInventoryRevaluation: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInventoryRevaluation-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInventoryRevaluation_UpsertGraph_F9BB00864DC1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryRevaluation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryRevaluation" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryRevaluation" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInventoryRevaluation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInventoryRevaluation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInventoryRevaluation" } } } } } } }, "/api/WarehouseInventoryRevaluation/UpsertGraphWithExtraFields": { "put": { "tags": [ "WarehouseInventoryRevaluation" ], "summary": "WarehouseInventoryRevaluation: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInventoryRevaluation-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInventoryRevaluation_UpsertGraphWithExtraFields_86E6D0C3E969", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseInventoryRevaluation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseInventoryRevaluation" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseInventoryRevaluation" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseInventoryRevaluation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseInventoryRevaluation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseInventoryRevaluation" } } } } } } }, "/api/WarehouseInventoryRevaluationPosition": { "get": { "tags": [ "WarehouseInventoryRevaluationPosition" ], "summary": "WarehouseInventoryRevaluationPosition: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInventoryRevaluationPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInventoryRevaluationPosition_GetAll_1876CF75C03A", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseInventoryRevaluationPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseInventoryRevaluationPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseInventoryRevaluationPosition" } } } } } }, "post": { "tags": [ "WarehouseInventoryRevaluationPosition" ], "summary": "WarehouseInventoryRevaluationPosition: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInventoryRevaluationPosition-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInventoryRevaluationPosition_Post_6EEC04343B29", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryRevaluationPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryRevaluationPosition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryRevaluationPosition" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInventoryRevaluationPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInventoryRevaluationPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInventoryRevaluationPosition" } } } } } }, "put": { "tags": [ "WarehouseInventoryRevaluationPosition" ], "summary": "WarehouseInventoryRevaluationPosition: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInventoryRevaluationPosition-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInventoryRevaluationPosition_Put_B20335DCF337", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryRevaluationPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryRevaluationPosition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryRevaluationPosition" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInventoryRevaluationPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInventoryRevaluationPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInventoryRevaluationPosition" } } } } } } }, "/api/WarehouseInventoryRevaluationPosition/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "WarehouseInventoryRevaluationPosition" ], "summary": "WarehouseInventoryRevaluationPosition: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInventoryRevaluationPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInventoryRevaluationPosition_GetPageByValue_0A61EAD665DE", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WarehouseInventoryRevaluationPosition/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "WarehouseInventoryRevaluationPosition" ], "summary": "WarehouseInventoryRevaluationPosition: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInventoryRevaluationPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInventoryRevaluationPosition_GetPageByValue2_806A841DFAD7", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WarehouseInventoryRevaluationPosition/DeleteByFilter": { "post": { "tags": [ "WarehouseInventoryRevaluationPosition" ], "summary": "WarehouseInventoryRevaluationPosition: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInventoryRevaluationPosition-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInventoryRevaluationPosition_DeleteByFilter_62703078A1CA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/WarehouseInventoryRevaluationPosition/DeleteWarehouseInventoryRevaluationPosition": { "post": { "tags": [ "WarehouseInventoryRevaluationPosition" ], "summary": "WarehouseInventoryRevaluationPosition: DeleteWarehouseInventoryRevaluationPosition", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInventoryRevaluationPosition-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInventoryRevaluationPosition_DeleteWarehouseInventoryRevaluationPosition_AF9A0C25F078", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryRevaluationPosition_DeleteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryRevaluationPosition_DeleteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryRevaluationPosition_DeleteRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/WarehouseInventoryRevaluationPosition/GetAllByValue": { "post": { "tags": [ "WarehouseInventoryRevaluationPosition" ], "summary": "WarehouseInventoryRevaluationPosition: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInventoryRevaluationPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInventoryRevaluationPosition_GetAllByValue_EDB6912424E2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseInventoryRevaluationPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseInventoryRevaluationPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseInventoryRevaluationPosition" } } } } } } }, "/api/WarehouseInventoryRevaluationPosition/GetAllFromViewByValue": { "post": { "tags": [ "WarehouseInventoryRevaluationPosition" ], "summary": "WarehouseInventoryRevaluationPosition: GetAllFromViewByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInventoryRevaluationPosition-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInventoryRevaluationPosition_GetAllFromViewByValue_F42E3ED70A7B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryRevaluationPosition_GetAllFromViewByValueRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryRevaluationPosition_GetAllFromViewByValueRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryRevaluationPosition_GetAllFromViewByValueRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW521_WarehouseInventoryRevaluationPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW521_WarehouseInventoryRevaluationPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW521_WarehouseInventoryRevaluationPosition" } } } } } } }, "/api/WarehouseInventoryRevaluationPosition/GetAllGraphByValue": { "post": { "tags": [ "WarehouseInventoryRevaluationPosition" ], "summary": "WarehouseInventoryRevaluationPosition: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInventoryRevaluationPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInventoryRevaluationPosition_GetAllGraphByValue_1ADAC09D84EF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseInventoryRevaluationPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseInventoryRevaluationPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseInventoryRevaluationPosition" } } } } } } }, "/api/WarehouseInventoryRevaluationPosition/GetByValue": { "post": { "tags": [ "WarehouseInventoryRevaluationPosition" ], "summary": "WarehouseInventoryRevaluationPosition: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInventoryRevaluationPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInventoryRevaluationPosition_GetByValue_E93AA59B6FD0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInventoryRevaluationPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInventoryRevaluationPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInventoryRevaluationPosition" } } } } } } }, "/api/WarehouseInventoryRevaluationPosition/GetLookup": { "post": { "tags": [ "WarehouseInventoryRevaluationPosition" ], "summary": "WarehouseInventoryRevaluationPosition: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInventoryRevaluationPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInventoryRevaluationPosition_GetLookup_DFDE805433BD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/WarehouseInventoryRevaluationPosition/GetLookupByValue": { "post": { "tags": [ "WarehouseInventoryRevaluationPosition" ], "summary": "WarehouseInventoryRevaluationPosition: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInventoryRevaluationPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInventoryRevaluationPosition_GetLookupByValue_AC06B0BD4CEA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/WarehouseInventoryRevaluationPosition/InsertWarehouseInventoryRevaluationPosition": { "post": { "tags": [ "WarehouseInventoryRevaluationPosition" ], "summary": "WarehouseInventoryRevaluationPosition: InsertWarehouseInventoryRevaluationPosition", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInventoryRevaluationPosition-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInventoryRevaluationPosition_InsertWarehouseInventoryRevaluationPosition_7BA49D396520", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryRevaluationPosition_InsertRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryRevaluationPosition_InsertRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryRevaluationPosition_InsertRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xPROC521I_WarehouseInventoryRevaluationPosition_ArticleResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xPROC521I_WarehouseInventoryRevaluationPosition_ArticleResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xPROC521I_WarehouseInventoryRevaluationPosition_ArticleResult" } } } } } } }, "/api/WarehouseInventoryRevaluationPosition/InsertWarehouseInventoryRevaluationPositionAllArticles": { "post": { "tags": [ "WarehouseInventoryRevaluationPosition" ], "summary": "WarehouseInventoryRevaluationPosition: InsertWarehouseInventoryRevaluationPositionAllArticles", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInventoryRevaluationPosition-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInventoryRevaluationPosition_InsertWarehouseInventoryRevaluationPositionAllArticles_4A1DF6A0084D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryRevaluationPosition_InsertAllRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryRevaluationPosition_InsertAllRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryRevaluationPosition_InsertAllRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "integer", "format": "int32" } }, "application/json": { "schema": { "type": "integer", "format": "int32" } }, "text/json": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/api/WarehouseInventoryRevaluationPosition/Page": { "get": { "tags": [ "WarehouseInventoryRevaluationPosition" ], "summary": "WarehouseInventoryRevaluationPosition: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInventoryRevaluationPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInventoryRevaluationPosition_GetPage_B6B08D4E6D20", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WarehouseInventoryRevaluationPosition/PageAsc": { "get": { "tags": [ "WarehouseInventoryRevaluationPosition" ], "summary": "WarehouseInventoryRevaluationPosition: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInventoryRevaluationPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInventoryRevaluationPosition_GetPageAsc_03DDFF331330", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WarehouseInventoryRevaluationPosition/SaveWarehouseInventoryRevaluationDraft": { "post": { "tags": [ "WarehouseInventoryRevaluationPosition" ], "summary": "WarehouseInventoryRevaluationPosition: SaveWarehouseInventoryRevaluationDraft", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInventoryRevaluationPosition-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInventoryRevaluationPosition_SaveWarehouseInventoryRevaluationDraft_8401E326A4DD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryRevaluationPosition_SaveDraftRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryRevaluationPosition_SaveDraftRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryRevaluationPosition_SaveDraftRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SaveWarehouseInventoryRevaluationDraftResult" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SaveWarehouseInventoryRevaluationDraftResult" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SaveWarehouseInventoryRevaluationDraftResult" } } } } } } } }, "/api/WarehouseInventoryRevaluationPosition/SearchByValue": { "post": { "tags": [ "WarehouseInventoryRevaluationPosition" ], "summary": "WarehouseInventoryRevaluationPosition: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInventoryRevaluationPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInventoryRevaluationPosition_SearchByValue_C2F6026F692B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WarehouseInventoryRevaluationPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WarehouseInventoryRevaluationPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WarehouseInventoryRevaluationPosition" } } } } } } }, "/api/WarehouseInventoryRevaluationPosition/TryGetByValue": { "post": { "tags": [ "WarehouseInventoryRevaluationPosition" ], "summary": "WarehouseInventoryRevaluationPosition: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInventoryRevaluationPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInventoryRevaluationPosition_TryGetByValue_853713B0DF5B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInventoryRevaluationPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInventoryRevaluationPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInventoryRevaluationPosition" } } } } } } }, "/api/WarehouseInventoryRevaluationPosition/UpdateWarehouseInventoryRevaluationPosition_NewValue": { "post": { "tags": [ "WarehouseInventoryRevaluationPosition" ], "summary": "WarehouseInventoryRevaluationPosition: UpdateWarehouseInventoryRevaluationPosition_NewValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInventoryRevaluationPosition-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInventoryRevaluationPosition_UpdateWarehouseInventoryRevaluationPosition_NewValue_53B4F3629CFD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryRevaluationPosition_UpdateNewValueRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryRevaluationPosition_UpdateNewValueRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryRevaluationPosition_UpdateNewValueRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xPROC521U_WarehouseInventoryRevaluationPosition_NewValueResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xPROC521U_WarehouseInventoryRevaluationPosition_NewValueResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xPROC521U_WarehouseInventoryRevaluationPosition_NewValueResult" } } } } } } }, "/api/WarehouseInventoryRevaluationPosition/UpsertGraph": { "put": { "tags": [ "WarehouseInventoryRevaluationPosition" ], "summary": "WarehouseInventoryRevaluationPosition: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInventoryRevaluationPosition-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInventoryRevaluationPosition_UpsertGraph_C96DAD2B66AB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryRevaluationPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryRevaluationPosition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryRevaluationPosition" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInventoryRevaluationPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInventoryRevaluationPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInventoryRevaluationPosition" } } } } } } }, "/api/WarehouseInventoryRevaluationPosition/UpsertGraphWithExtraFields": { "put": { "tags": [ "WarehouseInventoryRevaluationPosition" ], "summary": "WarehouseInventoryRevaluationPosition: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseInventoryRevaluationPosition-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseInventoryRevaluationPosition_UpsertGraphWithExtraFields_28C511D86740", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseInventoryRevaluationPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseInventoryRevaluationPosition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseInventoryRevaluationPosition" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseInventoryRevaluationPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseInventoryRevaluationPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseInventoryRevaluationPosition" } } } } } } }, "/api/WarehouseMedium": { "get": { "tags": [ "WarehouseMedium" ], "summary": "WarehouseMedium: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseMedium-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseMedium_GetAll_657597F0B54F", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseMedium" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseMedium" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseMedium" } } } } } }, "post": { "tags": [ "WarehouseMedium" ], "summary": "WarehouseMedium: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseMedium-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseMedium_Post_474ED2F4198D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseMedium" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseMedium" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseMedium" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseMedium" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseMedium" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseMedium" } } } } } }, "put": { "tags": [ "WarehouseMedium" ], "summary": "WarehouseMedium: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseMedium-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseMedium_Put_B319656D2037", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseMedium" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseMedium" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseMedium" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseMedium" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseMedium" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseMedium" } } } } } } }, "/api/WarehouseMedium/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "WarehouseMedium" ], "summary": "WarehouseMedium: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseMedium-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseMedium_GetPageByValue_F254735B4D46", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WarehouseMedium/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "WarehouseMedium" ], "summary": "WarehouseMedium: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseMedium-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseMedium_GetPageByValue2_97BC5D7973AF", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WarehouseMedium/DeleteByFilter": { "post": { "tags": [ "WarehouseMedium" ], "summary": "WarehouseMedium: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseMedium-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseMedium_DeleteByFilter_B3196421F363", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/WarehouseMedium/GetAllByValue": { "post": { "tags": [ "WarehouseMedium" ], "summary": "WarehouseMedium: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseMedium-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseMedium_GetAllByValue_EE1BBD8086F4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseMedium" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseMedium" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseMedium" } } } } } } }, "/api/WarehouseMedium/GetAllGraphByValue": { "post": { "tags": [ "WarehouseMedium" ], "summary": "WarehouseMedium: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseMedium-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseMedium_GetAllGraphByValue_6551D427CA8D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseMedium" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseMedium" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseMedium" } } } } } } }, "/api/WarehouseMedium/GetByValue": { "post": { "tags": [ "WarehouseMedium" ], "summary": "WarehouseMedium: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseMedium-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseMedium_GetByValue_21E8EE67900E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseMedium" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseMedium" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseMedium" } } } } } } }, "/api/WarehouseMedium/GetLookup": { "post": { "tags": [ "WarehouseMedium" ], "summary": "WarehouseMedium: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseMedium-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseMedium_GetLookup_7689CAC59E94", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/WarehouseMedium/GetLookupByValue": { "post": { "tags": [ "WarehouseMedium" ], "summary": "WarehouseMedium: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseMedium-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseMedium_GetLookupByValue_985ED549BF70", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/WarehouseMedium/Page": { "get": { "tags": [ "WarehouseMedium" ], "summary": "WarehouseMedium: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseMedium-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseMedium_GetPage_95961D8ABC16", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WarehouseMedium/PageAsc": { "get": { "tags": [ "WarehouseMedium" ], "summary": "WarehouseMedium: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseMedium-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseMedium_GetPageAsc_9C6C8AA0B6DB", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WarehouseMedium/SearchByValue": { "post": { "tags": [ "WarehouseMedium" ], "summary": "WarehouseMedium: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseMedium-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseMedium_SearchByValue_A44BBFA4F4AD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WarehouseMedium" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WarehouseMedium" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WarehouseMedium" } } } } } } }, "/api/WarehouseMedium/TryGetByValue": { "post": { "tags": [ "WarehouseMedium" ], "summary": "WarehouseMedium: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseMedium-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseMedium_TryGetByValue_8AE7F2ED681D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseMedium" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseMedium" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseMedium" } } } } } } }, "/api/WarehouseMedium/UpsertGraph": { "put": { "tags": [ "WarehouseMedium" ], "summary": "WarehouseMedium: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseMedium-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseMedium_UpsertGraph_2CEA45A2EED0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseMedium" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseMedium" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseMedium" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseMedium" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseMedium" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseMedium" } } } } } } }, "/api/WarehouseMedium/UpsertGraphWithExtraFields": { "put": { "tags": [ "WarehouseMedium" ], "summary": "WarehouseMedium: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseMedium-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseMedium_UpsertGraphWithExtraFields_A8878C2EB60B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseMedium" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseMedium" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseMedium" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseMedium" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseMedium" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseMedium" } } } } } } }, "/api/WarehouseQuantity": { "get": { "tags": [ "WarehouseQuantity" ], "summary": "WarehouseQuantity: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseQuantity-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseQuantity_GetAll_71B8ED297678", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseQuantity" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseQuantity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseQuantity" } } } } } }, "post": { "tags": [ "WarehouseQuantity" ], "summary": "WarehouseQuantity: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseQuantity-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseQuantity_Post_9D3EE39B17F9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseQuantity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseQuantity" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseQuantity" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseQuantity" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseQuantity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseQuantity" } } } } } }, "put": { "tags": [ "WarehouseQuantity" ], "summary": "WarehouseQuantity: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseQuantity-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseQuantity_Put_1F20DA55F12A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseQuantity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseQuantity" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseQuantity" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseQuantity" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseQuantity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseQuantity" } } } } } } }, "/api/WarehouseQuantity/{ArticleId}/{WarehouseId}/{WarehouseBinLocationId}/GetPageFromView": { "get": { "tags": [ "WarehouseQuantity" ], "summary": "WarehouseQuantity: GetPageFromView", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseQuantity-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseQuantity_GetPageFromView_74B2FFFF5C24", "parameters": [ { "name": "ArticleId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "WarehouseId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "WarehouseBinLocationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WarehouseQuantity/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "WarehouseQuantity" ], "summary": "WarehouseQuantity: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseQuantity-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseQuantity_GetPageByValue_50232BED17D7", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WarehouseQuantity/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "WarehouseQuantity" ], "summary": "WarehouseQuantity: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseQuantity-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseQuantity_GetPageByValue2_309517F1485C", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WarehouseQuantity/DeleteByFilter": { "post": { "tags": [ "WarehouseQuantity" ], "summary": "WarehouseQuantity: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseQuantity-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseQuantity_DeleteByFilter_5FBCBF07725F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/WarehouseQuantity/GetAllByValue": { "post": { "tags": [ "WarehouseQuantity" ], "summary": "WarehouseQuantity: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseQuantity-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseQuantity_GetAllByValue_8528C49A4B13", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseQuantity" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseQuantity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseQuantity" } } } } } } }, "/api/WarehouseQuantity/GetAllGraphByValue": { "post": { "tags": [ "WarehouseQuantity" ], "summary": "WarehouseQuantity: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseQuantity-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseQuantity_GetAllGraphByValue_387A827AB672", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseQuantity" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseQuantity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseQuantity" } } } } } } }, "/api/WarehouseQuantity/GetByValue": { "post": { "tags": [ "WarehouseQuantity" ], "summary": "WarehouseQuantity: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseQuantity-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseQuantity_GetByValue_F4C45BFE1A3C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseQuantity" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseQuantity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseQuantity" } } } } } } }, "/api/WarehouseQuantity/GetLookup": { "post": { "tags": [ "WarehouseQuantity" ], "summary": "WarehouseQuantity: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseQuantity-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseQuantity_GetLookup_891A7904BE71", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/WarehouseQuantity/GetLookupByValue": { "post": { "tags": [ "WarehouseQuantity" ], "summary": "WarehouseQuantity: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseQuantity-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseQuantity_GetLookupByValue_EEF6B9CFB403", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/WarehouseQuantity/Page": { "get": { "tags": [ "WarehouseQuantity" ], "summary": "WarehouseQuantity: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseQuantity-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseQuantity_GetPage_6B72919C38F4", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WarehouseQuantity/PageAsc": { "get": { "tags": [ "WarehouseQuantity" ], "summary": "WarehouseQuantity: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseQuantity-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseQuantity_GetPageAsc_1063901CCF74", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WarehouseQuantity/SearchByValue": { "post": { "tags": [ "WarehouseQuantity" ], "summary": "WarehouseQuantity: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseQuantity-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseQuantity_SearchByValue_BB6508C75B80", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WarehouseQuantity" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WarehouseQuantity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WarehouseQuantity" } } } } } } }, "/api/WarehouseQuantity/TryGetByValue": { "post": { "tags": [ "WarehouseQuantity" ], "summary": "WarehouseQuantity: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseQuantity-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseQuantity_TryGetByValue_989B4D7D3FB3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseQuantity" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseQuantity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseQuantity" } } } } } } }, "/api/WarehouseQuantity/UpsertGraph": { "put": { "tags": [ "WarehouseQuantity" ], "summary": "WarehouseQuantity: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseQuantity-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseQuantity_UpsertGraph_CE809D04DA49", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseQuantity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseQuantity" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseQuantity" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseQuantity" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseQuantity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseQuantity" } } } } } } }, "/api/WarehouseQuantity/UpsertGraphWithExtraFields": { "put": { "tags": [ "WarehouseQuantity" ], "summary": "WarehouseQuantity: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseQuantity-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseQuantity_UpsertGraphWithExtraFields_F47C765BC678", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseQuantity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseQuantity" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseQuantity" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseQuantity" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseQuantity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseQuantity" } } } } } } }, "/api/WarehouseTransfer": { "get": { "tags": [ "WarehouseTransfer" ], "summary": "WarehouseTransfer: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseTransfer-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseTransfer_GetAll_300CF1B81EF4", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseTransfer" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseTransfer" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseTransfer" } } } } } }, "post": { "tags": [ "WarehouseTransfer" ], "summary": "WarehouseTransfer: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseTransfer-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseTransfer_Post_FB45D5225068", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseTransfer" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseTransfer" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseTransfer" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseTransfer" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseTransfer" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseTransfer" } } } } } }, "put": { "tags": [ "WarehouseTransfer" ], "summary": "WarehouseTransfer: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseTransfer-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseTransfer_Put_C8193A78D73C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseTransfer" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseTransfer" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseTransfer" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseTransfer" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseTransfer" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseTransfer" } } } } } } }, "/api/WarehouseTransfer/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "WarehouseTransfer" ], "summary": "WarehouseTransfer: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseTransfer-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseTransfer_GetPageByValue_59F6877B9433", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WarehouseTransfer/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "WarehouseTransfer" ], "summary": "WarehouseTransfer: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseTransfer-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseTransfer_GetPageByValue2_C86581F4D5D4", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WarehouseTransfer/CreateNewWarehouseTransfer": { "post": { "tags": [ "WarehouseTransfer" ], "summary": "WarehouseTransfer: CreateNewWarehouseTransfer", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseTransfer-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseTransfer_CreateNewWarehouseTransfer_DED7D8C2E968", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseTransfer_CreateNewRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseTransfer_CreateNewRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseTransfer_CreateNewRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseTransfer" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseTransfer" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseTransfer" } } } } } } }, "/api/WarehouseTransfer/DeleteByFilter": { "post": { "tags": [ "WarehouseTransfer" ], "summary": "WarehouseTransfer: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseTransfer-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseTransfer_DeleteByFilter_BCD14D7CA6F6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/WarehouseTransfer/GetAllByValue": { "post": { "tags": [ "WarehouseTransfer" ], "summary": "WarehouseTransfer: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseTransfer-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseTransfer_GetAllByValue_6DCF93852F7A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseTransfer" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseTransfer" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseTransfer" } } } } } } }, "/api/WarehouseTransfer/GetAllGraphByValue": { "post": { "tags": [ "WarehouseTransfer" ], "summary": "WarehouseTransfer: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseTransfer-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseTransfer_GetAllGraphByValue_0BD163983B02", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseTransfer" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseTransfer" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseTransfer" } } } } } } }, "/api/WarehouseTransfer/GetByValue": { "post": { "tags": [ "WarehouseTransfer" ], "summary": "WarehouseTransfer: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseTransfer-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseTransfer_GetByValue_64B0291F84B4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseTransfer" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseTransfer" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseTransfer" } } } } } } }, "/api/WarehouseTransfer/GetLookup": { "post": { "tags": [ "WarehouseTransfer" ], "summary": "WarehouseTransfer: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseTransfer-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseTransfer_GetLookup_60934E64582A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/WarehouseTransfer/GetLookupByValue": { "post": { "tags": [ "WarehouseTransfer" ], "summary": "WarehouseTransfer: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseTransfer-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseTransfer_GetLookupByValue_4B64B2713789", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/WarehouseTransfer/Page": { "get": { "tags": [ "WarehouseTransfer" ], "summary": "WarehouseTransfer: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseTransfer-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseTransfer_GetPage_44067D150E07", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WarehouseTransfer/PageAsc": { "get": { "tags": [ "WarehouseTransfer" ], "summary": "WarehouseTransfer: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseTransfer-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseTransfer_GetPageAsc_33BBCBE64D95", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WarehouseTransfer/SearchByValue": { "post": { "tags": [ "WarehouseTransfer" ], "summary": "WarehouseTransfer: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseTransfer-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseTransfer_SearchByValue_24D9841A47CA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WarehouseTransfer" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WarehouseTransfer" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WarehouseTransfer" } } } } } } }, "/api/WarehouseTransfer/Sproc_UpdateField": { "put": { "tags": [ "WarehouseTransfer" ], "summary": "WarehouseTransfer: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseTransfer-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseTransfer_Put_EA5EAD7E7685", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseTransfer_Sproc_UpdateField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseTransfer_Sproc_UpdateField" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseTransfer_Sproc_UpdateField" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseTransfer_Sproc_UpdateField" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseTransfer_Sproc_UpdateField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseTransfer_Sproc_UpdateField" } } } } } } }, "/api/WarehouseTransfer/TryGetByValue": { "post": { "tags": [ "WarehouseTransfer" ], "summary": "WarehouseTransfer: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseTransfer-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseTransfer_TryGetByValue_61F67F3114BB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseTransfer" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseTransfer" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseTransfer" } } } } } } }, "/api/WarehouseTransfer/UpsertGraph": { "put": { "tags": [ "WarehouseTransfer" ], "summary": "WarehouseTransfer: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseTransfer-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseTransfer_UpsertGraph_CD14E2E12584", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseTransfer" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseTransfer" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseTransfer" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseTransfer" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseTransfer" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseTransfer" } } } } } } }, "/api/WarehouseTransfer/UpsertGraphWithExtraFields": { "put": { "tags": [ "WarehouseTransfer" ], "summary": "WarehouseTransfer: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseTransfer-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseTransfer_UpsertGraphWithExtraFields_3DC8252E1F88", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseTransfer" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseTransfer" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseTransfer" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseTransfer" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseTransfer" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseTransfer" } } } } } } }, "/api/WarehouseTransferPosition": { "get": { "tags": [ "WarehouseTransferPosition" ], "summary": "WarehouseTransferPosition: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseTransferPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseTransferPosition_GetAll_B808CC55D28A", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseTransferPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseTransferPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseTransferPosition" } } } } } }, "post": { "tags": [ "WarehouseTransferPosition" ], "summary": "WarehouseTransferPosition: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseTransferPosition-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseTransferPosition_Post_27D71F280998", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseTransferPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseTransferPosition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseTransferPosition" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseTransferPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseTransferPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseTransferPosition" } } } } } }, "put": { "tags": [ "WarehouseTransferPosition" ], "summary": "WarehouseTransferPosition: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseTransferPosition-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseTransferPosition_Put_379274C4A5AD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseTransferPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseTransferPosition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseTransferPosition" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseTransferPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseTransferPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseTransferPosition" } } } } } } }, "/api/WarehouseTransferPosition/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "WarehouseTransferPosition" ], "summary": "WarehouseTransferPosition: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseTransferPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseTransferPosition_GetPageByValue_A33EA3641168", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WarehouseTransferPosition/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "WarehouseTransferPosition" ], "summary": "WarehouseTransferPosition: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseTransferPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseTransferPosition_GetPageByValue2_21F81B272D85", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WarehouseTransferPosition/DeleteByFilter": { "post": { "tags": [ "WarehouseTransferPosition" ], "summary": "WarehouseTransferPosition: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseTransferPosition-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseTransferPosition_DeleteByFilter_BB8E2DB08CB0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/WarehouseTransferPosition/DeleteWarehouseTransferPosition": { "post": { "tags": [ "WarehouseTransferPosition" ], "summary": "WarehouseTransferPosition: DeleteWarehouseTransferPosition", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseTransferPosition-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseTransferPosition_DeleteWarehouseTransferPosition_A269D55F616B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseTransferPosition_DeleteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseTransferPosition_DeleteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseTransferPosition_DeleteRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/WarehouseTransferPosition/GetAllByValue": { "post": { "tags": [ "WarehouseTransferPosition" ], "summary": "WarehouseTransferPosition: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseTransferPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseTransferPosition_GetAllByValue_A99BE631BDAE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseTransferPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseTransferPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseTransferPosition" } } } } } } }, "/api/WarehouseTransferPosition/GetAllFromViewByValue": { "post": { "tags": [ "WarehouseTransferPosition" ], "summary": "WarehouseTransferPosition: GetAllFromViewByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseTransferPosition-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseTransferPosition_GetAllFromViewByValue_7064CB1B7280", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseTransferPosition_GetAllFromViewByValueRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseTransferPosition_GetAllFromViewByValueRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseTransferPosition_GetAllFromViewByValueRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW522_WarehouseTransferPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW522_WarehouseTransferPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW522_WarehouseTransferPosition" } } } } } } }, "/api/WarehouseTransferPosition/GetAllGraphByValue": { "post": { "tags": [ "WarehouseTransferPosition" ], "summary": "WarehouseTransferPosition: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseTransferPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseTransferPosition_GetAllGraphByValue_539136DB9183", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseTransferPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseTransferPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseTransferPosition" } } } } } } }, "/api/WarehouseTransferPosition/GetByValue": { "post": { "tags": [ "WarehouseTransferPosition" ], "summary": "WarehouseTransferPosition: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseTransferPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseTransferPosition_GetByValue_150C286427B4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseTransferPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseTransferPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseTransferPosition" } } } } } } }, "/api/WarehouseTransferPosition/GetLookup": { "post": { "tags": [ "WarehouseTransferPosition" ], "summary": "WarehouseTransferPosition: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseTransferPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseTransferPosition_GetLookup_36AA15B8849C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/WarehouseTransferPosition/GetLookupByValue": { "post": { "tags": [ "WarehouseTransferPosition" ], "summary": "WarehouseTransferPosition: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseTransferPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseTransferPosition_GetLookupByValue_4CB51BB1AF62", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/WarehouseTransferPosition/InsertWarehouseTransferPosition": { "post": { "tags": [ "WarehouseTransferPosition" ], "summary": "WarehouseTransferPosition: InsertWarehouseTransferPosition", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseTransferPosition-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseTransferPosition_InsertWarehouseTransferPosition_5782B5C20756", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseTransferPosition_InsertRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseTransferPosition_InsertRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseTransferPosition_InsertRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xPROC522I_WarehouseTransferPosition_ArticleResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xPROC522I_WarehouseTransferPosition_ArticleResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xPROC522I_WarehouseTransferPosition_ArticleResult" } } } } } } }, "/api/WarehouseTransferPosition/Page": { "get": { "tags": [ "WarehouseTransferPosition" ], "summary": "WarehouseTransferPosition: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseTransferPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseTransferPosition_GetPage_EF66C6865B3A", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WarehouseTransferPosition/PageAsc": { "get": { "tags": [ "WarehouseTransferPosition" ], "summary": "WarehouseTransferPosition: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseTransferPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseTransferPosition_GetPageAsc_945D27EB16DF", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WarehouseTransferPosition/SaveWarehouseTransferDraft": { "post": { "tags": [ "WarehouseTransferPosition" ], "summary": "WarehouseTransferPosition: SaveWarehouseTransferDraft", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseTransferPosition-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseTransferPosition_SaveWarehouseTransferDraft_AB58FE01C297", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseTransferPosition_SaveDraftRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseTransferPosition_SaveDraftRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseTransferPosition_SaveDraftRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SaveWarehouseTransferDraftResult" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SaveWarehouseTransferDraftResult" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SaveWarehouseTransferDraftResult" } } } } } } } }, "/api/WarehouseTransferPosition/SearchByValue": { "post": { "tags": [ "WarehouseTransferPosition" ], "summary": "WarehouseTransferPosition: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseTransferPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseTransferPosition_SearchByValue_EE4E08AA6C6B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WarehouseTransferPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WarehouseTransferPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WarehouseTransferPosition" } } } } } } }, "/api/WarehouseTransferPosition/TryGetByValue": { "post": { "tags": [ "WarehouseTransferPosition" ], "summary": "WarehouseTransferPosition: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseTransferPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseTransferPosition_TryGetByValue_A3B9BAA8E43A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseTransferPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseTransferPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseTransferPosition" } } } } } } }, "/api/WarehouseTransferPosition/UpdateWarehouseTransferPosition_IndividualizationNumberId": { "post": { "tags": [ "WarehouseTransferPosition" ], "summary": "WarehouseTransferPosition: UpdateWarehouseTransferPosition_IndividualizationNumberId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseTransferPosition-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseTransferPosition_UpdateWarehouseTransferPosition_IndividualizationNumberId_76302B8D007D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseTransferPosition_UpdateIndividualizationNumberIdRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseTransferPosition_UpdateIndividualizationNumberIdRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseTransferPosition_UpdateIndividualizationNumberIdRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/WarehouseTransferPosition/UpdateWarehouseTransferPosition_Quantity": { "post": { "tags": [ "WarehouseTransferPosition" ], "summary": "WarehouseTransferPosition: UpdateWarehouseTransferPosition_Quantity", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseTransferPosition-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseTransferPosition_UpdateWarehouseTransferPosition_Quantity_847E435D9A69", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseTransferPosition_UpdateQuantityRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseTransferPosition_UpdateQuantityRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseTransferPosition_UpdateQuantityRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/WarehouseTransferPosition/UpsertGraph": { "put": { "tags": [ "WarehouseTransferPosition" ], "summary": "WarehouseTransferPosition: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseTransferPosition-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseTransferPosition_UpsertGraph_B2D3A3A33CCC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseTransferPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseTransferPosition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseTransferPosition" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseTransferPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseTransferPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseTransferPosition" } } } } } } }, "/api/WarehouseTransferPosition/UpsertGraphWithExtraFields": { "put": { "tags": [ "WarehouseTransferPosition" ], "summary": "WarehouseTransferPosition: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseTransferPosition-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseTransferPosition_UpsertGraphWithExtraFields_E2C469DBCB9A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseTransferPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseTransferPosition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseTransferPosition" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseTransferPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseTransferPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseTransferPosition" } } } } } } }, "/api/WarehouseType": { "get": { "tags": [ "WarehouseType" ], "summary": "WarehouseType: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseType_GetAll_B1AE6DACF926", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseType" } } } } } }, "post": { "tags": [ "WarehouseType" ], "summary": "WarehouseType: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseType-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseType_Post_EF88C9411068", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseType" } } } } } }, "put": { "tags": [ "WarehouseType" ], "summary": "WarehouseType: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseType_Put_82D8D73231FA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseType" } } } } } } }, "/api/WarehouseType/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "WarehouseType" ], "summary": "WarehouseType: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseType_GetPageByValue_3E07EEDAE212", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WarehouseType/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "WarehouseType" ], "summary": "WarehouseType: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseType_GetPageByValue2_69D53F8FA26D", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WarehouseType/DeleteByFilter": { "post": { "tags": [ "WarehouseType" ], "summary": "WarehouseType: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseType-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseType_DeleteByFilter_BBFD099EB965", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/WarehouseType/GetAllByValue": { "post": { "tags": [ "WarehouseType" ], "summary": "WarehouseType: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseType_GetAllByValue_CE0269E7821E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseType" } } } } } } }, "/api/WarehouseType/GetAllGraphByValue": { "post": { "tags": [ "WarehouseType" ], "summary": "WarehouseType: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseType_GetAllGraphByValue_FDE4904ED5B3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseType" } } } } } } }, "/api/WarehouseType/GetByValue": { "post": { "tags": [ "WarehouseType" ], "summary": "WarehouseType: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseType_GetByValue_95665B15047A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseType" } } } } } } }, "/api/WarehouseType/GetLookup": { "post": { "tags": [ "WarehouseType" ], "summary": "WarehouseType: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseType_GetLookup_E2C21CCDCDC4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/WarehouseType/GetLookupByValue": { "post": { "tags": [ "WarehouseType" ], "summary": "WarehouseType: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseType_GetLookupByValue_3E045E334DA8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/WarehouseType/Page": { "get": { "tags": [ "WarehouseType" ], "summary": "WarehouseType: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseType_GetPage_47FD5A84D88F", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WarehouseType/PageAsc": { "get": { "tags": [ "WarehouseType" ], "summary": "WarehouseType: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseType_GetPageAsc_17938E6B06BF", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WarehouseType/SearchByValue": { "post": { "tags": [ "WarehouseType" ], "summary": "WarehouseType: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseType_SearchByValue_38790E1F323F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WarehouseType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WarehouseType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WarehouseType" } } } } } } }, "/api/WarehouseType/TryGetByValue": { "post": { "tags": [ "WarehouseType" ], "summary": "WarehouseType: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseType-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseType_TryGetByValue_837BADE18A0F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseType" } } } } } } }, "/api/WarehouseType/UpsertGraph": { "put": { "tags": [ "WarehouseType" ], "summary": "WarehouseType: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseType_UpsertGraph_9B24571CD7B1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseType" } } } } } } }, "/api/WarehouseType/UpsertGraphWithExtraFields": { "put": { "tags": [ "WarehouseType" ], "summary": "WarehouseType: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WarehouseType-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WarehouseType_UpsertGraphWithExtraFields_37731E3F4CB5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseType" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseType" } } } } } } }, "/api/WebApiUser/WebApiLogin": { "post": { "tags": [ "WebApiUser" ], "summary": "Sign in to a company database", "description": "This operation allows requests without an X-ERP application session. Operation-specific credentials or tokens may still be required.\n\nSend email, password and databaseName in the JSON body. Retain all Set-Cookie responses in a cookie jar. A successful response contains a message, not an APIEntityResponse or bearer token. Login is limited to five attempts per 30 seconds per client IP; HTTP 429 indicates throttling. Login failures are returned as HTTP 403 by the response pipeline.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebApiUser_WebApiLogin_A76F2E00D758", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.LoginInput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.LoginInput" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.LoginInput" } } } }, "responses": { "200": { "description": "OK" }, "429": { "description": "Login rate limit exceeded. Wait before retrying." } }, "security": [ ] } }, "/api/Webshop": { "get": { "tags": [ "Webshop" ], "summary": "Webshop: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Webshop-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Webshop_GetAll_4C1A73BE6FEC", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WebshopSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WebshopSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WebshopSetting" } } } } } }, "post": { "tags": [ "Webshop" ], "summary": "Webshop: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Webshop-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Webshop_Post_E59C0AD47840", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopSetting" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopSetting" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopSetting" } } } } } }, "put": { "tags": [ "Webshop" ], "summary": "Webshop: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Webshop-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Webshop_Put_8D003F5A617A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopSetting" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopSetting" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopSetting" } } } } } } }, "/api/Webshop/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "Webshop" ], "summary": "Webshop: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Webshop-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Webshop_GetPageByValue_9A6BFE95AF57", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Webshop/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "Webshop" ], "summary": "Webshop: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Webshop-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Webshop_GetPageByValue2_4B91E2EEFA4E", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Webshop/CarouselArticle/{articleId}/{PartnerId}": { "get": { "tags": [ "Webshop" ], "summary": "Webshop: CarouselArticle", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Webshop-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Webshop_CarouselArticle_BE1C8D156FBC", "parameters": [ { "name": "articleId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PartnerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dto.ArticleCarouselDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dto.ArticleCarouselDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dto.ArticleCarouselDto" } } } } } } }, "/api/Webshop/DeleteByFilter": { "post": { "tags": [ "Webshop" ], "summary": "Webshop: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Webshop-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Webshop_DeleteByFilter_6FC8A6B9B142", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/Webshop/GetAllByValue": { "post": { "tags": [ "Webshop" ], "summary": "Webshop: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Webshop-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Webshop_GetAllByValue_622A6759DC21", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WebshopSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WebshopSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WebshopSetting" } } } } } } }, "/api/Webshop/GetAllGraphByValue": { "post": { "tags": [ "Webshop" ], "summary": "Webshop: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Webshop-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Webshop_GetAllGraphByValue_CFD6CF23A121", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WebshopSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WebshopSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WebshopSetting" } } } } } } }, "/api/Webshop/GetArticles": { "get": { "tags": [ "Webshop" ], "summary": "Webshop: GetArticles", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Webshop-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Webshop_GetArticles_284594F2FBF6", "parameters": [ { "name": "categoryId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "searchQuery", "in": "query", "schema": { "type": "string" } }, { "name": "PartnerId", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Dto.ArticleCarouselDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Dto.ArticleCarouselDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Dto.ArticleCarouselDto" } } } } } } }, "/api/Webshop/GetArticlesOrdered": { "get": { "tags": [ "Webshop" ], "summary": "Webshop: GetArticlesOrdered", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Webshop-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Webshop_GetArticlesOrdered_9B3C2352580E", "parameters": [ { "name": "PartnerId", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dto.ArticleCarouselDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dto.ArticleCarouselDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dto.ArticleCarouselDto" } } } } } } }, "/api/Webshop/GetByValue": { "post": { "tags": [ "Webshop" ], "summary": "Webshop: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Webshop-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Webshop_GetByValue_AB87EFBC92A7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopSetting" } } } } } } }, "/api/Webshop/GetCarouselArticles": { "get": { "tags": [ "Webshop" ], "summary": "Webshop: GetCarouselArticles", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Webshop-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Webshop_GetCarouselArticles_13A4991231D2", "parameters": [ { "name": "categoryId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "searchQuery", "in": "query", "schema": { "type": "string" } }, { "name": "PartnerId", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Dto.ArticleCarouselDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Dto.ArticleCarouselDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Dto.ArticleCarouselDto" } } } } } } }, "/api/Webshop/GetCarouselImages": { "get": { "tags": [ "Webshop" ], "summary": "Webshop: GetCarouselImages", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Webshop-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Webshop_GetCarouselImages_D16E704DABBD", "parameters": [ { "name": "categoryId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "searchQuery", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticlePicture" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticlePicture" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticlePicture" } } } } } } }, "/api/Webshop/GetLookup": { "post": { "tags": [ "Webshop" ], "summary": "Webshop: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Webshop-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Webshop_GetLookup_284F172ECE41", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/Webshop/GetLookupByValue": { "post": { "tags": [ "Webshop" ], "summary": "Webshop: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Webshop-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Webshop_GetLookupByValue_C82EE6ECD93C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/Webshop/GetOtherArticlesSold": { "get": { "tags": [ "Webshop" ], "summary": "Webshop: GetOtherArticlesSold", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Webshop-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Webshop_GetOtherArticlesSold_1EF82B26E886", "parameters": [ { "name": "PartnerId", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dto.ArticleCarouselDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dto.ArticleCarouselDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dto.ArticleCarouselDto" } } } } } } }, "/api/Webshop/Page": { "get": { "tags": [ "Webshop" ], "summary": "Webshop: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Webshop-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Webshop_GetPage_333215CE35F2", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Webshop/PageAsc": { "get": { "tags": [ "Webshop" ], "summary": "Webshop: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Webshop-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Webshop_GetPageAsc_D816A1132D91", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Webshop/SearchByValue": { "post": { "tags": [ "Webshop" ], "summary": "Webshop: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Webshop-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Webshop_SearchByValue_882FE3A80F7E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WebshopSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WebshopSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WebshopSetting" } } } } } } }, "/api/Webshop/TryGetByValue": { "post": { "tags": [ "Webshop" ], "summary": "Webshop: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Webshop-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Webshop_TryGetByValue_18EEC8EE6BB6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopSetting" } } } } } } }, "/api/Webshop/UpsertGraph": { "put": { "tags": [ "Webshop" ], "summary": "Webshop: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Webshop-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Webshop_UpsertGraph_832870ECEA60", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopSetting" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopSetting" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopSetting" } } } } } } }, "/api/Webshop/UpsertGraphWithExtraFields": { "put": { "tags": [ "Webshop" ], "summary": "Webshop: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Webshop-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Webshop_UpsertGraphWithExtraFields_D20BDC352F29", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WebshopSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WebshopSetting" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WebshopSetting" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WebshopSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WebshopSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WebshopSetting" } } } } } } }, "/api/WebshopActivityLog": { "get": { "tags": [ "WebshopActivityLog" ], "summary": "WebshopActivityLog: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopActivityLog-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopActivityLog_GetAll_07C7D354F06A", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WebshopActivityLog" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WebshopActivityLog" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WebshopActivityLog" } } } } } }, "post": { "tags": [ "WebshopActivityLog" ], "summary": "WebshopActivityLog: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopActivityLog-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopActivityLog_Post_6177DC23F376", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopActivityLog" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopActivityLog" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopActivityLog" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopActivityLog" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopActivityLog" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopActivityLog" } } } } } }, "put": { "tags": [ "WebshopActivityLog" ], "summary": "WebshopActivityLog: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopActivityLog-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopActivityLog_Put_EB6EDD69E660", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopActivityLog" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopActivityLog" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopActivityLog" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopActivityLog" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopActivityLog" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopActivityLog" } } } } } } }, "/api/WebshopActivityLog/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "WebshopActivityLog" ], "summary": "WebshopActivityLog: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopActivityLog-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopActivityLog_GetPageByValue_2EF122937978", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WebshopActivityLog/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "WebshopActivityLog" ], "summary": "WebshopActivityLog: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopActivityLog-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopActivityLog_GetPageByValue2_8775E037A0F6", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WebshopActivityLog/DeleteByFilter": { "post": { "tags": [ "WebshopActivityLog" ], "summary": "WebshopActivityLog: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopActivityLog-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopActivityLog_DeleteByFilter_E5759D65C71C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/WebshopActivityLog/GetAllByValue": { "post": { "tags": [ "WebshopActivityLog" ], "summary": "WebshopActivityLog: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopActivityLog-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopActivityLog_GetAllByValue_64590E092D18", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WebshopActivityLog" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WebshopActivityLog" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WebshopActivityLog" } } } } } } }, "/api/WebshopActivityLog/GetAllGraphByValue": { "post": { "tags": [ "WebshopActivityLog" ], "summary": "WebshopActivityLog: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopActivityLog-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopActivityLog_GetAllGraphByValue_C6EA792E24AC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WebshopActivityLog" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WebshopActivityLog" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WebshopActivityLog" } } } } } } }, "/api/WebshopActivityLog/GetByValue": { "post": { "tags": [ "WebshopActivityLog" ], "summary": "WebshopActivityLog: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopActivityLog-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopActivityLog_GetByValue_D883FB3C09AE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopActivityLog" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopActivityLog" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopActivityLog" } } } } } } }, "/api/WebshopActivityLog/GetLookup": { "post": { "tags": [ "WebshopActivityLog" ], "summary": "WebshopActivityLog: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopActivityLog-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopActivityLog_GetLookup_BD69D4DE89C1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/WebshopActivityLog/GetLookupByValue": { "post": { "tags": [ "WebshopActivityLog" ], "summary": "WebshopActivityLog: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopActivityLog-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopActivityLog_GetLookupByValue_3EC80E723194", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/WebshopActivityLog/Page": { "get": { "tags": [ "WebshopActivityLog" ], "summary": "WebshopActivityLog: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopActivityLog-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopActivityLog_GetPage_D300A2D2E63E", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WebshopActivityLog/PageAsc": { "get": { "tags": [ "WebshopActivityLog" ], "summary": "WebshopActivityLog: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopActivityLog-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopActivityLog_GetPageAsc_069FB2630B3E", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WebshopActivityLog/SearchByValue": { "post": { "tags": [ "WebshopActivityLog" ], "summary": "WebshopActivityLog: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopActivityLog-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopActivityLog_SearchByValue_F5FF2CA83BE9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WebshopActivityLog" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WebshopActivityLog" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WebshopActivityLog" } } } } } } }, "/api/WebshopActivityLog/TryGetByValue": { "post": { "tags": [ "WebshopActivityLog" ], "summary": "WebshopActivityLog: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopActivityLog-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopActivityLog_TryGetByValue_84754AE06BAB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopActivityLog" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopActivityLog" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopActivityLog" } } } } } } }, "/api/WebshopActivityLog/UpsertGraph": { "put": { "tags": [ "WebshopActivityLog" ], "summary": "WebshopActivityLog: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopActivityLog-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopActivityLog_UpsertGraph_DF432DD26B13", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopActivityLog" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopActivityLog" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopActivityLog" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopActivityLog" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopActivityLog" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopActivityLog" } } } } } } }, "/api/WebshopActivityLog/UpsertGraphWithExtraFields": { "put": { "tags": [ "WebshopActivityLog" ], "summary": "WebshopActivityLog: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopActivityLog-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopActivityLog_UpsertGraphWithExtraFields_8D7CD8F457C3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WebshopActivityLog" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WebshopActivityLog" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WebshopActivityLog" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WebshopActivityLog" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WebshopActivityLog" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WebshopActivityLog" } } } } } } }, "/api/WebshopCss": { "get": { "tags": [ "WebshopCss" ], "summary": "WebshopCss: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopCss-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopCss_GetAll_88F7AE44712B", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WebshopCss" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WebshopCss" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WebshopCss" } } } } } }, "post": { "tags": [ "WebshopCss" ], "summary": "WebshopCss: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopCss-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopCss_Post_5B2B3496E1B9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopCss" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopCss" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopCss" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopCss" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopCss" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopCss" } } } } } }, "put": { "tags": [ "WebshopCss" ], "summary": "WebshopCss: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopCss-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopCss_Put_8C071E4AFB40", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopCss" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopCss" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopCss" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopCss" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopCss" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopCss" } } } } } } }, "/api/WebshopCss/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "WebshopCss" ], "summary": "WebshopCss: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopCss-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopCss_GetPageByValue_E6B18773F0F8", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WebshopCss/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "WebshopCss" ], "summary": "WebshopCss: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopCss-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopCss_GetPageByValue2_D42D4162A68E", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WebshopCss/DeleteByFilter": { "post": { "tags": [ "WebshopCss" ], "summary": "WebshopCss: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopCss-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopCss_DeleteByFilter_AF55FDE03A2C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/WebshopCss/GetAllByValue": { "post": { "tags": [ "WebshopCss" ], "summary": "WebshopCss: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopCss-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopCss_GetAllByValue_3C9C63A784D7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WebshopCss" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WebshopCss" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WebshopCss" } } } } } } }, "/api/WebshopCss/GetAllGraphByValue": { "post": { "tags": [ "WebshopCss" ], "summary": "WebshopCss: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopCss-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopCss_GetAllGraphByValue_43B2EFCE5604", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WebshopCss" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WebshopCss" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WebshopCss" } } } } } } }, "/api/WebshopCss/GetByValue": { "post": { "tags": [ "WebshopCss" ], "summary": "WebshopCss: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopCss-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopCss_GetByValue_056A879F7A08", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopCss" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopCss" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopCss" } } } } } } }, "/api/WebshopCss/GetLookup": { "post": { "tags": [ "WebshopCss" ], "summary": "WebshopCss: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopCss-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopCss_GetLookup_791B0B2DCDE1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/WebshopCss/GetLookupByValue": { "post": { "tags": [ "WebshopCss" ], "summary": "WebshopCss: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopCss-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopCss_GetLookupByValue_6844EE7BD861", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/WebshopCss/Page": { "get": { "tags": [ "WebshopCss" ], "summary": "WebshopCss: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopCss-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopCss_GetPage_9B93EDBE890D", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WebshopCss/PageAsc": { "get": { "tags": [ "WebshopCss" ], "summary": "WebshopCss: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopCss-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopCss_GetPageAsc_BBD7EBFF106A", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WebshopCss/SearchByValue": { "post": { "tags": [ "WebshopCss" ], "summary": "WebshopCss: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopCss-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopCss_SearchByValue_A06449D796A7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WebshopCss" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WebshopCss" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WebshopCss" } } } } } } }, "/api/WebshopCss/TryGetByValue": { "post": { "tags": [ "WebshopCss" ], "summary": "WebshopCss: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopCss-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopCss_TryGetByValue_A5A6C4425802", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopCss" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopCss" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopCss" } } } } } } }, "/api/WebshopCss/UpsertGraph": { "put": { "tags": [ "WebshopCss" ], "summary": "WebshopCss: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopCss-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopCss_UpsertGraph_AB14302CD087", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopCss" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopCss" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopCss" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopCss" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopCss" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopCss" } } } } } } }, "/api/WebshopCss/UpsertGraphWithExtraFields": { "put": { "tags": [ "WebshopCss" ], "summary": "WebshopCss: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopCss-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopCss_UpsertGraphWithExtraFields_E7E1BF27D9B1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WebshopCss" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WebshopCss" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WebshopCss" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WebshopCss" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WebshopCss" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WebshopCss" } } } } } } }, "/api/WebshopIcon": { "get": { "tags": [ "WebshopIcon" ], "summary": "WebshopIcon: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopIcon-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopIcon_GetAll_822F7C3114CF", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WebshopIcon" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WebshopIcon" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WebshopIcon" } } } } } }, "post": { "tags": [ "WebshopIcon" ], "summary": "WebshopIcon: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopIcon-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopIcon_Post_C9C0066290BB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopIcon" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopIcon" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopIcon" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopIcon" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopIcon" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopIcon" } } } } } }, "put": { "tags": [ "WebshopIcon" ], "summary": "WebshopIcon: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopIcon-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopIcon_Put_537F28C7C6AF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopIcon" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopIcon" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopIcon" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopIcon" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopIcon" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopIcon" } } } } } } }, "/api/WebshopIcon/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "WebshopIcon" ], "summary": "WebshopIcon: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopIcon-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopIcon_GetPageByValue_CFBA9F6CAD1A", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WebshopIcon/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "WebshopIcon" ], "summary": "WebshopIcon: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopIcon-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopIcon_GetPageByValue2_0F8B5820D1DD", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WebshopIcon/DeleteByFilter": { "post": { "tags": [ "WebshopIcon" ], "summary": "WebshopIcon: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopIcon-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopIcon_DeleteByFilter_390286CA75B1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/WebshopIcon/GetAllByValue": { "post": { "tags": [ "WebshopIcon" ], "summary": "WebshopIcon: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopIcon-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopIcon_GetAllByValue_E1328890EF28", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WebshopIcon" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WebshopIcon" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WebshopIcon" } } } } } } }, "/api/WebshopIcon/GetAllGraphByValue": { "post": { "tags": [ "WebshopIcon" ], "summary": "WebshopIcon: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopIcon-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopIcon_GetAllGraphByValue_AB6FF2176E9E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WebshopIcon" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WebshopIcon" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WebshopIcon" } } } } } } }, "/api/WebshopIcon/GetByValue": { "post": { "tags": [ "WebshopIcon" ], "summary": "WebshopIcon: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopIcon-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopIcon_GetByValue_59DE25B2D6CA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopIcon" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopIcon" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopIcon" } } } } } } }, "/api/WebshopIcon/GetLookup": { "post": { "tags": [ "WebshopIcon" ], "summary": "WebshopIcon: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopIcon-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopIcon_GetLookup_48B86B4E148C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/WebshopIcon/GetLookupByValue": { "post": { "tags": [ "WebshopIcon" ], "summary": "WebshopIcon: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopIcon-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopIcon_GetLookupByValue_3DE74B20F92D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/WebshopIcon/Page": { "get": { "tags": [ "WebshopIcon" ], "summary": "WebshopIcon: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopIcon-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopIcon_GetPage_B850E4B2286A", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WebshopIcon/PageAsc": { "get": { "tags": [ "WebshopIcon" ], "summary": "WebshopIcon: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopIcon-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopIcon_GetPageAsc_5AEFA46231AC", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WebshopIcon/SearchByValue": { "post": { "tags": [ "WebshopIcon" ], "summary": "WebshopIcon: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopIcon-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopIcon_SearchByValue_E14FF6A4E930", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WebshopIcon" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WebshopIcon" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WebshopIcon" } } } } } } }, "/api/WebshopIcon/TryGetByValue": { "post": { "tags": [ "WebshopIcon" ], "summary": "WebshopIcon: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopIcon-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopIcon_TryGetByValue_E4B665845EE4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopIcon" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopIcon" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopIcon" } } } } } } }, "/api/WebshopIcon/UpsertGraph": { "put": { "tags": [ "WebshopIcon" ], "summary": "WebshopIcon: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopIcon-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopIcon_UpsertGraph_3E7B061542F6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopIcon" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopIcon" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopIcon" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopIcon" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopIcon" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopIcon" } } } } } } }, "/api/WebshopIcon/UpsertGraphWithExtraFields": { "put": { "tags": [ "WebshopIcon" ], "summary": "WebshopIcon: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopIcon-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopIcon_UpsertGraphWithExtraFields_717EF53F62C2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WebshopIcon" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WebshopIcon" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WebshopIcon" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WebshopIcon" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WebshopIcon" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WebshopIcon" } } } } } } }, "/api/WebshopSetting": { "get": { "tags": [ "WebshopSetting" ], "summary": "WebshopSetting: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopSetting_GetAll_7E7F16A40E6B", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WebshopSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WebshopSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WebshopSetting" } } } } } }, "post": { "tags": [ "WebshopSetting" ], "summary": "WebshopSetting: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopSetting-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopSetting_Post_1D1DD7F63918", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopSetting" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopSetting" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopSetting" } } } } } }, "put": { "tags": [ "WebshopSetting" ], "summary": "WebshopSetting: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopSetting-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopSetting_Put_6C33D0C50FAF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopSetting" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopSetting" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopSetting" } } } } } } }, "/api/WebshopSetting/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "WebshopSetting" ], "summary": "WebshopSetting: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopSetting_GetPageByValue_443121992E4D", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WebshopSetting/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "WebshopSetting" ], "summary": "WebshopSetting: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopSetting_GetPageByValue2_C1BD6CE00521", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WebshopSetting/DeleteByFilter": { "post": { "tags": [ "WebshopSetting" ], "summary": "WebshopSetting: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopSetting-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopSetting_DeleteByFilter_7832D42DFD8A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/WebshopSetting/GetAllByValue": { "post": { "tags": [ "WebshopSetting" ], "summary": "WebshopSetting: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopSetting_GetAllByValue_4BF0B0F423B0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WebshopSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WebshopSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WebshopSetting" } } } } } } }, "/api/WebshopSetting/GetAllGraphByValue": { "post": { "tags": [ "WebshopSetting" ], "summary": "WebshopSetting: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopSetting_GetAllGraphByValue_AE26EB193871", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WebshopSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WebshopSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WebshopSetting" } } } } } } }, "/api/WebshopSetting/GetByValue": { "post": { "tags": [ "WebshopSetting" ], "summary": "WebshopSetting: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopSetting_GetByValue_CA6D6C60782A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopSetting" } } } } } } }, "/api/WebshopSetting/GetLookup": { "post": { "tags": [ "WebshopSetting" ], "summary": "WebshopSetting: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopSetting_GetLookup_72B1005AD091", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/WebshopSetting/GetLookupByValue": { "post": { "tags": [ "WebshopSetting" ], "summary": "WebshopSetting: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopSetting_GetLookupByValue_1C8DB6FC6EC6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/WebshopSetting/Page": { "get": { "tags": [ "WebshopSetting" ], "summary": "WebshopSetting: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopSetting_GetPage_09A36F6D6906", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WebshopSetting/PageAsc": { "get": { "tags": [ "WebshopSetting" ], "summary": "WebshopSetting: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopSetting_GetPageAsc_4C593EBB8302", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WebshopSetting/SearchByValue": { "post": { "tags": [ "WebshopSetting" ], "summary": "WebshopSetting: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopSetting_SearchByValue_2CFB3B929947", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WebshopSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WebshopSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WebshopSetting" } } } } } } }, "/api/WebshopSetting/TryGetByValue": { "post": { "tags": [ "WebshopSetting" ], "summary": "WebshopSetting: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopSetting_TryGetByValue_29D31795B089", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopSetting" } } } } } } }, "/api/WebshopSetting/UpsertGraph": { "put": { "tags": [ "WebshopSetting" ], "summary": "WebshopSetting: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopSetting-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopSetting_UpsertGraph_5163A5DE3370", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopSetting" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopSetting" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopSetting" } } } } } } }, "/api/WebshopSetting/UpsertGraphWithExtraFields": { "put": { "tags": [ "WebshopSetting" ], "summary": "WebshopSetting: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopSetting-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopSetting_UpsertGraphWithExtraFields_0DD2A9D2C6C8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WebshopSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WebshopSetting" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WebshopSetting" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WebshopSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WebshopSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WebshopSetting" } } } } } } }, "/api/WebshopUserCart": { "get": { "tags": [ "WebshopUserCart" ], "summary": "WebshopUserCart: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopUserCart-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopUserCart_GetAll_C03B649E3A33", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WebshopUserCart" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WebshopUserCart" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WebshopUserCart" } } } } } }, "post": { "tags": [ "WebshopUserCart" ], "summary": "WebshopUserCart: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopUserCart-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopUserCart_Post_FF61A0FD5160", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopUserCart" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopUserCart" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopUserCart" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopUserCart" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopUserCart" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopUserCart" } } } } } }, "put": { "tags": [ "WebshopUserCart" ], "summary": "WebshopUserCart: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopUserCart-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopUserCart_Put_5328B7F61C95", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopUserCart" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopUserCart" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopUserCart" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopUserCart" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopUserCart" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopUserCart" } } } } } } }, "/api/WebshopUserCart/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "WebshopUserCart" ], "summary": "WebshopUserCart: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopUserCart-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopUserCart_GetPageByValue_92F8978C4F98", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WebshopUserCart/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "WebshopUserCart" ], "summary": "WebshopUserCart: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopUserCart-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopUserCart_GetPageByValue2_2FEBE0499346", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WebshopUserCart/AddToCart": { "post": { "tags": [ "WebshopUserCart" ], "summary": "WebshopUserCart: AddToCart", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopUserCart-Create.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopUserCart_AddToCart_B02840CAE0D5", "parameters": [ { "name": "partnerId", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AddToCartDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AddToCartDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.AddToCartDto" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AddToCartDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AddToCartDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AddToCartDto" } } } } } } }, "/api/WebshopUserCart/ClearCart": { "post": { "tags": [ "WebshopUserCart" ], "summary": "WebshopUserCart: ClearCart", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopUserCart-Create.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopUserCart_ClearCart_5596FAD38252", "parameters": [ { "name": "partnerId", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/WebshopUserCart/DeleteByFilter": { "post": { "tags": [ "WebshopUserCart" ], "summary": "WebshopUserCart: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopUserCart-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopUserCart_DeleteByFilter_3FDDE4A13D69", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/WebshopUserCart/GetAllByValue": { "post": { "tags": [ "WebshopUserCart" ], "summary": "WebshopUserCart: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopUserCart-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopUserCart_GetAllByValue_12CA5E3EDEEA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WebshopUserCart" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WebshopUserCart" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WebshopUserCart" } } } } } } }, "/api/WebshopUserCart/GetAllGraphByValue": { "post": { "tags": [ "WebshopUserCart" ], "summary": "WebshopUserCart: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopUserCart-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopUserCart_GetAllGraphByValue_827B0E302140", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WebshopUserCart" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WebshopUserCart" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WebshopUserCart" } } } } } } }, "/api/WebshopUserCart/GetByValue": { "post": { "tags": [ "WebshopUserCart" ], "summary": "WebshopUserCart: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopUserCart-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopUserCart_GetByValue_28F4A231BB54", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopUserCart" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopUserCart" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopUserCart" } } } } } } }, "/api/WebshopUserCart/GetCarouselArticles": { "get": { "tags": [ "WebshopUserCart" ], "summary": "WebshopUserCart: GetCarouselArticles", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopUserCart-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopUserCart_GetCarouselArticles_007022C1EFCA", "parameters": [ { "name": "priceListId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "categoryId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "searchQuery", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Dto.ArticleCarouselDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Dto.ArticleCarouselDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Dto.ArticleCarouselDto" } } } } } } }, "/api/WebshopUserCart/GetCustomerInfo": { "get": { "tags": [ "WebshopUserCart" ], "summary": "WebshopUserCart: GetCustomerInfo", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopUserCart-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopUserCart_GetCustomerInfo_D90508A8CC1C", "parameters": [ { "name": "PartnerId", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dto.PartnerPortalDTO" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dto.PartnerPortalDTO" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dto.PartnerPortalDTO" } } } } } } }, "/api/WebshopUserCart/GetLookup": { "post": { "tags": [ "WebshopUserCart" ], "summary": "WebshopUserCart: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopUserCart-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopUserCart_GetLookup_1823A9B8DC9E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/WebshopUserCart/GetLookupByValue": { "post": { "tags": [ "WebshopUserCart" ], "summary": "WebshopUserCart: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopUserCart-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopUserCart_GetLookupByValue_94EFCA8354F3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/WebshopUserCart/GetPartnerAddress": { "get": { "tags": [ "WebshopUserCart" ], "summary": "WebshopUserCart: GetPartnerAddress", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopUserCart-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopUserCart_GetPartnerAddress_A281C10ECCFD", "parameters": [ { "name": "PartnerId", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.OrderAddressDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.OrderAddressDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.OrderAddressDto" } } } } } } }, "/api/WebshopUserCart/GetPartnerDiscountGroupInfo": { "get": { "tags": [ "WebshopUserCart" ], "summary": "WebshopUserCart: DiscountGroupInfo", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopUserCart-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopUserCart_DiscountGroupInfo_5E92F952A940", "parameters": [ { "name": "ArticleGroupId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "DiscountGroupNameId", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDiscountGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDiscountGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDiscountGroup" } } } } } } }, "/api/WebshopUserCart/GetRatings": { "get": { "tags": [ "WebshopUserCart" ], "summary": "WebshopUserCart: GetRatings", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopUserCart-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopUserCart_GetRatings_CE6C0B9EF9A2", "parameters": [ { "name": "partnerId", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WebshopRating" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WebshopRating" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WebshopRating" } } } } } } }, "/api/WebshopUserCart/GetWebshopUserCart": { "get": { "tags": [ "WebshopUserCart" ], "summary": "WebshopUserCart: GetUserCart", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopUserCart-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopUserCart_GetUserCart_A6E7701FE433", "parameters": [ { "name": "partnerId", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Dto.UserCartDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Dto.UserCartDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Dto.UserCartDto" } } } } } } }, "/api/WebshopUserCart/GiveRating": { "post": { "tags": [ "WebshopUserCart" ], "summary": "WebshopUserCart: GiveRating", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopUserCart-Create.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopUserCart_GiveRating_B698433C3130", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopRating" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopRating" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopRating" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/WebshopUserCart/Page": { "get": { "tags": [ "WebshopUserCart" ], "summary": "WebshopUserCart: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopUserCart-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopUserCart_GetPage_287BE464B707", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WebshopUserCart/PageAsc": { "get": { "tags": [ "WebshopUserCart" ], "summary": "WebshopUserCart: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopUserCart-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopUserCart_GetPageAsc_17282C151EC1", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WebshopUserCart/SearchByValue": { "post": { "tags": [ "WebshopUserCart" ], "summary": "WebshopUserCart: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopUserCart-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopUserCart_SearchByValue_C77D24E0CC44", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WebshopUserCart" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WebshopUserCart" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WebshopUserCart" } } } } } } }, "/api/WebshopUserCart/TryGetByValue": { "post": { "tags": [ "WebshopUserCart" ], "summary": "WebshopUserCart: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopUserCart-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopUserCart_TryGetByValue_C5A3EC14203B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopUserCart" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopUserCart" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopUserCart" } } } } } } }, "/api/WebshopUserCart/UpdateCartItem": { "put": { "tags": [ "WebshopUserCart" ], "summary": "WebshopUserCart: UpdateCartItem", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopUserCart-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopUserCart_UpdateCartItem_AFF7B35A2C87", "parameters": [ { "name": "id", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "quantity", "in": "query", "schema": { "type": "number", "format": "double" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AddToCartDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AddToCartDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AddToCartDto" } } } } } } }, "/api/WebshopUserCart/UpdatePartnerPassword": { "get": { "tags": [ "WebshopUserCart" ], "summary": "WebshopUserCart: UpdatePassword", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopUserCart-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopUserCart_UpdatePassword_A8A71ED766A1", "parameters": [ { "name": "PartnerId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "password", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/WebshopUserCart/UpsertGraph": { "put": { "tags": [ "WebshopUserCart" ], "summary": "WebshopUserCart: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopUserCart-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopUserCart_UpsertGraph_71A08A66AF57", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopUserCart" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopUserCart" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopUserCart" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopUserCart" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopUserCart" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopUserCart" } } } } } } }, "/api/WebshopUserCart/UpsertGraphWithExtraFields": { "put": { "tags": [ "WebshopUserCart" ], "summary": "WebshopUserCart: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopUserCart-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopUserCart_UpsertGraphWithExtraFields_4D7ACD589A52", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WebshopUserCart" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WebshopUserCart" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WebshopUserCart" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WebshopUserCart" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WebshopUserCart" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WebshopUserCart" } } } } } } }, "/api/WebshopUserCart/WebshopPlaceOrder": { "post": { "tags": [ "WebshopUserCart" ], "summary": "WebshopUserCart: WebshopPlaceOrder", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopUserCart-Create.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopUserCart_WebshopPlaceOrder_73401309D46F", "parameters": [ { "name": "partnerId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "employeeId", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.OrderAddressDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.OrderAddressDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.OrderAddressDto" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/WebshopUserCart/WebshopUserCartCount": { "get": { "tags": [ "WebshopUserCart" ], "summary": "WebshopUserCart: WebshopUserCartCount", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WebshopUserCart-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WebshopUserCart_WebshopUserCartCount_F8D2A5408805", "parameters": [ { "name": "partnerId", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Int32" } } } } } } }, "/api/Wiki": { "get": { "tags": [ "Wiki" ], "summary": "Wiki: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Wiki-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Wiki_GetAll_C9073DF89816", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Wiki" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Wiki" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Wiki" } } } } } }, "post": { "tags": [ "Wiki" ], "summary": "Wiki: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Wiki-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Wiki_Post_C38E31D5EC80", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Wiki" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Wiki" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Wiki" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Wiki" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Wiki" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Wiki" } } } } } }, "put": { "tags": [ "Wiki" ], "summary": "Wiki: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Wiki-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Wiki_Put_4F3DAA4A8E88", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Wiki" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Wiki" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Wiki" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Wiki" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Wiki" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Wiki" } } } } } } }, "/api/Wiki/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "Wiki" ], "summary": "Wiki: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Wiki-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Wiki_GetPageByValue_7C002464AD37", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Wiki/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "Wiki" ], "summary": "Wiki: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Wiki-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Wiki_GetPageByValue2_1B76EC79FC41", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Wiki/DeleteByFilter": { "post": { "tags": [ "Wiki" ], "summary": "Wiki: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Wiki-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Wiki_DeleteByFilter_7E2DD785DCA4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/Wiki/GetAllByValue": { "post": { "tags": [ "Wiki" ], "summary": "Wiki: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Wiki-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Wiki_GetAllByValue_99F78DA9A604", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Wiki" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Wiki" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Wiki" } } } } } } }, "/api/Wiki/GetAllGraphByValue": { "post": { "tags": [ "Wiki" ], "summary": "Wiki: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Wiki-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Wiki_GetAllGraphByValue_A7837C14C244", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Wiki" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Wiki" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Wiki" } } } } } } }, "/api/Wiki/GetByValue": { "post": { "tags": [ "Wiki" ], "summary": "Wiki: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Wiki-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Wiki_GetByValue_44DC349C6ABE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Wiki" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Wiki" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Wiki" } } } } } } }, "/api/Wiki/GetLookup": { "post": { "tags": [ "Wiki" ], "summary": "Wiki: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Wiki-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Wiki_GetLookup_9E098C1DCD1E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/Wiki/GetLookupByValue": { "post": { "tags": [ "Wiki" ], "summary": "Wiki: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Wiki-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Wiki_GetLookupByValue_2B54ABBA2963", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/Wiki/Page": { "get": { "tags": [ "Wiki" ], "summary": "Wiki: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Wiki-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Wiki_GetPage_0C8274F2AB1F", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Wiki/PageAsc": { "get": { "tags": [ "Wiki" ], "summary": "Wiki: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Wiki-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Wiki_GetPageAsc_96CE4967DBFD", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Wiki/PageFromView": { "get": { "tags": [ "Wiki" ], "summary": "Wiki: GetPageFromView", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Wiki-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Wiki_GetPageFromView_9C977EDE35F2", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Wiki/SearchByValue": { "post": { "tags": [ "Wiki" ], "summary": "Wiki: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Wiki-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Wiki_SearchByValue_7BD3FA0ABF30", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.Wiki" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.Wiki" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.Wiki" } } } } } } }, "/api/Wiki/TryGetByValue": { "post": { "tags": [ "Wiki" ], "summary": "Wiki: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Wiki-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Wiki_TryGetByValue_A9A8C7F08FBC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Wiki" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Wiki" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Wiki" } } } } } } }, "/api/Wiki/UpsertGraph": { "put": { "tags": [ "Wiki" ], "summary": "Wiki: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Wiki-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Wiki_UpsertGraph_7E45AF2F20BA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Wiki" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Wiki" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Wiki" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Wiki" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Wiki" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Wiki" } } } } } } }, "/api/Wiki/UpsertGraphWithExtraFields": { "put": { "tags": [ "Wiki" ], "summary": "Wiki: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Wiki-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Wiki_UpsertGraphWithExtraFields_FE509278CDF0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Wiki" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Wiki" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Wiki" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Wiki" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Wiki" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Wiki" } } } } } } }, "/api/WikiCategory": { "get": { "tags": [ "WikiCategory" ], "summary": "WikiCategory: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WikiCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WikiCategory_GetAll_0F294BEF6EF0", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WikiCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WikiCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WikiCategory" } } } } } }, "post": { "tags": [ "WikiCategory" ], "summary": "WikiCategory: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WikiCategory-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WikiCategory_Post_AC651D090FD8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WikiCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WikiCategory" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WikiCategory" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WikiCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WikiCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WikiCategory" } } } } } }, "put": { "tags": [ "WikiCategory" ], "summary": "WikiCategory: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WikiCategory-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WikiCategory_Put_8FDE29595B99", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WikiCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WikiCategory" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WikiCategory" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WikiCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WikiCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WikiCategory" } } } } } } }, "/api/WikiCategory/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "WikiCategory" ], "summary": "WikiCategory: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WikiCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WikiCategory_GetPageByValue_2E54D05651D2", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WikiCategory/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "WikiCategory" ], "summary": "WikiCategory: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WikiCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WikiCategory_GetPageByValue2_2670E299192F", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WikiCategory/DeleteByFilter": { "post": { "tags": [ "WikiCategory" ], "summary": "WikiCategory: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WikiCategory-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WikiCategory_DeleteByFilter_3D4391BFB8A8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/WikiCategory/GetAllByValue": { "post": { "tags": [ "WikiCategory" ], "summary": "WikiCategory: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WikiCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WikiCategory_GetAllByValue_190A306BE44A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WikiCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WikiCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WikiCategory" } } } } } } }, "/api/WikiCategory/GetAllGraphByValue": { "post": { "tags": [ "WikiCategory" ], "summary": "WikiCategory: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WikiCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WikiCategory_GetAllGraphByValue_D3D53247147B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WikiCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WikiCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WikiCategory" } } } } } } }, "/api/WikiCategory/GetByValue": { "post": { "tags": [ "WikiCategory" ], "summary": "WikiCategory: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WikiCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WikiCategory_GetByValue_A7C8DCA68118", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WikiCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WikiCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WikiCategory" } } } } } } }, "/api/WikiCategory/GetLookup": { "post": { "tags": [ "WikiCategory" ], "summary": "WikiCategory: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WikiCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WikiCategory_GetLookup_262ADF94B6AE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/WikiCategory/GetLookupByValue": { "post": { "tags": [ "WikiCategory" ], "summary": "WikiCategory: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WikiCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WikiCategory_GetLookupByValue_1970DFCEE4B2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/WikiCategory/Page": { "get": { "tags": [ "WikiCategory" ], "summary": "WikiCategory: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WikiCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WikiCategory_GetPage_0E17C97BAF65", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WikiCategory/PageAsc": { "get": { "tags": [ "WikiCategory" ], "summary": "WikiCategory: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WikiCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WikiCategory_GetPageAsc_118E6FAB353B", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WikiCategory/SearchByValue": { "post": { "tags": [ "WikiCategory" ], "summary": "WikiCategory: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WikiCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WikiCategory_SearchByValue_D8F4E323981E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WikiCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WikiCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WikiCategory" } } } } } } }, "/api/WikiCategory/TryGetByValue": { "post": { "tags": [ "WikiCategory" ], "summary": "WikiCategory: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WikiCategory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WikiCategory_TryGetByValue_64197D985F2E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WikiCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WikiCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WikiCategory" } } } } } } }, "/api/WikiCategory/UpsertGraph": { "put": { "tags": [ "WikiCategory" ], "summary": "WikiCategory: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WikiCategory-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WikiCategory_UpsertGraph_105C5A65270F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WikiCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WikiCategory" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WikiCategory" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WikiCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WikiCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WikiCategory" } } } } } } }, "/api/WikiCategory/UpsertGraphWithExtraFields": { "put": { "tags": [ "WikiCategory" ], "summary": "WikiCategory: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WikiCategory-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WikiCategory_UpsertGraphWithExtraFields_2FA448DC4718", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WikiCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WikiCategory" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WikiCategory" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WikiCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WikiCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WikiCategory" } } } } } } }, "/api/WikiStatus": { "get": { "tags": [ "WikiStatus" ], "summary": "WikiStatus: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WikiStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WikiStatus_GetAll_65077D2C93C2", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WikiStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WikiStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WikiStatus" } } } } } }, "post": { "tags": [ "WikiStatus" ], "summary": "WikiStatus: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WikiStatus-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WikiStatus_Post_314BE07E1DAD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WikiStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WikiStatus" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WikiStatus" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WikiStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WikiStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WikiStatus" } } } } } }, "put": { "tags": [ "WikiStatus" ], "summary": "WikiStatus: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WikiStatus-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WikiStatus_Put_461DFA00A1B0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WikiStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WikiStatus" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WikiStatus" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WikiStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WikiStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WikiStatus" } } } } } } }, "/api/WikiStatus/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "WikiStatus" ], "summary": "WikiStatus: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WikiStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WikiStatus_GetPageByValue_DA2876E4C2E1", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WikiStatus/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "WikiStatus" ], "summary": "WikiStatus: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WikiStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WikiStatus_GetPageByValue2_A7918AFA2917", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WikiStatus/DeleteByFilter": { "post": { "tags": [ "WikiStatus" ], "summary": "WikiStatus: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WikiStatus-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WikiStatus_DeleteByFilter_EC26E52B3B48", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/WikiStatus/GetAllByValue": { "post": { "tags": [ "WikiStatus" ], "summary": "WikiStatus: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WikiStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WikiStatus_GetAllByValue_3001E9B7AB16", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WikiStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WikiStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WikiStatus" } } } } } } }, "/api/WikiStatus/GetAllGraphByValue": { "post": { "tags": [ "WikiStatus" ], "summary": "WikiStatus: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WikiStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WikiStatus_GetAllGraphByValue_440443696B05", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WikiStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WikiStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WikiStatus" } } } } } } }, "/api/WikiStatus/GetByValue": { "post": { "tags": [ "WikiStatus" ], "summary": "WikiStatus: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WikiStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WikiStatus_GetByValue_E22464057A45", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WikiStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WikiStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WikiStatus" } } } } } } }, "/api/WikiStatus/GetLookup": { "post": { "tags": [ "WikiStatus" ], "summary": "WikiStatus: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WikiStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WikiStatus_GetLookup_8B5F08B297E0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/WikiStatus/GetLookupByValue": { "post": { "tags": [ "WikiStatus" ], "summary": "WikiStatus: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WikiStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WikiStatus_GetLookupByValue_1DBD70E23241", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/WikiStatus/Page": { "get": { "tags": [ "WikiStatus" ], "summary": "WikiStatus: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WikiStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WikiStatus_GetPage_6A4DC456C231", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WikiStatus/PageAsc": { "get": { "tags": [ "WikiStatus" ], "summary": "WikiStatus: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WikiStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WikiStatus_GetPageAsc_287C21F89BD1", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WikiStatus/SearchByValue": { "post": { "tags": [ "WikiStatus" ], "summary": "WikiStatus: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WikiStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WikiStatus_SearchByValue_12422D32AC94", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WikiStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WikiStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WikiStatus" } } } } } } }, "/api/WikiStatus/TryGetByValue": { "post": { "tags": [ "WikiStatus" ], "summary": "WikiStatus: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WikiStatus-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WikiStatus_TryGetByValue_FD58DD659AFD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WikiStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WikiStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WikiStatus" } } } } } } }, "/api/WikiStatus/UpsertGraph": { "put": { "tags": [ "WikiStatus" ], "summary": "WikiStatus: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WikiStatus-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WikiStatus_UpsertGraph_60944CCE4619", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WikiStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WikiStatus" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WikiStatus" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WikiStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WikiStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WikiStatus" } } } } } } }, "/api/WikiStatus/UpsertGraphWithExtraFields": { "put": { "tags": [ "WikiStatus" ], "summary": "WikiStatus: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WikiStatus-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WikiStatus_UpsertGraphWithExtraFields_C8CA78EC2560", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WikiStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WikiStatus" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WikiStatus" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WikiStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WikiStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WikiStatus" } } } } } } }, "/api/WorkspaceRoleDesktop": { "get": { "tags": [ "WorkspaceRoleDesktop" ], "summary": "WorkspaceRoleDesktop: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceRoleDesktop-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceRoleDesktop_GetAll_C0DE0683F0E7", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WorkspaceRoleDesktop" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WorkspaceRoleDesktop" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WorkspaceRoleDesktop" } } } } } }, "post": { "tags": [ "WorkspaceRoleDesktop" ], "summary": "WorkspaceRoleDesktop: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceRoleDesktop-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceRoleDesktop_Post_B4ACFA260C1A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceRoleDesktop" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceRoleDesktop" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceRoleDesktop" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceRoleDesktop" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceRoleDesktop" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceRoleDesktop" } } } } } }, "put": { "tags": [ "WorkspaceRoleDesktop" ], "summary": "WorkspaceRoleDesktop: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceRoleDesktop-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceRoleDesktop_Put_3AF7FA8AF737", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceRoleDesktop" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceRoleDesktop" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceRoleDesktop" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceRoleDesktop" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceRoleDesktop" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceRoleDesktop" } } } } } } }, "/api/WorkspaceRoleDesktop/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "WorkspaceRoleDesktop" ], "summary": "WorkspaceRoleDesktop: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceRoleDesktop-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceRoleDesktop_GetPageByValue_E2EE3FFFB5DD", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WorkspaceRoleDesktop/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "WorkspaceRoleDesktop" ], "summary": "WorkspaceRoleDesktop: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceRoleDesktop-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceRoleDesktop_GetPageByValue2_EC0A5998E067", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WorkspaceRoleDesktop/DeleteByFilter": { "post": { "tags": [ "WorkspaceRoleDesktop" ], "summary": "WorkspaceRoleDesktop: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceRoleDesktop-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceRoleDesktop_DeleteByFilter_35280138D465", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/WorkspaceRoleDesktop/GetAllByValue": { "post": { "tags": [ "WorkspaceRoleDesktop" ], "summary": "WorkspaceRoleDesktop: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceRoleDesktop-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceRoleDesktop_GetAllByValue_EF2F82935BB8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WorkspaceRoleDesktop" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WorkspaceRoleDesktop" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WorkspaceRoleDesktop" } } } } } } }, "/api/WorkspaceRoleDesktop/GetAllGraphByValue": { "post": { "tags": [ "WorkspaceRoleDesktop" ], "summary": "WorkspaceRoleDesktop: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceRoleDesktop-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceRoleDesktop_GetAllGraphByValue_1649ECE5D5C1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WorkspaceRoleDesktop" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WorkspaceRoleDesktop" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WorkspaceRoleDesktop" } } } } } } }, "/api/WorkspaceRoleDesktop/GetByValue": { "post": { "tags": [ "WorkspaceRoleDesktop" ], "summary": "WorkspaceRoleDesktop: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceRoleDesktop-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceRoleDesktop_GetByValue_7CF49F333B93", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceRoleDesktop" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceRoleDesktop" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceRoleDesktop" } } } } } } }, "/api/WorkspaceRoleDesktop/GetLookup": { "post": { "tags": [ "WorkspaceRoleDesktop" ], "summary": "WorkspaceRoleDesktop: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceRoleDesktop-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceRoleDesktop_GetLookup_537243F1F539", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/WorkspaceRoleDesktop/GetLookupByValue": { "post": { "tags": [ "WorkspaceRoleDesktop" ], "summary": "WorkspaceRoleDesktop: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceRoleDesktop-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceRoleDesktop_GetLookupByValue_8CFCBF5B1679", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/WorkspaceRoleDesktop/Page": { "get": { "tags": [ "WorkspaceRoleDesktop" ], "summary": "WorkspaceRoleDesktop: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceRoleDesktop-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceRoleDesktop_GetPage_1ED19266179A", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WorkspaceRoleDesktop/PageAsc": { "get": { "tags": [ "WorkspaceRoleDesktop" ], "summary": "WorkspaceRoleDesktop: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceRoleDesktop-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceRoleDesktop_GetPageAsc_FC80B584E5BD", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WorkspaceRoleDesktop/SearchByValue": { "post": { "tags": [ "WorkspaceRoleDesktop" ], "summary": "WorkspaceRoleDesktop: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceRoleDesktop-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceRoleDesktop_SearchByValue_67AAE6AD0DAB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WorkspaceRoleDesktop" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WorkspaceRoleDesktop" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WorkspaceRoleDesktop" } } } } } } }, "/api/WorkspaceRoleDesktop/TryGetByValue": { "post": { "tags": [ "WorkspaceRoleDesktop" ], "summary": "WorkspaceRoleDesktop: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceRoleDesktop-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceRoleDesktop_TryGetByValue_29F61E462189", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceRoleDesktop" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceRoleDesktop" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceRoleDesktop" } } } } } } }, "/api/WorkspaceRoleDesktop/UpsertGraph": { "put": { "tags": [ "WorkspaceRoleDesktop" ], "summary": "WorkspaceRoleDesktop: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceRoleDesktop-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceRoleDesktop_UpsertGraph_45B105B7F879", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceRoleDesktop" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceRoleDesktop" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceRoleDesktop" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceRoleDesktop" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceRoleDesktop" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceRoleDesktop" } } } } } } }, "/api/WorkspaceRoleDesktop/UpsertGraphWithExtraFields": { "put": { "tags": [ "WorkspaceRoleDesktop" ], "summary": "WorkspaceRoleDesktop: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceRoleDesktop-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceRoleDesktop_UpsertGraphWithExtraFields_F24102897A42", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WorkspaceRoleDesktop" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WorkspaceRoleDesktop" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WorkspaceRoleDesktop" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WorkspaceRoleDesktop" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WorkspaceRoleDesktop" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WorkspaceRoleDesktop" } } } } } } }, "/api/WorkspaceRoleDesktopButton": { "get": { "tags": [ "WorkspaceRoleDesktopButton" ], "summary": "WorkspaceRoleDesktopButton: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceRoleDesktopButton-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceRoleDesktopButton_GetAll_8BDB79F1A154", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WorkspaceRoleDesktopButton" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WorkspaceRoleDesktopButton" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WorkspaceRoleDesktopButton" } } } } } }, "post": { "tags": [ "WorkspaceRoleDesktopButton" ], "summary": "WorkspaceRoleDesktopButton: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceRoleDesktopButton-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceRoleDesktopButton_Post_CEBEAA773BD8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceRoleDesktopButton" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceRoleDesktopButton" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceRoleDesktopButton" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceRoleDesktopButton" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceRoleDesktopButton" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceRoleDesktopButton" } } } } } }, "put": { "tags": [ "WorkspaceRoleDesktopButton" ], "summary": "WorkspaceRoleDesktopButton: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceRoleDesktopButton-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceRoleDesktopButton_Put_4A277F466D4E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceRoleDesktopButton" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceRoleDesktopButton" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceRoleDesktopButton" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceRoleDesktopButton" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceRoleDesktopButton" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceRoleDesktopButton" } } } } } } }, "/api/WorkspaceRoleDesktopButton/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "WorkspaceRoleDesktopButton" ], "summary": "WorkspaceRoleDesktopButton: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceRoleDesktopButton-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceRoleDesktopButton_GetPageByValue_04EB5C583A30", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WorkspaceRoleDesktopButton/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "WorkspaceRoleDesktopButton" ], "summary": "WorkspaceRoleDesktopButton: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceRoleDesktopButton-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceRoleDesktopButton_GetPageByValue2_F70F90AF6DD1", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WorkspaceRoleDesktopButton/DeleteByFilter": { "post": { "tags": [ "WorkspaceRoleDesktopButton" ], "summary": "WorkspaceRoleDesktopButton: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceRoleDesktopButton-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceRoleDesktopButton_DeleteByFilter_6F268A446AEB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/WorkspaceRoleDesktopButton/GetAllByValue": { "post": { "tags": [ "WorkspaceRoleDesktopButton" ], "summary": "WorkspaceRoleDesktopButton: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceRoleDesktopButton-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceRoleDesktopButton_GetAllByValue_43B865573683", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WorkspaceRoleDesktopButton" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WorkspaceRoleDesktopButton" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WorkspaceRoleDesktopButton" } } } } } } }, "/api/WorkspaceRoleDesktopButton/GetAllGraphByValue": { "post": { "tags": [ "WorkspaceRoleDesktopButton" ], "summary": "WorkspaceRoleDesktopButton: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceRoleDesktopButton-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceRoleDesktopButton_GetAllGraphByValue_221A0DC89326", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WorkspaceRoleDesktopButton" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WorkspaceRoleDesktopButton" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WorkspaceRoleDesktopButton" } } } } } } }, "/api/WorkspaceRoleDesktopButton/GetByValue": { "post": { "tags": [ "WorkspaceRoleDesktopButton" ], "summary": "WorkspaceRoleDesktopButton: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceRoleDesktopButton-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceRoleDesktopButton_GetByValue_DCC48B7A0FE5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceRoleDesktopButton" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceRoleDesktopButton" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceRoleDesktopButton" } } } } } } }, "/api/WorkspaceRoleDesktopButton/GetLookup": { "post": { "tags": [ "WorkspaceRoleDesktopButton" ], "summary": "WorkspaceRoleDesktopButton: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceRoleDesktopButton-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceRoleDesktopButton_GetLookup_F7C605843CE6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/WorkspaceRoleDesktopButton/GetLookupByValue": { "post": { "tags": [ "WorkspaceRoleDesktopButton" ], "summary": "WorkspaceRoleDesktopButton: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceRoleDesktopButton-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceRoleDesktopButton_GetLookupByValue_E738F97E045B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/WorkspaceRoleDesktopButton/Page": { "get": { "tags": [ "WorkspaceRoleDesktopButton" ], "summary": "WorkspaceRoleDesktopButton: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceRoleDesktopButton-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceRoleDesktopButton_GetPage_38C7EA2B835A", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WorkspaceRoleDesktopButton/PageAsc": { "get": { "tags": [ "WorkspaceRoleDesktopButton" ], "summary": "WorkspaceRoleDesktopButton: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceRoleDesktopButton-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceRoleDesktopButton_GetPageAsc_4CB349F89547", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WorkspaceRoleDesktopButton/SearchByValue": { "post": { "tags": [ "WorkspaceRoleDesktopButton" ], "summary": "WorkspaceRoleDesktopButton: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceRoleDesktopButton-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceRoleDesktopButton_SearchByValue_F7D6A2ACFF13", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WorkspaceRoleDesktopButton" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WorkspaceRoleDesktopButton" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WorkspaceRoleDesktopButton" } } } } } } }, "/api/WorkspaceRoleDesktopButton/TryGetByValue": { "post": { "tags": [ "WorkspaceRoleDesktopButton" ], "summary": "WorkspaceRoleDesktopButton: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceRoleDesktopButton-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceRoleDesktopButton_TryGetByValue_D10660228D9D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceRoleDesktopButton" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceRoleDesktopButton" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceRoleDesktopButton" } } } } } } }, "/api/WorkspaceRoleDesktopButton/UpsertGraph": { "put": { "tags": [ "WorkspaceRoleDesktopButton" ], "summary": "WorkspaceRoleDesktopButton: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceRoleDesktopButton-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceRoleDesktopButton_UpsertGraph_A8BF89E8E715", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceRoleDesktopButton" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceRoleDesktopButton" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceRoleDesktopButton" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceRoleDesktopButton" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceRoleDesktopButton" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceRoleDesktopButton" } } } } } } }, "/api/WorkspaceRoleDesktopButton/UpsertGraphWithExtraFields": { "put": { "tags": [ "WorkspaceRoleDesktopButton" ], "summary": "WorkspaceRoleDesktopButton: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceRoleDesktopButton-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceRoleDesktopButton_UpsertGraphWithExtraFields_78846CF9438C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WorkspaceRoleDesktopButton" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WorkspaceRoleDesktopButton" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WorkspaceRoleDesktopButton" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WorkspaceRoleDesktopButton" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WorkspaceRoleDesktopButton" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WorkspaceRoleDesktopButton" } } } } } } }, "/api/WorkspaceRoleMenu": { "get": { "tags": [ "WorkspaceRoleMenu" ], "summary": "WorkspaceRoleMenu: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceRoleMenu-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceRoleMenu_GetAll_78FA1BA48D64", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WorkspaceRoleMenu" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WorkspaceRoleMenu" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WorkspaceRoleMenu" } } } } } }, "post": { "tags": [ "WorkspaceRoleMenu" ], "summary": "WorkspaceRoleMenu: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceRoleMenu-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceRoleMenu_Post_7975E92963D9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceRoleMenu" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceRoleMenu" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceRoleMenu" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceRoleMenu" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceRoleMenu" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceRoleMenu" } } } } } }, "put": { "tags": [ "WorkspaceRoleMenu" ], "summary": "WorkspaceRoleMenu: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceRoleMenu-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceRoleMenu_Put_2EB01E4E8731", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceRoleMenu" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceRoleMenu" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceRoleMenu" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceRoleMenu" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceRoleMenu" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceRoleMenu" } } } } } } }, "/api/WorkspaceRoleMenu/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "WorkspaceRoleMenu" ], "summary": "WorkspaceRoleMenu: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceRoleMenu-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceRoleMenu_GetPageByValue_13844B0E8F29", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WorkspaceRoleMenu/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "WorkspaceRoleMenu" ], "summary": "WorkspaceRoleMenu: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceRoleMenu-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceRoleMenu_GetPageByValue2_ABDD11C42950", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WorkspaceRoleMenu/DeleteByFilter": { "post": { "tags": [ "WorkspaceRoleMenu" ], "summary": "WorkspaceRoleMenu: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceRoleMenu-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceRoleMenu_DeleteByFilter_FBDF81C33BCA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/WorkspaceRoleMenu/GetAllByValue": { "post": { "tags": [ "WorkspaceRoleMenu" ], "summary": "WorkspaceRoleMenu: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceRoleMenu-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceRoleMenu_GetAllByValue_B6AA7CE5ABE0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WorkspaceRoleMenu" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WorkspaceRoleMenu" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WorkspaceRoleMenu" } } } } } } }, "/api/WorkspaceRoleMenu/GetAllGraphByValue": { "post": { "tags": [ "WorkspaceRoleMenu" ], "summary": "WorkspaceRoleMenu: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceRoleMenu-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceRoleMenu_GetAllGraphByValue_C97DDB56F216", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WorkspaceRoleMenu" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WorkspaceRoleMenu" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WorkspaceRoleMenu" } } } } } } }, "/api/WorkspaceRoleMenu/GetByValue": { "post": { "tags": [ "WorkspaceRoleMenu" ], "summary": "WorkspaceRoleMenu: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceRoleMenu-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceRoleMenu_GetByValue_D104B3B98725", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceRoleMenu" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceRoleMenu" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceRoleMenu" } } } } } } }, "/api/WorkspaceRoleMenu/GetLookup": { "post": { "tags": [ "WorkspaceRoleMenu" ], "summary": "WorkspaceRoleMenu: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceRoleMenu-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceRoleMenu_GetLookup_1114AA1636B6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/WorkspaceRoleMenu/GetLookupByValue": { "post": { "tags": [ "WorkspaceRoleMenu" ], "summary": "WorkspaceRoleMenu: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceRoleMenu-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceRoleMenu_GetLookupByValue_CB3943849FE2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/WorkspaceRoleMenu/Page": { "get": { "tags": [ "WorkspaceRoleMenu" ], "summary": "WorkspaceRoleMenu: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceRoleMenu-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceRoleMenu_GetPage_18AE712B4AC9", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WorkspaceRoleMenu/PageAsc": { "get": { "tags": [ "WorkspaceRoleMenu" ], "summary": "WorkspaceRoleMenu: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceRoleMenu-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceRoleMenu_GetPageAsc_9F24FE4D119F", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WorkspaceRoleMenu/SearchByValue": { "post": { "tags": [ "WorkspaceRoleMenu" ], "summary": "WorkspaceRoleMenu: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceRoleMenu-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceRoleMenu_SearchByValue_61A5A2934FB8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WorkspaceRoleMenu" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WorkspaceRoleMenu" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WorkspaceRoleMenu" } } } } } } }, "/api/WorkspaceRoleMenu/TryGetByValue": { "post": { "tags": [ "WorkspaceRoleMenu" ], "summary": "WorkspaceRoleMenu: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceRoleMenu-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceRoleMenu_TryGetByValue_6A802E34133C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceRoleMenu" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceRoleMenu" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceRoleMenu" } } } } } } }, "/api/WorkspaceRoleMenu/UpsertGraph": { "put": { "tags": [ "WorkspaceRoleMenu" ], "summary": "WorkspaceRoleMenu: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceRoleMenu-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceRoleMenu_UpsertGraph_9895121279DD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceRoleMenu" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceRoleMenu" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceRoleMenu" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceRoleMenu" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceRoleMenu" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceRoleMenu" } } } } } } }, "/api/WorkspaceRoleMenu/UpsertGraphWithExtraFields": { "put": { "tags": [ "WorkspaceRoleMenu" ], "summary": "WorkspaceRoleMenu: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceRoleMenu-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceRoleMenu_UpsertGraphWithExtraFields_D22DF99D909D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WorkspaceRoleMenu" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WorkspaceRoleMenu" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WorkspaceRoleMenu" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WorkspaceRoleMenu" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WorkspaceRoleMenu" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WorkspaceRoleMenu" } } } } } } }, "/api/WorkspaceRoleMenuButton": { "get": { "tags": [ "WorkspaceRoleMenuButton" ], "summary": "WorkspaceRoleMenuButton: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceRoleMenuButton-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceRoleMenuButton_GetAll_A9AA965B574F", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WorkspaceRoleMenuButton" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WorkspaceRoleMenuButton" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WorkspaceRoleMenuButton" } } } } } }, "post": { "tags": [ "WorkspaceRoleMenuButton" ], "summary": "WorkspaceRoleMenuButton: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceRoleMenuButton-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceRoleMenuButton_Post_81632A40C1A9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceRoleMenuButton" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceRoleMenuButton" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceRoleMenuButton" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceRoleMenuButton" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceRoleMenuButton" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceRoleMenuButton" } } } } } }, "put": { "tags": [ "WorkspaceRoleMenuButton" ], "summary": "WorkspaceRoleMenuButton: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceRoleMenuButton-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceRoleMenuButton_Put_7BABF9957B84", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceRoleMenuButton" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceRoleMenuButton" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceRoleMenuButton" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceRoleMenuButton" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceRoleMenuButton" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceRoleMenuButton" } } } } } } }, "/api/WorkspaceRoleMenuButton/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "WorkspaceRoleMenuButton" ], "summary": "WorkspaceRoleMenuButton: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceRoleMenuButton-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceRoleMenuButton_GetPageByValue_888A29ED0D08", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WorkspaceRoleMenuButton/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "WorkspaceRoleMenuButton" ], "summary": "WorkspaceRoleMenuButton: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceRoleMenuButton-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceRoleMenuButton_GetPageByValue2_5C901A3593D0", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WorkspaceRoleMenuButton/DeleteByFilter": { "post": { "tags": [ "WorkspaceRoleMenuButton" ], "summary": "WorkspaceRoleMenuButton: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceRoleMenuButton-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceRoleMenuButton_DeleteByFilter_F1341E6038E5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/WorkspaceRoleMenuButton/GetAllByValue": { "post": { "tags": [ "WorkspaceRoleMenuButton" ], "summary": "WorkspaceRoleMenuButton: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceRoleMenuButton-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceRoleMenuButton_GetAllByValue_5C801DF804BE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WorkspaceRoleMenuButton" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WorkspaceRoleMenuButton" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WorkspaceRoleMenuButton" } } } } } } }, "/api/WorkspaceRoleMenuButton/GetAllGraphByValue": { "post": { "tags": [ "WorkspaceRoleMenuButton" ], "summary": "WorkspaceRoleMenuButton: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceRoleMenuButton-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceRoleMenuButton_GetAllGraphByValue_AB2D9E1A0D60", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WorkspaceRoleMenuButton" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WorkspaceRoleMenuButton" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WorkspaceRoleMenuButton" } } } } } } }, "/api/WorkspaceRoleMenuButton/GetByValue": { "post": { "tags": [ "WorkspaceRoleMenuButton" ], "summary": "WorkspaceRoleMenuButton: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceRoleMenuButton-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceRoleMenuButton_GetByValue_7B860C1C440D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceRoleMenuButton" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceRoleMenuButton" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceRoleMenuButton" } } } } } } }, "/api/WorkspaceRoleMenuButton/GetLookup": { "post": { "tags": [ "WorkspaceRoleMenuButton" ], "summary": "WorkspaceRoleMenuButton: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceRoleMenuButton-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceRoleMenuButton_GetLookup_D2A4BA07D16C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/WorkspaceRoleMenuButton/GetLookupByValue": { "post": { "tags": [ "WorkspaceRoleMenuButton" ], "summary": "WorkspaceRoleMenuButton: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceRoleMenuButton-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceRoleMenuButton_GetLookupByValue_9FA555E7CCED", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/WorkspaceRoleMenuButton/Page": { "get": { "tags": [ "WorkspaceRoleMenuButton" ], "summary": "WorkspaceRoleMenuButton: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceRoleMenuButton-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceRoleMenuButton_GetPage_C79587DF1D67", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WorkspaceRoleMenuButton/PageAsc": { "get": { "tags": [ "WorkspaceRoleMenuButton" ], "summary": "WorkspaceRoleMenuButton: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceRoleMenuButton-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceRoleMenuButton_GetPageAsc_87A32DF5A647", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WorkspaceRoleMenuButton/SearchByValue": { "post": { "tags": [ "WorkspaceRoleMenuButton" ], "summary": "WorkspaceRoleMenuButton: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceRoleMenuButton-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceRoleMenuButton_SearchByValue_509F99FA8CFF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WorkspaceRoleMenuButton" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WorkspaceRoleMenuButton" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WorkspaceRoleMenuButton" } } } } } } }, "/api/WorkspaceRoleMenuButton/TryGetByValue": { "post": { "tags": [ "WorkspaceRoleMenuButton" ], "summary": "WorkspaceRoleMenuButton: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceRoleMenuButton-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceRoleMenuButton_TryGetByValue_2864092FD2D4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceRoleMenuButton" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceRoleMenuButton" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceRoleMenuButton" } } } } } } }, "/api/WorkspaceRoleMenuButton/UpsertGraph": { "put": { "tags": [ "WorkspaceRoleMenuButton" ], "summary": "WorkspaceRoleMenuButton: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceRoleMenuButton-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceRoleMenuButton_UpsertGraph_11D059F20825", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceRoleMenuButton" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceRoleMenuButton" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceRoleMenuButton" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceRoleMenuButton" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceRoleMenuButton" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceRoleMenuButton" } } } } } } }, "/api/WorkspaceRoleMenuButton/UpsertGraphWithExtraFields": { "put": { "tags": [ "WorkspaceRoleMenuButton" ], "summary": "WorkspaceRoleMenuButton: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceRoleMenuButton-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceRoleMenuButton_UpsertGraphWithExtraFields_E41584AA3B7A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WorkspaceRoleMenuButton" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WorkspaceRoleMenuButton" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WorkspaceRoleMenuButton" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WorkspaceRoleMenuButton" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WorkspaceRoleMenuButton" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WorkspaceRoleMenuButton" } } } } } } }, "/api/WorkspaceUserColumnSetting": { "get": { "tags": [ "WorkspaceUserColumnSetting" ], "summary": "WorkspaceUserColumnSetting: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceUserColumnSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceUserColumnSetting_GetAll_04463DAA0DEE", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WorkspaceUserColumnSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WorkspaceUserColumnSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WorkspaceUserColumnSetting" } } } } } }, "post": { "tags": [ "WorkspaceUserColumnSetting" ], "summary": "WorkspaceUserColumnSetting: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceUserColumnSetting-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceUserColumnSetting_Post_6D45799E2300", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceUserColumnSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceUserColumnSetting" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceUserColumnSetting" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceUserColumnSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceUserColumnSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceUserColumnSetting" } } } } } }, "put": { "tags": [ "WorkspaceUserColumnSetting" ], "summary": "WorkspaceUserColumnSetting: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceUserColumnSetting-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceUserColumnSetting_Put_963B4BEDC34C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceUserColumnSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceUserColumnSetting" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceUserColumnSetting" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceUserColumnSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceUserColumnSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceUserColumnSetting" } } } } } } }, "/api/WorkspaceUserColumnSetting/{GridKey}/{UserId}/DeleteGridLayout": { "delete": { "tags": [ "WorkspaceUserColumnSetting" ], "summary": "WorkspaceUserColumnSetting: DeleteGridLayout", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceUserColumnSetting-Delete.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceUserColumnSetting_DeleteGridLayout_0CFCEA236DF1", "parameters": [ { "name": "GridKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "UserId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/WorkspaceUserColumnSetting/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "WorkspaceUserColumnSetting" ], "summary": "WorkspaceUserColumnSetting: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceUserColumnSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceUserColumnSetting_GetPageByValue_E9AA9F82478B", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WorkspaceUserColumnSetting/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "WorkspaceUserColumnSetting" ], "summary": "WorkspaceUserColumnSetting: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceUserColumnSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceUserColumnSetting_GetPageByValue2_7A310DF2EB87", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WorkspaceUserColumnSetting/DeleteByFilter": { "post": { "tags": [ "WorkspaceUserColumnSetting" ], "summary": "WorkspaceUserColumnSetting: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceUserColumnSetting-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceUserColumnSetting_DeleteByFilter_1BCBE3AE0A9E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/WorkspaceUserColumnSetting/GetAllByValue": { "post": { "tags": [ "WorkspaceUserColumnSetting" ], "summary": "WorkspaceUserColumnSetting: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceUserColumnSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceUserColumnSetting_GetAllByValue_FCE786FB22DE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WorkspaceUserColumnSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WorkspaceUserColumnSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WorkspaceUserColumnSetting" } } } } } } }, "/api/WorkspaceUserColumnSetting/GetAllGraphByValue": { "post": { "tags": [ "WorkspaceUserColumnSetting" ], "summary": "WorkspaceUserColumnSetting: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceUserColumnSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceUserColumnSetting_GetAllGraphByValue_26BF19FCC02E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WorkspaceUserColumnSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WorkspaceUserColumnSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WorkspaceUserColumnSetting" } } } } } } }, "/api/WorkspaceUserColumnSetting/GetByValue": { "post": { "tags": [ "WorkspaceUserColumnSetting" ], "summary": "WorkspaceUserColumnSetting: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceUserColumnSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceUserColumnSetting_GetByValue_B47A2AFE2593", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceUserColumnSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceUserColumnSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceUserColumnSetting" } } } } } } }, "/api/WorkspaceUserColumnSetting/GetLookup": { "post": { "tags": [ "WorkspaceUserColumnSetting" ], "summary": "WorkspaceUserColumnSetting: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceUserColumnSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceUserColumnSetting_GetLookup_45EFB5331329", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/WorkspaceUserColumnSetting/GetLookupByValue": { "post": { "tags": [ "WorkspaceUserColumnSetting" ], "summary": "WorkspaceUserColumnSetting: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceUserColumnSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceUserColumnSetting_GetLookupByValue_85824310BC02", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/WorkspaceUserColumnSetting/Page": { "get": { "tags": [ "WorkspaceUserColumnSetting" ], "summary": "WorkspaceUserColumnSetting: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceUserColumnSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceUserColumnSetting_GetPage_00F3DA4B4EAA", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WorkspaceUserColumnSetting/PageAsc": { "get": { "tags": [ "WorkspaceUserColumnSetting" ], "summary": "WorkspaceUserColumnSetting: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceUserColumnSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceUserColumnSetting_GetPageAsc_8971B1AF4F44", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WorkspaceUserColumnSetting/SearchByValue": { "post": { "tags": [ "WorkspaceUserColumnSetting" ], "summary": "WorkspaceUserColumnSetting: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceUserColumnSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceUserColumnSetting_SearchByValue_E37EE3DD2DBF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WorkspaceUserColumnSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WorkspaceUserColumnSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WorkspaceUserColumnSetting" } } } } } } }, "/api/WorkspaceUserColumnSetting/TryGetByValue": { "post": { "tags": [ "WorkspaceUserColumnSetting" ], "summary": "WorkspaceUserColumnSetting: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceUserColumnSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceUserColumnSetting_TryGetByValue_083ECCA4B194", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceUserColumnSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceUserColumnSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceUserColumnSetting" } } } } } } }, "/api/WorkspaceUserColumnSetting/UpsertGraph": { "put": { "tags": [ "WorkspaceUserColumnSetting" ], "summary": "WorkspaceUserColumnSetting: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceUserColumnSetting-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceUserColumnSetting_UpsertGraph_45B0972E4018", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceUserColumnSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceUserColumnSetting" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceUserColumnSetting" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceUserColumnSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceUserColumnSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceUserColumnSetting" } } } } } } }, "/api/WorkspaceUserColumnSetting/UpsertGraphWithExtraFields": { "put": { "tags": [ "WorkspaceUserColumnSetting" ], "summary": "WorkspaceUserColumnSetting: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceUserColumnSetting-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceUserColumnSetting_UpsertGraphWithExtraFields_55AF25209B85", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WorkspaceUserColumnSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WorkspaceUserColumnSetting" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WorkspaceUserColumnSetting" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WorkspaceUserColumnSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WorkspaceUserColumnSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WorkspaceUserColumnSetting" } } } } } } }, "/api/WorkspaceUserColumnSetting/UpsertGridLayout": { "put": { "tags": [ "WorkspaceUserColumnSetting" ], "summary": "WorkspaceUserColumnSetting: UpsertGridLayout", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceUserColumnSetting-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceUserColumnSetting_UpsertGridLayout_E82383B3355F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceUserColumnSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceUserColumnSetting" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceUserColumnSetting" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceUserColumnSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceUserColumnSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceUserColumnSetting" } } } } } } }, "/api/WorkspaceUserFieldSetting": { "get": { "tags": [ "WorkspaceUserFieldSetting" ], "summary": "WorkspaceUserFieldSetting: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceUserFieldSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceUserFieldSetting_GetAll_B69D5F7C5D3D", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WorkspaceUserFieldSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WorkspaceUserFieldSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WorkspaceUserFieldSetting" } } } } } }, "post": { "tags": [ "WorkspaceUserFieldSetting" ], "summary": "WorkspaceUserFieldSetting: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceUserFieldSetting-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceUserFieldSetting_Post_4D9FBADC62C3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceUserFieldSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceUserFieldSetting" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceUserFieldSetting" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceUserFieldSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceUserFieldSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceUserFieldSetting" } } } } } }, "put": { "tags": [ "WorkspaceUserFieldSetting" ], "summary": "WorkspaceUserFieldSetting: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceUserFieldSetting-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceUserFieldSetting_Put_483BCEA040B2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceUserFieldSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceUserFieldSetting" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceUserFieldSetting" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceUserFieldSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceUserFieldSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceUserFieldSetting" } } } } } } }, "/api/WorkspaceUserFieldSetting/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "WorkspaceUserFieldSetting" ], "summary": "WorkspaceUserFieldSetting: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceUserFieldSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceUserFieldSetting_GetPageByValue_A3B66B5991E8", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WorkspaceUserFieldSetting/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "WorkspaceUserFieldSetting" ], "summary": "WorkspaceUserFieldSetting: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceUserFieldSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceUserFieldSetting_GetPageByValue2_51C957F913C0", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WorkspaceUserFieldSetting/DeleteByFilter": { "post": { "tags": [ "WorkspaceUserFieldSetting" ], "summary": "WorkspaceUserFieldSetting: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceUserFieldSetting-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceUserFieldSetting_DeleteByFilter_249434DBF967", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/WorkspaceUserFieldSetting/GetAllByValue": { "post": { "tags": [ "WorkspaceUserFieldSetting" ], "summary": "WorkspaceUserFieldSetting: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceUserFieldSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceUserFieldSetting_GetAllByValue_416DE0A5CB5F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WorkspaceUserFieldSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WorkspaceUserFieldSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WorkspaceUserFieldSetting" } } } } } } }, "/api/WorkspaceUserFieldSetting/GetAllGraphByValue": { "post": { "tags": [ "WorkspaceUserFieldSetting" ], "summary": "WorkspaceUserFieldSetting: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceUserFieldSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceUserFieldSetting_GetAllGraphByValue_8E0D47531769", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WorkspaceUserFieldSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WorkspaceUserFieldSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WorkspaceUserFieldSetting" } } } } } } }, "/api/WorkspaceUserFieldSetting/GetByValue": { "post": { "tags": [ "WorkspaceUserFieldSetting" ], "summary": "WorkspaceUserFieldSetting: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceUserFieldSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceUserFieldSetting_GetByValue_57559804A389", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceUserFieldSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceUserFieldSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceUserFieldSetting" } } } } } } }, "/api/WorkspaceUserFieldSetting/GetLookup": { "post": { "tags": [ "WorkspaceUserFieldSetting" ], "summary": "WorkspaceUserFieldSetting: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceUserFieldSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceUserFieldSetting_GetLookup_35462A6D78A9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/WorkspaceUserFieldSetting/GetLookupByValue": { "post": { "tags": [ "WorkspaceUserFieldSetting" ], "summary": "WorkspaceUserFieldSetting: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceUserFieldSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceUserFieldSetting_GetLookupByValue_44EFB3C34710", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/WorkspaceUserFieldSetting/Page": { "get": { "tags": [ "WorkspaceUserFieldSetting" ], "summary": "WorkspaceUserFieldSetting: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceUserFieldSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceUserFieldSetting_GetPage_7DB4B69BE079", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WorkspaceUserFieldSetting/PageAsc": { "get": { "tags": [ "WorkspaceUserFieldSetting" ], "summary": "WorkspaceUserFieldSetting: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceUserFieldSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceUserFieldSetting_GetPageAsc_31F3D2816522", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WorkspaceUserFieldSetting/SearchByValue": { "post": { "tags": [ "WorkspaceUserFieldSetting" ], "summary": "WorkspaceUserFieldSetting: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceUserFieldSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceUserFieldSetting_SearchByValue_0FDACAB3A8C7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WorkspaceUserFieldSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WorkspaceUserFieldSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WorkspaceUserFieldSetting" } } } } } } }, "/api/WorkspaceUserFieldSetting/TryGetByValue": { "post": { "tags": [ "WorkspaceUserFieldSetting" ], "summary": "WorkspaceUserFieldSetting: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceUserFieldSetting-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceUserFieldSetting_TryGetByValue_7DCF57841E25", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceUserFieldSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceUserFieldSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceUserFieldSetting" } } } } } } }, "/api/WorkspaceUserFieldSetting/UpsertGraph": { "put": { "tags": [ "WorkspaceUserFieldSetting" ], "summary": "WorkspaceUserFieldSetting: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceUserFieldSetting-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceUserFieldSetting_UpsertGraph_4A5EC54554D5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceUserFieldSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceUserFieldSetting" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceUserFieldSetting" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceUserFieldSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceUserFieldSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceUserFieldSetting" } } } } } } }, "/api/WorkspaceUserFieldSetting/UpsertGraphWithExtraFields": { "put": { "tags": [ "WorkspaceUserFieldSetting" ], "summary": "WorkspaceUserFieldSetting: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: WorkspaceUserFieldSetting-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "WorkspaceUserFieldSetting_UpsertGraphWithExtraFields_E38600CB82D0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WorkspaceUserFieldSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WorkspaceUserFieldSetting" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WorkspaceUserFieldSetting" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WorkspaceUserFieldSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WorkspaceUserFieldSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WorkspaceUserFieldSetting" } } } } } } }, "/api/xVIEW_Article": { "get": { "tags": [ "xVIEW_Article" ], "summary": "xVIEW_Article: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW_Article-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW_Article_GetAll_D9B63AD1C156", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW_Article" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW_Article" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW_Article" } } } } } }, "post": { "tags": [ "xVIEW_Article" ], "summary": "xVIEW_Article: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW_Article-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW_Article_Post_08E459D28FF4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW_Article" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW_Article" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW_Article" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW_Article" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW_Article" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW_Article" } } } } } }, "put": { "tags": [ "xVIEW_Article" ], "summary": "xVIEW_Article: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW_Article-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW_Article_Put_A2EC680D4D62", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW_Article" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW_Article" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW_Article" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW_Article" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW_Article" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW_Article" } } } } } } }, "/api/xVIEW_Article/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "xVIEW_Article" ], "summary": "xVIEW_Article: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW_Article-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW_Article_GetPageByValue_523F3CCD3230", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW_Article/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "xVIEW_Article" ], "summary": "xVIEW_Article: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW_Article-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW_Article_GetPageByValue2_952797366D2C", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW_Article/DeleteByFilter": { "post": { "tags": [ "xVIEW_Article" ], "summary": "xVIEW_Article: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW_Article-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW_Article_DeleteByFilter_C88736A19FA6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/xVIEW_Article/GetAllByValue": { "post": { "tags": [ "xVIEW_Article" ], "summary": "xVIEW_Article: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW_Article-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW_Article_GetAllByValue_1EC6CBF876DF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW_Article" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW_Article" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW_Article" } } } } } } }, "/api/xVIEW_Article/GetAllGraphByValue": { "post": { "tags": [ "xVIEW_Article" ], "summary": "xVIEW_Article: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW_Article-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW_Article_GetAllGraphByValue_6FD405A7A581", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW_Article" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW_Article" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW_Article" } } } } } } }, "/api/xVIEW_Article/GetByValue": { "post": { "tags": [ "xVIEW_Article" ], "summary": "xVIEW_Article: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW_Article-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW_Article_GetByValue_57E932785037", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW_Article" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW_Article" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW_Article" } } } } } } }, "/api/xVIEW_Article/GetLookup": { "post": { "tags": [ "xVIEW_Article" ], "summary": "xVIEW_Article: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW_Article-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW_Article_GetLookup_E4AE49D3DB35", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/xVIEW_Article/GetLookupByValue": { "post": { "tags": [ "xVIEW_Article" ], "summary": "xVIEW_Article: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW_Article-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW_Article_GetLookupByValue_CF20FBB8C683", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/xVIEW_Article/Page": { "get": { "tags": [ "xVIEW_Article" ], "summary": "xVIEW_Article: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW_Article-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW_Article_GetPage_BC465DBAF749", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW_Article/PageAsc": { "get": { "tags": [ "xVIEW_Article" ], "summary": "xVIEW_Article: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW_Article-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW_Article_GetPageAsc_7D100259D6B6", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW_Article/SearchByValue": { "post": { "tags": [ "xVIEW_Article" ], "summary": "xVIEW_Article: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW_Article-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW_Article_SearchByValue_1712CCD8421A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW_Article" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW_Article" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW_Article" } } } } } } }, "/api/xVIEW_Article/TryGetByValue": { "post": { "tags": [ "xVIEW_Article" ], "summary": "xVIEW_Article: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW_Article-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW_Article_TryGetByValue_7F305FF0A6B6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW_Article" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW_Article" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW_Article" } } } } } } }, "/api/xVIEW_Article/UpsertGraph": { "put": { "tags": [ "xVIEW_Article" ], "summary": "xVIEW_Article: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW_Article-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW_Article_UpsertGraph_7C8D04E9D5D3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW_Article" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW_Article" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW_Article" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW_Article" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW_Article" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW_Article" } } } } } } }, "/api/xVIEW_Article/UpsertGraphWithExtraFields": { "put": { "tags": [ "xVIEW_Article" ], "summary": "xVIEW_Article: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW_Article-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW_Article_UpsertGraphWithExtraFields_A6E667FB4B08", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW_Article" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW_Article" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW_Article" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW_Article" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW_Article" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW_Article" } } } } } } }, "/api/xVIEW_Doc": { "get": { "tags": [ "xVIEW_Doc" ], "summary": "xVIEW_Doc: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW_Doc-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW_Doc_GetAll_A27C5D35D1A9", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW_Doc" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW_Doc" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW_Doc" } } } } } }, "post": { "tags": [ "xVIEW_Doc" ], "summary": "xVIEW_Doc: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW_Doc-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW_Doc_Post_C0E1F81CD25E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW_Doc" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW_Doc" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW_Doc" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW_Doc" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW_Doc" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW_Doc" } } } } } }, "put": { "tags": [ "xVIEW_Doc" ], "summary": "xVIEW_Doc: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW_Doc-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW_Doc_Put_32E79310FEAD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW_Doc" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW_Doc" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW_Doc" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW_Doc" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW_Doc" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW_Doc" } } } } } } }, "/api/xVIEW_Doc/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "xVIEW_Doc" ], "summary": "xVIEW_Doc: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW_Doc-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW_Doc_GetPageByValue_6375FBD78EAB", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW_Doc/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "xVIEW_Doc" ], "summary": "xVIEW_Doc: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW_Doc-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW_Doc_GetPageByValue2_B571F53ED4DD", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW_Doc/DeleteByFilter": { "post": { "tags": [ "xVIEW_Doc" ], "summary": "xVIEW_Doc: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW_Doc-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW_Doc_DeleteByFilter_D316B6815631", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/xVIEW_Doc/GetAllByValue": { "post": { "tags": [ "xVIEW_Doc" ], "summary": "xVIEW_Doc: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW_Doc-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW_Doc_GetAllByValue_26139C8C86E6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW_Doc" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW_Doc" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW_Doc" } } } } } } }, "/api/xVIEW_Doc/GetAllGraphByValue": { "post": { "tags": [ "xVIEW_Doc" ], "summary": "xVIEW_Doc: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW_Doc-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW_Doc_GetAllGraphByValue_DCFF530AC814", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW_Doc" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW_Doc" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW_Doc" } } } } } } }, "/api/xVIEW_Doc/GetByValue": { "post": { "tags": [ "xVIEW_Doc" ], "summary": "xVIEW_Doc: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW_Doc-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW_Doc_GetByValue_60B71858F663", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW_Doc" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW_Doc" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW_Doc" } } } } } } }, "/api/xVIEW_Doc/GetLookup": { "post": { "tags": [ "xVIEW_Doc" ], "summary": "xVIEW_Doc: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW_Doc-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW_Doc_GetLookup_B0566CDA6122", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/xVIEW_Doc/GetLookupByValue": { "post": { "tags": [ "xVIEW_Doc" ], "summary": "xVIEW_Doc: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW_Doc-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW_Doc_GetLookupByValue_AA40CD4DD3DD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/xVIEW_Doc/Page": { "get": { "tags": [ "xVIEW_Doc" ], "summary": "xVIEW_Doc: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW_Doc-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW_Doc_GetPage_7C9AA393606B", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW_Doc/PageAsc": { "get": { "tags": [ "xVIEW_Doc" ], "summary": "xVIEW_Doc: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW_Doc-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW_Doc_GetPageAsc_589D94D6796C", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW_Doc/SearchByValue": { "post": { "tags": [ "xVIEW_Doc" ], "summary": "xVIEW_Doc: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW_Doc-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW_Doc_SearchByValue_95CE017C8364", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW_Doc" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW_Doc" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW_Doc" } } } } } } }, "/api/xVIEW_Doc/TryGetByValue": { "post": { "tags": [ "xVIEW_Doc" ], "summary": "xVIEW_Doc: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW_Doc-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW_Doc_TryGetByValue_6F1136755C38", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW_Doc" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW_Doc" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW_Doc" } } } } } } }, "/api/xVIEW_Doc/UpsertGraph": { "put": { "tags": [ "xVIEW_Doc" ], "summary": "xVIEW_Doc: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW_Doc-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW_Doc_UpsertGraph_53BAAA320C80", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW_Doc" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW_Doc" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW_Doc" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW_Doc" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW_Doc" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW_Doc" } } } } } } }, "/api/xVIEW_Doc/UpsertGraphWithExtraFields": { "put": { "tags": [ "xVIEW_Doc" ], "summary": "xVIEW_Doc: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW_Doc-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW_Doc_UpsertGraphWithExtraFields_12CB95E1ED77", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW_Doc" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW_Doc" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW_Doc" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW_Doc" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW_Doc" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW_Doc" } } } } } } }, "/api/xVIEW_Employee": { "get": { "tags": [ "xVIEW_Employee" ], "summary": "xVIEW_Employee: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW_Employee-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW_Employee_GetAll_FAC3C60ED427", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW_Employee" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW_Employee" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW_Employee" } } } } } }, "post": { "tags": [ "xVIEW_Employee" ], "summary": "xVIEW_Employee: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW_Employee-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW_Employee_Post_87FEF2CC3E89", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW_Employee" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW_Employee" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW_Employee" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW_Employee" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW_Employee" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW_Employee" } } } } } }, "put": { "tags": [ "xVIEW_Employee" ], "summary": "xVIEW_Employee: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW_Employee-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW_Employee_Put_EAA1B15AF404", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW_Employee" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW_Employee" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW_Employee" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW_Employee" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW_Employee" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW_Employee" } } } } } } }, "/api/xVIEW_Employee/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "xVIEW_Employee" ], "summary": "xVIEW_Employee: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW_Employee-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW_Employee_GetPageByValue_206327A1E740", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW_Employee/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "xVIEW_Employee" ], "summary": "xVIEW_Employee: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW_Employee-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW_Employee_GetPageByValue2_CB9E4DC6362B", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW_Employee/DeleteByFilter": { "post": { "tags": [ "xVIEW_Employee" ], "summary": "xVIEW_Employee: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW_Employee-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW_Employee_DeleteByFilter_5E5DA413D2C9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/xVIEW_Employee/GetAllByValue": { "post": { "tags": [ "xVIEW_Employee" ], "summary": "xVIEW_Employee: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW_Employee-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW_Employee_GetAllByValue_26AF86A89330", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW_Employee" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW_Employee" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW_Employee" } } } } } } }, "/api/xVIEW_Employee/GetAllGraphByValue": { "post": { "tags": [ "xVIEW_Employee" ], "summary": "xVIEW_Employee: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW_Employee-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW_Employee_GetAllGraphByValue_A7537E1E6D4F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW_Employee" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW_Employee" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW_Employee" } } } } } } }, "/api/xVIEW_Employee/GetByValue": { "post": { "tags": [ "xVIEW_Employee" ], "summary": "xVIEW_Employee: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW_Employee-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW_Employee_GetByValue_A727CB1D95F4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW_Employee" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW_Employee" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW_Employee" } } } } } } }, "/api/xVIEW_Employee/GetLookup": { "post": { "tags": [ "xVIEW_Employee" ], "summary": "xVIEW_Employee: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW_Employee-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW_Employee_GetLookup_C8B166FC0118", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/xVIEW_Employee/GetLookupByValue": { "post": { "tags": [ "xVIEW_Employee" ], "summary": "xVIEW_Employee: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW_Employee-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW_Employee_GetLookupByValue_6A4D294AC7F4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/xVIEW_Employee/Page": { "get": { "tags": [ "xVIEW_Employee" ], "summary": "xVIEW_Employee: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW_Employee-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW_Employee_GetPage_546DDE7AF8E4", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW_Employee/PageAsc": { "get": { "tags": [ "xVIEW_Employee" ], "summary": "xVIEW_Employee: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW_Employee-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW_Employee_GetPageAsc_CF9F8461ECEB", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW_Employee/SearchByValue": { "post": { "tags": [ "xVIEW_Employee" ], "summary": "xVIEW_Employee: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW_Employee-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW_Employee_SearchByValue_D90AEFA5EB0A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW_Employee" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW_Employee" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW_Employee" } } } } } } }, "/api/xVIEW_Employee/TryGetByValue": { "post": { "tags": [ "xVIEW_Employee" ], "summary": "xVIEW_Employee: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW_Employee-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW_Employee_TryGetByValue_19AA6C68B633", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW_Employee" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW_Employee" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW_Employee" } } } } } } }, "/api/xVIEW_Employee/UpsertGraph": { "put": { "tags": [ "xVIEW_Employee" ], "summary": "xVIEW_Employee: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW_Employee-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW_Employee_UpsertGraph_62DFAF3C21E4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW_Employee" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW_Employee" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW_Employee" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW_Employee" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW_Employee" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW_Employee" } } } } } } }, "/api/xVIEW_Employee/UpsertGraphWithExtraFields": { "put": { "tags": [ "xVIEW_Employee" ], "summary": "xVIEW_Employee: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW_Employee-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW_Employee_UpsertGraphWithExtraFields_FACE66932A73", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW_Employee" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW_Employee" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW_Employee" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW_Employee" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW_Employee" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW_Employee" } } } } } } }, "/api/xVIEW_Partner": { "get": { "tags": [ "xVIEW_Partner" ], "summary": "xVIEW_Partner: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW_Partner-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW_Partner_GetAll_C630400C1ED6", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW_Partner" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW_Partner" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW_Partner" } } } } } }, "post": { "tags": [ "xVIEW_Partner" ], "summary": "xVIEW_Partner: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW_Partner-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW_Partner_Post_A542C2ADE800", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW_Partner" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW_Partner" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW_Partner" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW_Partner" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW_Partner" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW_Partner" } } } } } }, "put": { "tags": [ "xVIEW_Partner" ], "summary": "xVIEW_Partner: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW_Partner-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW_Partner_Put_9C83A9FDA812", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW_Partner" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW_Partner" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW_Partner" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW_Partner" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW_Partner" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW_Partner" } } } } } } }, "/api/xVIEW_Partner/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "xVIEW_Partner" ], "summary": "xVIEW_Partner: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW_Partner-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW_Partner_GetPageByValue_B8F9AD6B9A53", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW_Partner/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "xVIEW_Partner" ], "summary": "xVIEW_Partner: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW_Partner-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW_Partner_GetPageByValue2_C524F0E62DF9", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW_Partner/DeleteByFilter": { "post": { "tags": [ "xVIEW_Partner" ], "summary": "xVIEW_Partner: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW_Partner-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW_Partner_DeleteByFilter_8540A144C1B5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/xVIEW_Partner/GetAllByValue": { "post": { "tags": [ "xVIEW_Partner" ], "summary": "xVIEW_Partner: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW_Partner-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW_Partner_GetAllByValue_F74815280331", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW_Partner" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW_Partner" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW_Partner" } } } } } } }, "/api/xVIEW_Partner/GetAllGraphByValue": { "post": { "tags": [ "xVIEW_Partner" ], "summary": "xVIEW_Partner: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW_Partner-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW_Partner_GetAllGraphByValue_2D2CE50083EC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW_Partner" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW_Partner" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW_Partner" } } } } } } }, "/api/xVIEW_Partner/GetByValue": { "post": { "tags": [ "xVIEW_Partner" ], "summary": "xVIEW_Partner: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW_Partner-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW_Partner_GetByValue_4887FDC66FB5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW_Partner" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW_Partner" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW_Partner" } } } } } } }, "/api/xVIEW_Partner/GetLookup": { "post": { "tags": [ "xVIEW_Partner" ], "summary": "xVIEW_Partner: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW_Partner-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW_Partner_GetLookup_4A38DDB9E415", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/xVIEW_Partner/GetLookupByValue": { "post": { "tags": [ "xVIEW_Partner" ], "summary": "xVIEW_Partner: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW_Partner-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW_Partner_GetLookupByValue_679924AF6CF8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/xVIEW_Partner/Page": { "get": { "tags": [ "xVIEW_Partner" ], "summary": "xVIEW_Partner: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW_Partner-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW_Partner_GetPage_E831F02E638A", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW_Partner/PageAsc": { "get": { "tags": [ "xVIEW_Partner" ], "summary": "xVIEW_Partner: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW_Partner-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW_Partner_GetPageAsc_DD8E4A363D7B", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW_Partner/SearchByValue": { "post": { "tags": [ "xVIEW_Partner" ], "summary": "xVIEW_Partner: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW_Partner-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW_Partner_SearchByValue_0485E85B34C3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW_Partner" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW_Partner" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW_Partner" } } } } } } }, "/api/xVIEW_Partner/TryGetByValue": { "post": { "tags": [ "xVIEW_Partner" ], "summary": "xVIEW_Partner: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW_Partner-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW_Partner_TryGetByValue_FF43E67A79EF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW_Partner" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW_Partner" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW_Partner" } } } } } } }, "/api/xVIEW_Partner/UpsertGraph": { "put": { "tags": [ "xVIEW_Partner" ], "summary": "xVIEW_Partner: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW_Partner-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW_Partner_UpsertGraph_DF338E5152DE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW_Partner" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW_Partner" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW_Partner" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW_Partner" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW_Partner" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW_Partner" } } } } } } }, "/api/xVIEW_Partner/UpsertGraphWithExtraFields": { "put": { "tags": [ "xVIEW_Partner" ], "summary": "xVIEW_Partner: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW_Partner-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW_Partner_UpsertGraphWithExtraFields_7C58DE22EABC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW_Partner" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW_Partner" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW_Partner" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW_Partner" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW_Partner" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW_Partner" } } } } } } }, "/api/xVIEW124_ArticlePositionQuantityOpenSum": { "get": { "tags": [ "xVIEW124_ArticlePositionQuantityOpenSum" ], "summary": "xVIEW124_ArticlePositionQuantityOpenSum: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW124_ArticlePositionQuantityOpenSum-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW124_ArticlePositionQuantityOpenSum_GetAll_F8B2E2F9126D", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW124_ArticlePositionQuantityOpenSum" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW124_ArticlePositionQuantityOpenSum" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW124_ArticlePositionQuantityOpenSum" } } } } } }, "post": { "tags": [ "xVIEW124_ArticlePositionQuantityOpenSum" ], "summary": "xVIEW124_ArticlePositionQuantityOpenSum: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW124_ArticlePositionQuantityOpenSum-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW124_ArticlePositionQuantityOpenSum_Post_6D9DEE21F0F0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW124_ArticlePositionQuantityOpenSum" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW124_ArticlePositionQuantityOpenSum" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW124_ArticlePositionQuantityOpenSum" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW124_ArticlePositionQuantityOpenSum" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW124_ArticlePositionQuantityOpenSum" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW124_ArticlePositionQuantityOpenSum" } } } } } }, "put": { "tags": [ "xVIEW124_ArticlePositionQuantityOpenSum" ], "summary": "xVIEW124_ArticlePositionQuantityOpenSum: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW124_ArticlePositionQuantityOpenSum-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW124_ArticlePositionQuantityOpenSum_Put_79253E5DBCCC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW124_ArticlePositionQuantityOpenSum" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW124_ArticlePositionQuantityOpenSum" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW124_ArticlePositionQuantityOpenSum" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW124_ArticlePositionQuantityOpenSum" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW124_ArticlePositionQuantityOpenSum" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW124_ArticlePositionQuantityOpenSum" } } } } } } }, "/api/xVIEW124_ArticlePositionQuantityOpenSum/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "xVIEW124_ArticlePositionQuantityOpenSum" ], "summary": "xVIEW124_ArticlePositionQuantityOpenSum: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW124_ArticlePositionQuantityOpenSum-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW124_ArticlePositionQuantityOpenSum_GetPageByValue_1DC323F41EC0", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW124_ArticlePositionQuantityOpenSum/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "xVIEW124_ArticlePositionQuantityOpenSum" ], "summary": "xVIEW124_ArticlePositionQuantityOpenSum: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW124_ArticlePositionQuantityOpenSum-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW124_ArticlePositionQuantityOpenSum_GetPageByValue2_2A558DA25F47", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW124_ArticlePositionQuantityOpenSum/DeleteByFilter": { "post": { "tags": [ "xVIEW124_ArticlePositionQuantityOpenSum" ], "summary": "xVIEW124_ArticlePositionQuantityOpenSum: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW124_ArticlePositionQuantityOpenSum-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW124_ArticlePositionQuantityOpenSum_DeleteByFilter_22F002A7E979", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/xVIEW124_ArticlePositionQuantityOpenSum/GetAllByValue": { "post": { "tags": [ "xVIEW124_ArticlePositionQuantityOpenSum" ], "summary": "xVIEW124_ArticlePositionQuantityOpenSum: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW124_ArticlePositionQuantityOpenSum-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW124_ArticlePositionQuantityOpenSum_GetAllByValue_BFAD8E8B092D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW124_ArticlePositionQuantityOpenSum" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW124_ArticlePositionQuantityOpenSum" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW124_ArticlePositionQuantityOpenSum" } } } } } } }, "/api/xVIEW124_ArticlePositionQuantityOpenSum/GetAllGraphByValue": { "post": { "tags": [ "xVIEW124_ArticlePositionQuantityOpenSum" ], "summary": "xVIEW124_ArticlePositionQuantityOpenSum: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW124_ArticlePositionQuantityOpenSum-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW124_ArticlePositionQuantityOpenSum_GetAllGraphByValue_59AAC421B768", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW124_ArticlePositionQuantityOpenSum" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW124_ArticlePositionQuantityOpenSum" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW124_ArticlePositionQuantityOpenSum" } } } } } } }, "/api/xVIEW124_ArticlePositionQuantityOpenSum/GetByValue": { "post": { "tags": [ "xVIEW124_ArticlePositionQuantityOpenSum" ], "summary": "xVIEW124_ArticlePositionQuantityOpenSum: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW124_ArticlePositionQuantityOpenSum-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW124_ArticlePositionQuantityOpenSum_GetByValue_3B44748BC7C0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW124_ArticlePositionQuantityOpenSum" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW124_ArticlePositionQuantityOpenSum" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW124_ArticlePositionQuantityOpenSum" } } } } } } }, "/api/xVIEW124_ArticlePositionQuantityOpenSum/GetFullPage": { "get": { "tags": [ "xVIEW124_ArticlePositionQuantityOpenSum" ], "summary": "xVIEW124_ArticlePositionQuantityOpenSum: GetFullPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW124_ArticlePositionQuantityOpenSum-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW124_ArticlePositionQuantityOpenSum_GetFullPage_0DE1DF058354", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW124_ArticlePositionQuantityOpenSum/GetLookup": { "post": { "tags": [ "xVIEW124_ArticlePositionQuantityOpenSum" ], "summary": "xVIEW124_ArticlePositionQuantityOpenSum: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW124_ArticlePositionQuantityOpenSum-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW124_ArticlePositionQuantityOpenSum_GetLookup_2F2D419E60FB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/xVIEW124_ArticlePositionQuantityOpenSum/GetLookupByValue": { "post": { "tags": [ "xVIEW124_ArticlePositionQuantityOpenSum" ], "summary": "xVIEW124_ArticlePositionQuantityOpenSum: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW124_ArticlePositionQuantityOpenSum-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW124_ArticlePositionQuantityOpenSum_GetLookupByValue_DCF3158A9CCC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/xVIEW124_ArticlePositionQuantityOpenSum/Page": { "get": { "tags": [ "xVIEW124_ArticlePositionQuantityOpenSum" ], "summary": "xVIEW124_ArticlePositionQuantityOpenSum: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW124_ArticlePositionQuantityOpenSum-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW124_ArticlePositionQuantityOpenSum_GetPage_56375932B625", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW124_ArticlePositionQuantityOpenSum/PageAsc": { "get": { "tags": [ "xVIEW124_ArticlePositionQuantityOpenSum" ], "summary": "xVIEW124_ArticlePositionQuantityOpenSum: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW124_ArticlePositionQuantityOpenSum-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW124_ArticlePositionQuantityOpenSum_GetPageAsc_12631B88045C", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW124_ArticlePositionQuantityOpenSum/SearchByValue": { "post": { "tags": [ "xVIEW124_ArticlePositionQuantityOpenSum" ], "summary": "xVIEW124_ArticlePositionQuantityOpenSum: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW124_ArticlePositionQuantityOpenSum-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW124_ArticlePositionQuantityOpenSum_SearchByValue_BB4496B27AB2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW124_ArticlePositionQuantityOpenSum" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW124_ArticlePositionQuantityOpenSum" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW124_ArticlePositionQuantityOpenSum" } } } } } } }, "/api/xVIEW124_ArticlePositionQuantityOpenSum/TryGetByValue": { "post": { "tags": [ "xVIEW124_ArticlePositionQuantityOpenSum" ], "summary": "xVIEW124_ArticlePositionQuantityOpenSum: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW124_ArticlePositionQuantityOpenSum-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW124_ArticlePositionQuantityOpenSum_TryGetByValue_AF2211B772B8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW124_ArticlePositionQuantityOpenSum" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW124_ArticlePositionQuantityOpenSum" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW124_ArticlePositionQuantityOpenSum" } } } } } } }, "/api/xVIEW124_ArticlePositionQuantityOpenSum/UpsertGraph": { "put": { "tags": [ "xVIEW124_ArticlePositionQuantityOpenSum" ], "summary": "xVIEW124_ArticlePositionQuantityOpenSum: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW124_ArticlePositionQuantityOpenSum-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW124_ArticlePositionQuantityOpenSum_UpsertGraph_336CEE585F8C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW124_ArticlePositionQuantityOpenSum" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW124_ArticlePositionQuantityOpenSum" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW124_ArticlePositionQuantityOpenSum" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW124_ArticlePositionQuantityOpenSum" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW124_ArticlePositionQuantityOpenSum" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW124_ArticlePositionQuantityOpenSum" } } } } } } }, "/api/xVIEW124_ArticlePositionQuantityOpenSum/UpsertGraphWithExtraFields": { "put": { "tags": [ "xVIEW124_ArticlePositionQuantityOpenSum" ], "summary": "xVIEW124_ArticlePositionQuantityOpenSum: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW124_ArticlePositionQuantityOpenSum-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW124_ArticlePositionQuantityOpenSum_UpsertGraphWithExtraFields_E8BA6DA1D194", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW124_ArticlePositionQuantityOpenSum" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW124_ArticlePositionQuantityOpenSum" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW124_ArticlePositionQuantityOpenSum" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW124_ArticlePositionQuantityOpenSum" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW124_ArticlePositionQuantityOpenSum" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW124_ArticlePositionQuantityOpenSum" } } } } } } }, "/api/xVIEW124_ArticleProductionPositionQuantityOpenSum": { "get": { "tags": [ "xVIEW124_ArticleProductionPositionQuantityOpenSum" ], "summary": "xVIEW124_ArticleProductionPositionQuantityOpenSum: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW124_ArticleProductionPositionQuantityOpenSum-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW124_ArticleProductionPositionQuantityOpenSum_GetAll_A2AC6797883B", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW124_ArticleProductionPositionQuantityOpenSum" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW124_ArticleProductionPositionQuantityOpenSum" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW124_ArticleProductionPositionQuantityOpenSum" } } } } } }, "post": { "tags": [ "xVIEW124_ArticleProductionPositionQuantityOpenSum" ], "summary": "xVIEW124_ArticleProductionPositionQuantityOpenSum: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW124_ArticleProductionPositionQuantityOpenSum-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW124_ArticleProductionPositionQuantityOpenSum_Post_8D5133A97147", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW124_ArticleProductionPositionQuantityOpenSum" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW124_ArticleProductionPositionQuantityOpenSum" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW124_ArticleProductionPositionQuantityOpenSum" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW124_ArticleProductionPositionQuantityOpenSum" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW124_ArticleProductionPositionQuantityOpenSum" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW124_ArticleProductionPositionQuantityOpenSum" } } } } } }, "put": { "tags": [ "xVIEW124_ArticleProductionPositionQuantityOpenSum" ], "summary": "xVIEW124_ArticleProductionPositionQuantityOpenSum: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW124_ArticleProductionPositionQuantityOpenSum-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW124_ArticleProductionPositionQuantityOpenSum_Put_4563D584C371", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW124_ArticleProductionPositionQuantityOpenSum" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW124_ArticleProductionPositionQuantityOpenSum" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW124_ArticleProductionPositionQuantityOpenSum" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW124_ArticleProductionPositionQuantityOpenSum" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW124_ArticleProductionPositionQuantityOpenSum" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW124_ArticleProductionPositionQuantityOpenSum" } } } } } } }, "/api/xVIEW124_ArticleProductionPositionQuantityOpenSum/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "xVIEW124_ArticleProductionPositionQuantityOpenSum" ], "summary": "xVIEW124_ArticleProductionPositionQuantityOpenSum: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW124_ArticleProductionPositionQuantityOpenSum-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW124_ArticleProductionPositionQuantityOpenSum_GetPageByValue_C73B97B27539", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW124_ArticleProductionPositionQuantityOpenSum/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "xVIEW124_ArticleProductionPositionQuantityOpenSum" ], "summary": "xVIEW124_ArticleProductionPositionQuantityOpenSum: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW124_ArticleProductionPositionQuantityOpenSum-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW124_ArticleProductionPositionQuantityOpenSum_GetPageByValue2_4822F8DBCF25", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW124_ArticleProductionPositionQuantityOpenSum/DeleteByFilter": { "post": { "tags": [ "xVIEW124_ArticleProductionPositionQuantityOpenSum" ], "summary": "xVIEW124_ArticleProductionPositionQuantityOpenSum: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW124_ArticleProductionPositionQuantityOpenSum-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW124_ArticleProductionPositionQuantityOpenSum_DeleteByFilter_E1C1D053B66F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/xVIEW124_ArticleProductionPositionQuantityOpenSum/GetAllByValue": { "post": { "tags": [ "xVIEW124_ArticleProductionPositionQuantityOpenSum" ], "summary": "xVIEW124_ArticleProductionPositionQuantityOpenSum: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW124_ArticleProductionPositionQuantityOpenSum-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW124_ArticleProductionPositionQuantityOpenSum_GetAllByValue_A651DE40261B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW124_ArticleProductionPositionQuantityOpenSum" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW124_ArticleProductionPositionQuantityOpenSum" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW124_ArticleProductionPositionQuantityOpenSum" } } } } } } }, "/api/xVIEW124_ArticleProductionPositionQuantityOpenSum/GetAllGraphByValue": { "post": { "tags": [ "xVIEW124_ArticleProductionPositionQuantityOpenSum" ], "summary": "xVIEW124_ArticleProductionPositionQuantityOpenSum: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW124_ArticleProductionPositionQuantityOpenSum-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW124_ArticleProductionPositionQuantityOpenSum_GetAllGraphByValue_11B7826AF6A8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW124_ArticleProductionPositionQuantityOpenSum" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW124_ArticleProductionPositionQuantityOpenSum" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW124_ArticleProductionPositionQuantityOpenSum" } } } } } } }, "/api/xVIEW124_ArticleProductionPositionQuantityOpenSum/GetByValue": { "post": { "tags": [ "xVIEW124_ArticleProductionPositionQuantityOpenSum" ], "summary": "xVIEW124_ArticleProductionPositionQuantityOpenSum: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW124_ArticleProductionPositionQuantityOpenSum-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW124_ArticleProductionPositionQuantityOpenSum_GetByValue_CE0BD3A47B50", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW124_ArticleProductionPositionQuantityOpenSum" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW124_ArticleProductionPositionQuantityOpenSum" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW124_ArticleProductionPositionQuantityOpenSum" } } } } } } }, "/api/xVIEW124_ArticleProductionPositionQuantityOpenSum/GetFullPage": { "get": { "tags": [ "xVIEW124_ArticleProductionPositionQuantityOpenSum" ], "summary": "xVIEW124_ArticleProductionPositionQuantityOpenSum: GetFullPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW124_ArticleProductionPositionQuantityOpenSum-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW124_ArticleProductionPositionQuantityOpenSum_GetFullPage_ABFBE5693214", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW124_ArticleProductionPositionQuantityOpenSum/GetLookup": { "post": { "tags": [ "xVIEW124_ArticleProductionPositionQuantityOpenSum" ], "summary": "xVIEW124_ArticleProductionPositionQuantityOpenSum: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW124_ArticleProductionPositionQuantityOpenSum-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW124_ArticleProductionPositionQuantityOpenSum_GetLookup_D57D61882908", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/xVIEW124_ArticleProductionPositionQuantityOpenSum/GetLookupByValue": { "post": { "tags": [ "xVIEW124_ArticleProductionPositionQuantityOpenSum" ], "summary": "xVIEW124_ArticleProductionPositionQuantityOpenSum: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW124_ArticleProductionPositionQuantityOpenSum-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW124_ArticleProductionPositionQuantityOpenSum_GetLookupByValue_C41E2EFB7A73", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/xVIEW124_ArticleProductionPositionQuantityOpenSum/Page": { "get": { "tags": [ "xVIEW124_ArticleProductionPositionQuantityOpenSum" ], "summary": "xVIEW124_ArticleProductionPositionQuantityOpenSum: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW124_ArticleProductionPositionQuantityOpenSum-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW124_ArticleProductionPositionQuantityOpenSum_GetPage_26CF55D12DF4", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW124_ArticleProductionPositionQuantityOpenSum/PageAsc": { "get": { "tags": [ "xVIEW124_ArticleProductionPositionQuantityOpenSum" ], "summary": "xVIEW124_ArticleProductionPositionQuantityOpenSum: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW124_ArticleProductionPositionQuantityOpenSum-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW124_ArticleProductionPositionQuantityOpenSum_GetPageAsc_B7FD3A36C274", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW124_ArticleProductionPositionQuantityOpenSum/SearchByValue": { "post": { "tags": [ "xVIEW124_ArticleProductionPositionQuantityOpenSum" ], "summary": "xVIEW124_ArticleProductionPositionQuantityOpenSum: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW124_ArticleProductionPositionQuantityOpenSum-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW124_ArticleProductionPositionQuantityOpenSum_SearchByValue_9F6B2D6A701E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW124_ArticleProductionPositionQuantityOpenSum" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW124_ArticleProductionPositionQuantityOpenSum" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW124_ArticleProductionPositionQuantityOpenSum" } } } } } } }, "/api/xVIEW124_ArticleProductionPositionQuantityOpenSum/TryGetByValue": { "post": { "tags": [ "xVIEW124_ArticleProductionPositionQuantityOpenSum" ], "summary": "xVIEW124_ArticleProductionPositionQuantityOpenSum: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW124_ArticleProductionPositionQuantityOpenSum-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW124_ArticleProductionPositionQuantityOpenSum_TryGetByValue_92F6C9892272", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW124_ArticleProductionPositionQuantityOpenSum" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW124_ArticleProductionPositionQuantityOpenSum" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW124_ArticleProductionPositionQuantityOpenSum" } } } } } } }, "/api/xVIEW124_ArticleProductionPositionQuantityOpenSum/UpsertGraph": { "put": { "tags": [ "xVIEW124_ArticleProductionPositionQuantityOpenSum" ], "summary": "xVIEW124_ArticleProductionPositionQuantityOpenSum: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW124_ArticleProductionPositionQuantityOpenSum-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW124_ArticleProductionPositionQuantityOpenSum_UpsertGraph_B5BDBF94EF9D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW124_ArticleProductionPositionQuantityOpenSum" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW124_ArticleProductionPositionQuantityOpenSum" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW124_ArticleProductionPositionQuantityOpenSum" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW124_ArticleProductionPositionQuantityOpenSum" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW124_ArticleProductionPositionQuantityOpenSum" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW124_ArticleProductionPositionQuantityOpenSum" } } } } } } }, "/api/xVIEW124_ArticleProductionPositionQuantityOpenSum/UpsertGraphWithExtraFields": { "put": { "tags": [ "xVIEW124_ArticleProductionPositionQuantityOpenSum" ], "summary": "xVIEW124_ArticleProductionPositionQuantityOpenSum: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW124_ArticleProductionPositionQuantityOpenSum-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW124_ArticleProductionPositionQuantityOpenSum_UpsertGraphWithExtraFields_20DF8A6C3BCF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW124_ArticleProductionPositionQuantityOpenSum" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW124_ArticleProductionPositionQuantityOpenSum" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW124_ArticleProductionPositionQuantityOpenSum" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW124_ArticleProductionPositionQuantityOpenSum" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW124_ArticleProductionPositionQuantityOpenSum" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW124_ArticleProductionPositionQuantityOpenSum" } } } } } } }, "/api/xVIEW124_ArticleQuantityInventorySum": { "get": { "tags": [ "xVIEW124_ArticleQuantityInventorySum" ], "summary": "xVIEW124_ArticleQuantityInventorySum: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW124_ArticleQuantityInventorySum-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW124_ArticleQuantityInventorySum_GetAll_733C19AE8081", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW124_ArticleQuantityInventorySum" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW124_ArticleQuantityInventorySum" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW124_ArticleQuantityInventorySum" } } } } } }, "post": { "tags": [ "xVIEW124_ArticleQuantityInventorySum" ], "summary": "xVIEW124_ArticleQuantityInventorySum: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW124_ArticleQuantityInventorySum-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW124_ArticleQuantityInventorySum_Post_B55F038DB820", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW124_ArticleQuantityInventorySum" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW124_ArticleQuantityInventorySum" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW124_ArticleQuantityInventorySum" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW124_ArticleQuantityInventorySum" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW124_ArticleQuantityInventorySum" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW124_ArticleQuantityInventorySum" } } } } } }, "put": { "tags": [ "xVIEW124_ArticleQuantityInventorySum" ], "summary": "xVIEW124_ArticleQuantityInventorySum: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW124_ArticleQuantityInventorySum-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW124_ArticleQuantityInventorySum_Put_5D37E48D54A5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW124_ArticleQuantityInventorySum" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW124_ArticleQuantityInventorySum" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW124_ArticleQuantityInventorySum" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW124_ArticleQuantityInventorySum" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW124_ArticleQuantityInventorySum" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW124_ArticleQuantityInventorySum" } } } } } } }, "/api/xVIEW124_ArticleQuantityInventorySum/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "xVIEW124_ArticleQuantityInventorySum" ], "summary": "xVIEW124_ArticleQuantityInventorySum: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW124_ArticleQuantityInventorySum-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW124_ArticleQuantityInventorySum_GetPageByValue_E67A699BB96B", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW124_ArticleQuantityInventorySum/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "xVIEW124_ArticleQuantityInventorySum" ], "summary": "xVIEW124_ArticleQuantityInventorySum: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW124_ArticleQuantityInventorySum-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW124_ArticleQuantityInventorySum_GetPageByValue2_BCF2A13E7FEE", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW124_ArticleQuantityInventorySum/DeleteByFilter": { "post": { "tags": [ "xVIEW124_ArticleQuantityInventorySum" ], "summary": "xVIEW124_ArticleQuantityInventorySum: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW124_ArticleQuantityInventorySum-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW124_ArticleQuantityInventorySum_DeleteByFilter_9C3FE8FF5D0A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/xVIEW124_ArticleQuantityInventorySum/GetAllByValue": { "post": { "tags": [ "xVIEW124_ArticleQuantityInventorySum" ], "summary": "xVIEW124_ArticleQuantityInventorySum: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW124_ArticleQuantityInventorySum-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW124_ArticleQuantityInventorySum_GetAllByValue_D7D65725EABE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW124_ArticleQuantityInventorySum" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW124_ArticleQuantityInventorySum" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW124_ArticleQuantityInventorySum" } } } } } } }, "/api/xVIEW124_ArticleQuantityInventorySum/GetAllGraphByValue": { "post": { "tags": [ "xVIEW124_ArticleQuantityInventorySum" ], "summary": "xVIEW124_ArticleQuantityInventorySum: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW124_ArticleQuantityInventorySum-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW124_ArticleQuantityInventorySum_GetAllGraphByValue_71AEEC716FDD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW124_ArticleQuantityInventorySum" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW124_ArticleQuantityInventorySum" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW124_ArticleQuantityInventorySum" } } } } } } }, "/api/xVIEW124_ArticleQuantityInventorySum/GetByValue": { "post": { "tags": [ "xVIEW124_ArticleQuantityInventorySum" ], "summary": "xVIEW124_ArticleQuantityInventorySum: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW124_ArticleQuantityInventorySum-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW124_ArticleQuantityInventorySum_GetByValue_915E29772273", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW124_ArticleQuantityInventorySum" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW124_ArticleQuantityInventorySum" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW124_ArticleQuantityInventorySum" } } } } } } }, "/api/xVIEW124_ArticleQuantityInventorySum/GetFullPage": { "get": { "tags": [ "xVIEW124_ArticleQuantityInventorySum" ], "summary": "xVIEW124_ArticleQuantityInventorySum: GetFullPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW124_ArticleQuantityInventorySum-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW124_ArticleQuantityInventorySum_GetFullPage_7DB3A702464E", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW124_ArticleQuantityInventorySum/GetLookup": { "post": { "tags": [ "xVIEW124_ArticleQuantityInventorySum" ], "summary": "xVIEW124_ArticleQuantityInventorySum: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW124_ArticleQuantityInventorySum-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW124_ArticleQuantityInventorySum_GetLookup_D8F2E55B64B7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/xVIEW124_ArticleQuantityInventorySum/GetLookupByValue": { "post": { "tags": [ "xVIEW124_ArticleQuantityInventorySum" ], "summary": "xVIEW124_ArticleQuantityInventorySum: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW124_ArticleQuantityInventorySum-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW124_ArticleQuantityInventorySum_GetLookupByValue_AA93CEA73D5A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/xVIEW124_ArticleQuantityInventorySum/Page": { "get": { "tags": [ "xVIEW124_ArticleQuantityInventorySum" ], "summary": "xVIEW124_ArticleQuantityInventorySum: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW124_ArticleQuantityInventorySum-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW124_ArticleQuantityInventorySum_GetPage_24FDD5BE7992", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW124_ArticleQuantityInventorySum/PageAsc": { "get": { "tags": [ "xVIEW124_ArticleQuantityInventorySum" ], "summary": "xVIEW124_ArticleQuantityInventorySum: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW124_ArticleQuantityInventorySum-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW124_ArticleQuantityInventorySum_GetPageAsc_015AEA754777", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW124_ArticleQuantityInventorySum/SearchByValue": { "post": { "tags": [ "xVIEW124_ArticleQuantityInventorySum" ], "summary": "xVIEW124_ArticleQuantityInventorySum: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW124_ArticleQuantityInventorySum-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW124_ArticleQuantityInventorySum_SearchByValue_2994A22AF040", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW124_ArticleQuantityInventorySum" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW124_ArticleQuantityInventorySum" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW124_ArticleQuantityInventorySum" } } } } } } }, "/api/xVIEW124_ArticleQuantityInventorySum/TryGetByValue": { "post": { "tags": [ "xVIEW124_ArticleQuantityInventorySum" ], "summary": "xVIEW124_ArticleQuantityInventorySum: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW124_ArticleQuantityInventorySum-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW124_ArticleQuantityInventorySum_TryGetByValue_079979F9E042", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW124_ArticleQuantityInventorySum" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW124_ArticleQuantityInventorySum" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW124_ArticleQuantityInventorySum" } } } } } } }, "/api/xVIEW124_ArticleQuantityInventorySum/UpsertGraph": { "put": { "tags": [ "xVIEW124_ArticleQuantityInventorySum" ], "summary": "xVIEW124_ArticleQuantityInventorySum: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW124_ArticleQuantityInventorySum-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW124_ArticleQuantityInventorySum_UpsertGraph_6DA1553BC913", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW124_ArticleQuantityInventorySum" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW124_ArticleQuantityInventorySum" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW124_ArticleQuantityInventorySum" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW124_ArticleQuantityInventorySum" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW124_ArticleQuantityInventorySum" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW124_ArticleQuantityInventorySum" } } } } } } }, "/api/xVIEW124_ArticleQuantityInventorySum/UpsertGraphWithExtraFields": { "put": { "tags": [ "xVIEW124_ArticleQuantityInventorySum" ], "summary": "xVIEW124_ArticleQuantityInventorySum: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW124_ArticleQuantityInventorySum-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW124_ArticleQuantityInventorySum_UpsertGraphWithExtraFields_B0A4EDAAF645", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW124_ArticleQuantityInventorySum" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW124_ArticleQuantityInventorySum" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW124_ArticleQuantityInventorySum" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW124_ArticleQuantityInventorySum" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW124_ArticleQuantityInventorySum" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW124_ArticleQuantityInventorySum" } } } } } } }, "/api/xVIEW125_ArticleHistoryTable": { "get": { "tags": [ "xVIEW125_ArticleHistoryTable" ], "summary": "xVIEW125_ArticleHistoryTable: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW125_ArticleHistoryTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW125_ArticleHistoryTable_GetAll_9ACC87DA07AF", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW125_ArticleHistoryTable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW125_ArticleHistoryTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW125_ArticleHistoryTable" } } } } } }, "post": { "tags": [ "xVIEW125_ArticleHistoryTable" ], "summary": "xVIEW125_ArticleHistoryTable: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW125_ArticleHistoryTable-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW125_ArticleHistoryTable_Post_275E3ECAAF25", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW125_ArticleHistoryTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW125_ArticleHistoryTable" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW125_ArticleHistoryTable" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW125_ArticleHistoryTable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW125_ArticleHistoryTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW125_ArticleHistoryTable" } } } } } }, "put": { "tags": [ "xVIEW125_ArticleHistoryTable" ], "summary": "xVIEW125_ArticleHistoryTable: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW125_ArticleHistoryTable-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW125_ArticleHistoryTable_Put_EAD6BE27BB38", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW125_ArticleHistoryTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW125_ArticleHistoryTable" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW125_ArticleHistoryTable" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW125_ArticleHistoryTable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW125_ArticleHistoryTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW125_ArticleHistoryTable" } } } } } } }, "/api/xVIEW125_ArticleHistoryTable/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "xVIEW125_ArticleHistoryTable" ], "summary": "xVIEW125_ArticleHistoryTable: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW125_ArticleHistoryTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW125_ArticleHistoryTable_GetPageByValue_26BD8648B895", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW125_ArticleHistoryTable/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "xVIEW125_ArticleHistoryTable" ], "summary": "xVIEW125_ArticleHistoryTable: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW125_ArticleHistoryTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW125_ArticleHistoryTable_GetPageByValue2_D5461E04108A", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW125_ArticleHistoryTable/DeleteByFilter": { "post": { "tags": [ "xVIEW125_ArticleHistoryTable" ], "summary": "xVIEW125_ArticleHistoryTable: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW125_ArticleHistoryTable-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW125_ArticleHistoryTable_DeleteByFilter_8734F314D7F9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/xVIEW125_ArticleHistoryTable/GetAllByValue": { "post": { "tags": [ "xVIEW125_ArticleHistoryTable" ], "summary": "xVIEW125_ArticleHistoryTable: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW125_ArticleHistoryTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW125_ArticleHistoryTable_GetAllByValue_0CBA30173FB1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW125_ArticleHistoryTable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW125_ArticleHistoryTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW125_ArticleHistoryTable" } } } } } } }, "/api/xVIEW125_ArticleHistoryTable/GetAllGraphByValue": { "post": { "tags": [ "xVIEW125_ArticleHistoryTable" ], "summary": "xVIEW125_ArticleHistoryTable: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW125_ArticleHistoryTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW125_ArticleHistoryTable_GetAllGraphByValue_55B945469680", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW125_ArticleHistoryTable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW125_ArticleHistoryTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW125_ArticleHistoryTable" } } } } } } }, "/api/xVIEW125_ArticleHistoryTable/GetByValue": { "post": { "tags": [ "xVIEW125_ArticleHistoryTable" ], "summary": "xVIEW125_ArticleHistoryTable: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW125_ArticleHistoryTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW125_ArticleHistoryTable_GetByValue_832E59C71E1F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW125_ArticleHistoryTable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW125_ArticleHistoryTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW125_ArticleHistoryTable" } } } } } } }, "/api/xVIEW125_ArticleHistoryTable/GetLookup": { "post": { "tags": [ "xVIEW125_ArticleHistoryTable" ], "summary": "xVIEW125_ArticleHistoryTable: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW125_ArticleHistoryTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW125_ArticleHistoryTable_GetLookup_DA111D436E66", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/xVIEW125_ArticleHistoryTable/GetLookupByValue": { "post": { "tags": [ "xVIEW125_ArticleHistoryTable" ], "summary": "xVIEW125_ArticleHistoryTable: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW125_ArticleHistoryTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW125_ArticleHistoryTable_GetLookupByValue_0871CB1C47C3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/xVIEW125_ArticleHistoryTable/Page": { "get": { "tags": [ "xVIEW125_ArticleHistoryTable" ], "summary": "xVIEW125_ArticleHistoryTable: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW125_ArticleHistoryTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW125_ArticleHistoryTable_GetPage_8CA1FF2FBD16", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW125_ArticleHistoryTable/PageAsc": { "get": { "tags": [ "xVIEW125_ArticleHistoryTable" ], "summary": "xVIEW125_ArticleHistoryTable: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW125_ArticleHistoryTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW125_ArticleHistoryTable_GetPageAsc_E16031516CE7", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW125_ArticleHistoryTable/SearchByValue": { "post": { "tags": [ "xVIEW125_ArticleHistoryTable" ], "summary": "xVIEW125_ArticleHistoryTable: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW125_ArticleHistoryTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW125_ArticleHistoryTable_SearchByValue_F24C21B72C9D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW125_ArticleHistoryTable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW125_ArticleHistoryTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW125_ArticleHistoryTable" } } } } } } }, "/api/xVIEW125_ArticleHistoryTable/TryGetByValue": { "post": { "tags": [ "xVIEW125_ArticleHistoryTable" ], "summary": "xVIEW125_ArticleHistoryTable: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW125_ArticleHistoryTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW125_ArticleHistoryTable_TryGetByValue_0F14BA1356BF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW125_ArticleHistoryTable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW125_ArticleHistoryTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW125_ArticleHistoryTable" } } } } } } }, "/api/xVIEW125_ArticleHistoryTable/UpsertGraph": { "put": { "tags": [ "xVIEW125_ArticleHistoryTable" ], "summary": "xVIEW125_ArticleHistoryTable: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW125_ArticleHistoryTable-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW125_ArticleHistoryTable_UpsertGraph_AF35C03F78F5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW125_ArticleHistoryTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW125_ArticleHistoryTable" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW125_ArticleHistoryTable" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW125_ArticleHistoryTable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW125_ArticleHistoryTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW125_ArticleHistoryTable" } } } } } } }, "/api/xVIEW125_ArticleHistoryTable/UpsertGraphWithExtraFields": { "put": { "tags": [ "xVIEW125_ArticleHistoryTable" ], "summary": "xVIEW125_ArticleHistoryTable: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW125_ArticleHistoryTable-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW125_ArticleHistoryTable_UpsertGraphWithExtraFields_803157598774", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW125_ArticleHistoryTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW125_ArticleHistoryTable" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW125_ArticleHistoryTable" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW125_ArticleHistoryTable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW125_ArticleHistoryTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW125_ArticleHistoryTable" } } } } } } }, "/api/xVIEW139_ArticleIndividualizationQuantityHistory": { "get": { "tags": [ "xVIEW139_ArticleIndividualizationQuantityHistory" ], "summary": "xVIEW139_ArticleIndividualizationQuantityHistory: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW139_ArticleIndividualizationQuantityHistory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW139_ArticleIndividualizationQuantityHistory_GetAll_9BFC406E1095", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW139_ArticleIndividualizationQuantityHistory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW139_ArticleIndividualizationQuantityHistory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW139_ArticleIndividualizationQuantityHistory" } } } } } }, "post": { "tags": [ "xVIEW139_ArticleIndividualizationQuantityHistory" ], "summary": "xVIEW139_ArticleIndividualizationQuantityHistory: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW139_ArticleIndividualizationQuantityHistory-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW139_ArticleIndividualizationQuantityHistory_Post_4F5335078160", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW139_ArticleIndividualizationQuantityHistory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW139_ArticleIndividualizationQuantityHistory" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW139_ArticleIndividualizationQuantityHistory" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW139_ArticleIndividualizationQuantityHistory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW139_ArticleIndividualizationQuantityHistory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW139_ArticleIndividualizationQuantityHistory" } } } } } }, "put": { "tags": [ "xVIEW139_ArticleIndividualizationQuantityHistory" ], "summary": "xVIEW139_ArticleIndividualizationQuantityHistory: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW139_ArticleIndividualizationQuantityHistory-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW139_ArticleIndividualizationQuantityHistory_Put_44D0BCA20FDB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW139_ArticleIndividualizationQuantityHistory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW139_ArticleIndividualizationQuantityHistory" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW139_ArticleIndividualizationQuantityHistory" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW139_ArticleIndividualizationQuantityHistory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW139_ArticleIndividualizationQuantityHistory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW139_ArticleIndividualizationQuantityHistory" } } } } } } }, "/api/xVIEW139_ArticleIndividualizationQuantityHistory/{ArticleIndividualizationId}/PageFromViewByArticleIndividualizationId": { "get": { "tags": [ "xVIEW139_ArticleIndividualizationQuantityHistory" ], "summary": "xVIEW139_ArticleIndividualizationQuantityHistory: GetPageFromViewByArticleIndividualizationId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW139_ArticleIndividualizationQuantityHistory-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW139_ArticleIndividualizationQuantityHistory_GetPageFromViewByArticleIndividualizationId_329093868AEE", "parameters": [ { "name": "ArticleIndividualizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW139_ArticleIndividualizationQuantityHistory/{BinLocationId}/PageFromViewByBinLocationId": { "get": { "tags": [ "xVIEW139_ArticleIndividualizationQuantityHistory" ], "summary": "xVIEW139_ArticleIndividualizationQuantityHistory: GetPageFromViewByBinLocationId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW139_ArticleIndividualizationQuantityHistory-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW139_ArticleIndividualizationQuantityHistory_GetPageFromViewByBinLocationId_4C1C5DE4D4E7", "parameters": [ { "name": "BinLocationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW139_ArticleIndividualizationQuantityHistory/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "xVIEW139_ArticleIndividualizationQuantityHistory" ], "summary": "xVIEW139_ArticleIndividualizationQuantityHistory: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW139_ArticleIndividualizationQuantityHistory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW139_ArticleIndividualizationQuantityHistory_GetPageByValue_356253551DB4", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW139_ArticleIndividualizationQuantityHistory/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "xVIEW139_ArticleIndividualizationQuantityHistory" ], "summary": "xVIEW139_ArticleIndividualizationQuantityHistory: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW139_ArticleIndividualizationQuantityHistory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW139_ArticleIndividualizationQuantityHistory_GetPageByValue2_A8EEBF5A1FAB", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW139_ArticleIndividualizationQuantityHistory/{WarehouseId}/PageFromViewByWarehouseId": { "get": { "tags": [ "xVIEW139_ArticleIndividualizationQuantityHistory" ], "summary": "xVIEW139_ArticleIndividualizationQuantityHistory: GetPageFromViewByWarehouseId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW139_ArticleIndividualizationQuantityHistory-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW139_ArticleIndividualizationQuantityHistory_GetPageFromViewByWarehouseId_4D53A837C358", "parameters": [ { "name": "WarehouseId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW139_ArticleIndividualizationQuantityHistory/DeleteByFilter": { "post": { "tags": [ "xVIEW139_ArticleIndividualizationQuantityHistory" ], "summary": "xVIEW139_ArticleIndividualizationQuantityHistory: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW139_ArticleIndividualizationQuantityHistory-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW139_ArticleIndividualizationQuantityHistory_DeleteByFilter_F35C04B7E8ED", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/xVIEW139_ArticleIndividualizationQuantityHistory/GetAllByValue": { "post": { "tags": [ "xVIEW139_ArticleIndividualizationQuantityHistory" ], "summary": "xVIEW139_ArticleIndividualizationQuantityHistory: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW139_ArticleIndividualizationQuantityHistory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW139_ArticleIndividualizationQuantityHistory_GetAllByValue_04F32FD6CA19", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW139_ArticleIndividualizationQuantityHistory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW139_ArticleIndividualizationQuantityHistory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW139_ArticleIndividualizationQuantityHistory" } } } } } } }, "/api/xVIEW139_ArticleIndividualizationQuantityHistory/GetAllGraphByValue": { "post": { "tags": [ "xVIEW139_ArticleIndividualizationQuantityHistory" ], "summary": "xVIEW139_ArticleIndividualizationQuantityHistory: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW139_ArticleIndividualizationQuantityHistory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW139_ArticleIndividualizationQuantityHistory_GetAllGraphByValue_8295E1161C86", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW139_ArticleIndividualizationQuantityHistory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW139_ArticleIndividualizationQuantityHistory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW139_ArticleIndividualizationQuantityHistory" } } } } } } }, "/api/xVIEW139_ArticleIndividualizationQuantityHistory/GetByValue": { "post": { "tags": [ "xVIEW139_ArticleIndividualizationQuantityHistory" ], "summary": "xVIEW139_ArticleIndividualizationQuantityHistory: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW139_ArticleIndividualizationQuantityHistory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW139_ArticleIndividualizationQuantityHistory_GetByValue_7E18B2285281", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW139_ArticleIndividualizationQuantityHistory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW139_ArticleIndividualizationQuantityHistory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW139_ArticleIndividualizationQuantityHistory" } } } } } } }, "/api/xVIEW139_ArticleIndividualizationQuantityHistory/GetLookup": { "post": { "tags": [ "xVIEW139_ArticleIndividualizationQuantityHistory" ], "summary": "xVIEW139_ArticleIndividualizationQuantityHistory: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW139_ArticleIndividualizationQuantityHistory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW139_ArticleIndividualizationQuantityHistory_GetLookup_7B4D97603D48", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/xVIEW139_ArticleIndividualizationQuantityHistory/GetLookupByValue": { "post": { "tags": [ "xVIEW139_ArticleIndividualizationQuantityHistory" ], "summary": "xVIEW139_ArticleIndividualizationQuantityHistory: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW139_ArticleIndividualizationQuantityHistory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW139_ArticleIndividualizationQuantityHistory_GetLookupByValue_95CA7B1B9A25", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/xVIEW139_ArticleIndividualizationQuantityHistory/Page": { "get": { "tags": [ "xVIEW139_ArticleIndividualizationQuantityHistory" ], "summary": "xVIEW139_ArticleIndividualizationQuantityHistory: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW139_ArticleIndividualizationQuantityHistory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW139_ArticleIndividualizationQuantityHistory_GetPage_00915BA0F614", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW139_ArticleIndividualizationQuantityHistory/PageAsc": { "get": { "tags": [ "xVIEW139_ArticleIndividualizationQuantityHistory" ], "summary": "xVIEW139_ArticleIndividualizationQuantityHistory: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW139_ArticleIndividualizationQuantityHistory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW139_ArticleIndividualizationQuantityHistory_GetPageAsc_908986A78E90", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW139_ArticleIndividualizationQuantityHistory/SearchByValue": { "post": { "tags": [ "xVIEW139_ArticleIndividualizationQuantityHistory" ], "summary": "xVIEW139_ArticleIndividualizationQuantityHistory: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW139_ArticleIndividualizationQuantityHistory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW139_ArticleIndividualizationQuantityHistory_SearchByValue_83CBA00E4CFA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW139_ArticleIndividualizationQuantityHistory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW139_ArticleIndividualizationQuantityHistory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW139_ArticleIndividualizationQuantityHistory" } } } } } } }, "/api/xVIEW139_ArticleIndividualizationQuantityHistory/TryGetByValue": { "post": { "tags": [ "xVIEW139_ArticleIndividualizationQuantityHistory" ], "summary": "xVIEW139_ArticleIndividualizationQuantityHistory: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW139_ArticleIndividualizationQuantityHistory-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW139_ArticleIndividualizationQuantityHistory_TryGetByValue_69FF94164004", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW139_ArticleIndividualizationQuantityHistory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW139_ArticleIndividualizationQuantityHistory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW139_ArticleIndividualizationQuantityHistory" } } } } } } }, "/api/xVIEW139_ArticleIndividualizationQuantityHistory/UpsertGraph": { "put": { "tags": [ "xVIEW139_ArticleIndividualizationQuantityHistory" ], "summary": "xVIEW139_ArticleIndividualizationQuantityHistory: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW139_ArticleIndividualizationQuantityHistory-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW139_ArticleIndividualizationQuantityHistory_UpsertGraph_92DB937A82E4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW139_ArticleIndividualizationQuantityHistory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW139_ArticleIndividualizationQuantityHistory" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW139_ArticleIndividualizationQuantityHistory" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW139_ArticleIndividualizationQuantityHistory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW139_ArticleIndividualizationQuantityHistory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW139_ArticleIndividualizationQuantityHistory" } } } } } } }, "/api/xVIEW139_ArticleIndividualizationQuantityHistory/UpsertGraphWithExtraFields": { "put": { "tags": [ "xVIEW139_ArticleIndividualizationQuantityHistory" ], "summary": "xVIEW139_ArticleIndividualizationQuantityHistory: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW139_ArticleIndividualizationQuantityHistory-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW139_ArticleIndividualizationQuantityHistory_UpsertGraphWithExtraFields_D7243C0F9516", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW139_ArticleIndividualizationQuantityHistory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW139_ArticleIndividualizationQuantityHistory" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW139_ArticleIndividualizationQuantityHistory" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW139_ArticleIndividualizationQuantityHistory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW139_ArticleIndividualizationQuantityHistory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW139_ArticleIndividualizationQuantityHistory" } } } } } } }, "/api/xVIEW140_ArticleQuantityHistoryTable": { "get": { "tags": [ "xVIEW140_ArticleQuantityHistoryTable" ], "summary": "xVIEW140_ArticleQuantityHistoryTable: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW140_ArticleQuantityHistoryTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW140_ArticleQuantityHistoryTable_GetAll_B6A1FA62EF9A", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW140_ArticleQuantityHistoryTable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW140_ArticleQuantityHistoryTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW140_ArticleQuantityHistoryTable" } } } } } }, "post": { "tags": [ "xVIEW140_ArticleQuantityHistoryTable" ], "summary": "xVIEW140_ArticleQuantityHistoryTable: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW140_ArticleQuantityHistoryTable-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW140_ArticleQuantityHistoryTable_Post_B8E159EED942", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW140_ArticleQuantityHistoryTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW140_ArticleQuantityHistoryTable" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW140_ArticleQuantityHistoryTable" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW140_ArticleQuantityHistoryTable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW140_ArticleQuantityHistoryTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW140_ArticleQuantityHistoryTable" } } } } } }, "put": { "tags": [ "xVIEW140_ArticleQuantityHistoryTable" ], "summary": "xVIEW140_ArticleQuantityHistoryTable: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW140_ArticleQuantityHistoryTable-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW140_ArticleQuantityHistoryTable_Put_131C47326B52", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW140_ArticleQuantityHistoryTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW140_ArticleQuantityHistoryTable" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW140_ArticleQuantityHistoryTable" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW140_ArticleQuantityHistoryTable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW140_ArticleQuantityHistoryTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW140_ArticleQuantityHistoryTable" } } } } } } }, "/api/xVIEW140_ArticleQuantityHistoryTable/{ArticleId}/PageFromViewByArticleId": { "get": { "tags": [ "xVIEW140_ArticleQuantityHistoryTable" ], "summary": "xVIEW140_ArticleQuantityHistoryTable: GetPageFromViewByArticleId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW140_ArticleQuantityHistoryTable-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW140_ArticleQuantityHistoryTable_GetPageFromViewByArticleId_A0D3128B0B75", "parameters": [ { "name": "ArticleId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW140_ArticleQuantityHistoryTable/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "xVIEW140_ArticleQuantityHistoryTable" ], "summary": "xVIEW140_ArticleQuantityHistoryTable: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW140_ArticleQuantityHistoryTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW140_ArticleQuantityHistoryTable_GetPageByValue_3C3692293476", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW140_ArticleQuantityHistoryTable/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "xVIEW140_ArticleQuantityHistoryTable" ], "summary": "xVIEW140_ArticleQuantityHistoryTable: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW140_ArticleQuantityHistoryTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW140_ArticleQuantityHistoryTable_GetPageByValue2_5B04E80BAFEF", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW140_ArticleQuantityHistoryTable/DeleteByFilter": { "post": { "tags": [ "xVIEW140_ArticleQuantityHistoryTable" ], "summary": "xVIEW140_ArticleQuantityHistoryTable: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW140_ArticleQuantityHistoryTable-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW140_ArticleQuantityHistoryTable_DeleteByFilter_C1AB09C74169", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/xVIEW140_ArticleQuantityHistoryTable/GetAllByValue": { "post": { "tags": [ "xVIEW140_ArticleQuantityHistoryTable" ], "summary": "xVIEW140_ArticleQuantityHistoryTable: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW140_ArticleQuantityHistoryTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW140_ArticleQuantityHistoryTable_GetAllByValue_9957ADBABDDF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW140_ArticleQuantityHistoryTable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW140_ArticleQuantityHistoryTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW140_ArticleQuantityHistoryTable" } } } } } } }, "/api/xVIEW140_ArticleQuantityHistoryTable/GetAllGraphByValue": { "post": { "tags": [ "xVIEW140_ArticleQuantityHistoryTable" ], "summary": "xVIEW140_ArticleQuantityHistoryTable: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW140_ArticleQuantityHistoryTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW140_ArticleQuantityHistoryTable_GetAllGraphByValue_5B135C95736A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW140_ArticleQuantityHistoryTable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW140_ArticleQuantityHistoryTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW140_ArticleQuantityHistoryTable" } } } } } } }, "/api/xVIEW140_ArticleQuantityHistoryTable/GetByValue": { "post": { "tags": [ "xVIEW140_ArticleQuantityHistoryTable" ], "summary": "xVIEW140_ArticleQuantityHistoryTable: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW140_ArticleQuantityHistoryTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW140_ArticleQuantityHistoryTable_GetByValue_206F6B3D557C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW140_ArticleQuantityHistoryTable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW140_ArticleQuantityHistoryTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW140_ArticleQuantityHistoryTable" } } } } } } }, "/api/xVIEW140_ArticleQuantityHistoryTable/GetLookup": { "post": { "tags": [ "xVIEW140_ArticleQuantityHistoryTable" ], "summary": "xVIEW140_ArticleQuantityHistoryTable: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW140_ArticleQuantityHistoryTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW140_ArticleQuantityHistoryTable_GetLookup_970CD15E5B24", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/xVIEW140_ArticleQuantityHistoryTable/GetLookupByValue": { "post": { "tags": [ "xVIEW140_ArticleQuantityHistoryTable" ], "summary": "xVIEW140_ArticleQuantityHistoryTable: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW140_ArticleQuantityHistoryTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW140_ArticleQuantityHistoryTable_GetLookupByValue_7F2A753CD2EB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/xVIEW140_ArticleQuantityHistoryTable/Page": { "get": { "tags": [ "xVIEW140_ArticleQuantityHistoryTable" ], "summary": "xVIEW140_ArticleQuantityHistoryTable: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW140_ArticleQuantityHistoryTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW140_ArticleQuantityHistoryTable_GetPage_9C2B8B3E76BE", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW140_ArticleQuantityHistoryTable/PageAsc": { "get": { "tags": [ "xVIEW140_ArticleQuantityHistoryTable" ], "summary": "xVIEW140_ArticleQuantityHistoryTable: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW140_ArticleQuantityHistoryTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW140_ArticleQuantityHistoryTable_GetPageAsc_4C5BAFD5FA2B", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW140_ArticleQuantityHistoryTable/SearchByValue": { "post": { "tags": [ "xVIEW140_ArticleQuantityHistoryTable" ], "summary": "xVIEW140_ArticleQuantityHistoryTable: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW140_ArticleQuantityHistoryTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW140_ArticleQuantityHistoryTable_SearchByValue_E93F5948EE61", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW140_ArticleQuantityHistoryTable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW140_ArticleQuantityHistoryTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW140_ArticleQuantityHistoryTable" } } } } } } }, "/api/xVIEW140_ArticleQuantityHistoryTable/TryGetByValue": { "post": { "tags": [ "xVIEW140_ArticleQuantityHistoryTable" ], "summary": "xVIEW140_ArticleQuantityHistoryTable: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW140_ArticleQuantityHistoryTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW140_ArticleQuantityHistoryTable_TryGetByValue_6644D965D1E6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW140_ArticleQuantityHistoryTable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW140_ArticleQuantityHistoryTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW140_ArticleQuantityHistoryTable" } } } } } } }, "/api/xVIEW140_ArticleQuantityHistoryTable/UpsertGraph": { "put": { "tags": [ "xVIEW140_ArticleQuantityHistoryTable" ], "summary": "xVIEW140_ArticleQuantityHistoryTable: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW140_ArticleQuantityHistoryTable-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW140_ArticleQuantityHistoryTable_UpsertGraph_372F4E46D4F9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW140_ArticleQuantityHistoryTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW140_ArticleQuantityHistoryTable" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW140_ArticleQuantityHistoryTable" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW140_ArticleQuantityHistoryTable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW140_ArticleQuantityHistoryTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW140_ArticleQuantityHistoryTable" } } } } } } }, "/api/xVIEW140_ArticleQuantityHistoryTable/UpsertGraphWithExtraFields": { "put": { "tags": [ "xVIEW140_ArticleQuantityHistoryTable" ], "summary": "xVIEW140_ArticleQuantityHistoryTable: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW140_ArticleQuantityHistoryTable-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW140_ArticleQuantityHistoryTable_UpsertGraphWithExtraFields_22387E00380B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW140_ArticleQuantityHistoryTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW140_ArticleQuantityHistoryTable" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW140_ArticleQuantityHistoryTable" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW140_ArticleQuantityHistoryTable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW140_ArticleQuantityHistoryTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW140_ArticleQuantityHistoryTable" } } } } } } }, "/api/xVIEW150_PartnerJoinCustomer": { "get": { "tags": [ "xVIEW150_PartnerJoinCustomer" ], "summary": "xVIEW150_PartnerJoinCustomer: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW150_PartnerJoinCustomer-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW150_PartnerJoinCustomer_GetAll_985D18B47607", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW150_PartnerJoinCustomer" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW150_PartnerJoinCustomer" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW150_PartnerJoinCustomer" } } } } } }, "post": { "tags": [ "xVIEW150_PartnerJoinCustomer" ], "summary": "xVIEW150_PartnerJoinCustomer: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW150_PartnerJoinCustomer-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW150_PartnerJoinCustomer_Post_4A7492242BA5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW150_PartnerJoinCustomer" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW150_PartnerJoinCustomer" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW150_PartnerJoinCustomer" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW150_PartnerJoinCustomer" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW150_PartnerJoinCustomer" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW150_PartnerJoinCustomer" } } } } } }, "put": { "tags": [ "xVIEW150_PartnerJoinCustomer" ], "summary": "xVIEW150_PartnerJoinCustomer: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW150_PartnerJoinCustomer-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW150_PartnerJoinCustomer_Put_C3DF5DF23A63", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW150_PartnerJoinCustomer" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW150_PartnerJoinCustomer" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW150_PartnerJoinCustomer" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW150_PartnerJoinCustomer" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW150_PartnerJoinCustomer" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW150_PartnerJoinCustomer" } } } } } } }, "/api/xVIEW150_PartnerJoinCustomer/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "xVIEW150_PartnerJoinCustomer" ], "summary": "xVIEW150_PartnerJoinCustomer: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW150_PartnerJoinCustomer-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW150_PartnerJoinCustomer_GetPageByValue_8C07B1FD1EDC", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW150_PartnerJoinCustomer/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "xVIEW150_PartnerJoinCustomer" ], "summary": "xVIEW150_PartnerJoinCustomer: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW150_PartnerJoinCustomer-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW150_PartnerJoinCustomer_GetPageByValue2_A9F7AD9A4EEC", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW150_PartnerJoinCustomer/DeleteByFilter": { "post": { "tags": [ "xVIEW150_PartnerJoinCustomer" ], "summary": "xVIEW150_PartnerJoinCustomer: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW150_PartnerJoinCustomer-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW150_PartnerJoinCustomer_DeleteByFilter_B9BAC89D4B9B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/xVIEW150_PartnerJoinCustomer/GetAllByValue": { "post": { "tags": [ "xVIEW150_PartnerJoinCustomer" ], "summary": "xVIEW150_PartnerJoinCustomer: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW150_PartnerJoinCustomer-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW150_PartnerJoinCustomer_GetAllByValue_3A67D5DC1B04", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW150_PartnerJoinCustomer" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW150_PartnerJoinCustomer" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW150_PartnerJoinCustomer" } } } } } } }, "/api/xVIEW150_PartnerJoinCustomer/GetAllGraphByValue": { "post": { "tags": [ "xVIEW150_PartnerJoinCustomer" ], "summary": "xVIEW150_PartnerJoinCustomer: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW150_PartnerJoinCustomer-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW150_PartnerJoinCustomer_GetAllGraphByValue_D11AE8C3BD43", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW150_PartnerJoinCustomer" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW150_PartnerJoinCustomer" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW150_PartnerJoinCustomer" } } } } } } }, "/api/xVIEW150_PartnerJoinCustomer/GetByValue": { "post": { "tags": [ "xVIEW150_PartnerJoinCustomer" ], "summary": "xVIEW150_PartnerJoinCustomer: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW150_PartnerJoinCustomer-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW150_PartnerJoinCustomer_GetByValue_08D05886F6C0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW150_PartnerJoinCustomer" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW150_PartnerJoinCustomer" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW150_PartnerJoinCustomer" } } } } } } }, "/api/xVIEW150_PartnerJoinCustomer/GetLookup": { "post": { "tags": [ "xVIEW150_PartnerJoinCustomer" ], "summary": "xVIEW150_PartnerJoinCustomer: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW150_PartnerJoinCustomer-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW150_PartnerJoinCustomer_GetLookup_AB0E8541AC78", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/xVIEW150_PartnerJoinCustomer/GetLookupByValue": { "post": { "tags": [ "xVIEW150_PartnerJoinCustomer" ], "summary": "xVIEW150_PartnerJoinCustomer: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW150_PartnerJoinCustomer-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW150_PartnerJoinCustomer_GetLookupByValue_F1A38A9AEDF4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/xVIEW150_PartnerJoinCustomer/Page": { "get": { "tags": [ "xVIEW150_PartnerJoinCustomer" ], "summary": "xVIEW150_PartnerJoinCustomer: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW150_PartnerJoinCustomer-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW150_PartnerJoinCustomer_GetPage_6278C3D81224", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW150_PartnerJoinCustomer/PageAsc": { "get": { "tags": [ "xVIEW150_PartnerJoinCustomer" ], "summary": "xVIEW150_PartnerJoinCustomer: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW150_PartnerJoinCustomer-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW150_PartnerJoinCustomer_GetPageAsc_9E5A542AA0EC", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW150_PartnerJoinCustomer/SearchByValue": { "post": { "tags": [ "xVIEW150_PartnerJoinCustomer" ], "summary": "xVIEW150_PartnerJoinCustomer: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW150_PartnerJoinCustomer-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW150_PartnerJoinCustomer_SearchByValue_F9643E2D6203", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW150_PartnerJoinCustomer" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW150_PartnerJoinCustomer" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW150_PartnerJoinCustomer" } } } } } } }, "/api/xVIEW150_PartnerJoinCustomer/TryGetByValue": { "post": { "tags": [ "xVIEW150_PartnerJoinCustomer" ], "summary": "xVIEW150_PartnerJoinCustomer: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW150_PartnerJoinCustomer-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW150_PartnerJoinCustomer_TryGetByValue_8BA8B1A7EE56", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW150_PartnerJoinCustomer" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW150_PartnerJoinCustomer" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW150_PartnerJoinCustomer" } } } } } } }, "/api/xVIEW150_PartnerJoinCustomer/UpsertGraph": { "put": { "tags": [ "xVIEW150_PartnerJoinCustomer" ], "summary": "xVIEW150_PartnerJoinCustomer: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW150_PartnerJoinCustomer-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW150_PartnerJoinCustomer_UpsertGraph_367E1C1EC64A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW150_PartnerJoinCustomer" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW150_PartnerJoinCustomer" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW150_PartnerJoinCustomer" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW150_PartnerJoinCustomer" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW150_PartnerJoinCustomer" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW150_PartnerJoinCustomer" } } } } } } }, "/api/xVIEW150_PartnerJoinCustomer/UpsertGraphWithExtraFields": { "put": { "tags": [ "xVIEW150_PartnerJoinCustomer" ], "summary": "xVIEW150_PartnerJoinCustomer: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW150_PartnerJoinCustomer-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW150_PartnerJoinCustomer_UpsertGraphWithExtraFields_702E95155CE8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW150_PartnerJoinCustomer" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW150_PartnerJoinCustomer" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW150_PartnerJoinCustomer" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW150_PartnerJoinCustomer" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW150_PartnerJoinCustomer" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW150_PartnerJoinCustomer" } } } } } } }, "/api/xVIEW150_PartnerJoinPartnerDetail": { "get": { "tags": [ "xVIEW150_PartnerJoinPartnerDetail" ], "summary": "xVIEW150_PartnerJoinPartnerDetail: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW150_PartnerJoinPartnerDetail-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW150_PartnerJoinPartnerDetail_GetAll_9F6B56179829", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW150_PartnerJoinPartnerDetail" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW150_PartnerJoinPartnerDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW150_PartnerJoinPartnerDetail" } } } } } }, "post": { "tags": [ "xVIEW150_PartnerJoinPartnerDetail" ], "summary": "xVIEW150_PartnerJoinPartnerDetail: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW150_PartnerJoinPartnerDetail-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW150_PartnerJoinPartnerDetail_Post_6F1673D2F386", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW150_PartnerJoinPartnerDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW150_PartnerJoinPartnerDetail" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW150_PartnerJoinPartnerDetail" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW150_PartnerJoinPartnerDetail" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW150_PartnerJoinPartnerDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW150_PartnerJoinPartnerDetail" } } } } } }, "put": { "tags": [ "xVIEW150_PartnerJoinPartnerDetail" ], "summary": "xVIEW150_PartnerJoinPartnerDetail: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW150_PartnerJoinPartnerDetail-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW150_PartnerJoinPartnerDetail_Put_7C5193E1BD9B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW150_PartnerJoinPartnerDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW150_PartnerJoinPartnerDetail" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW150_PartnerJoinPartnerDetail" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW150_PartnerJoinPartnerDetail" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW150_PartnerJoinPartnerDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW150_PartnerJoinPartnerDetail" } } } } } } }, "/api/xVIEW150_PartnerJoinPartnerDetail/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "xVIEW150_PartnerJoinPartnerDetail" ], "summary": "xVIEW150_PartnerJoinPartnerDetail: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW150_PartnerJoinPartnerDetail-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW150_PartnerJoinPartnerDetail_GetPageByValue_D6F9944317CC", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW150_PartnerJoinPartnerDetail/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "xVIEW150_PartnerJoinPartnerDetail" ], "summary": "xVIEW150_PartnerJoinPartnerDetail: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW150_PartnerJoinPartnerDetail-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW150_PartnerJoinPartnerDetail_GetPageByValue2_E304E50A7DD6", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW150_PartnerJoinPartnerDetail/DeleteByFilter": { "post": { "tags": [ "xVIEW150_PartnerJoinPartnerDetail" ], "summary": "xVIEW150_PartnerJoinPartnerDetail: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW150_PartnerJoinPartnerDetail-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW150_PartnerJoinPartnerDetail_DeleteByFilter_532C4C254552", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/xVIEW150_PartnerJoinPartnerDetail/GetAllByValue": { "post": { "tags": [ "xVIEW150_PartnerJoinPartnerDetail" ], "summary": "xVIEW150_PartnerJoinPartnerDetail: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW150_PartnerJoinPartnerDetail-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW150_PartnerJoinPartnerDetail_GetAllByValue_49FFBC5031B2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW150_PartnerJoinPartnerDetail" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW150_PartnerJoinPartnerDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW150_PartnerJoinPartnerDetail" } } } } } } }, "/api/xVIEW150_PartnerJoinPartnerDetail/GetAllGraphByValue": { "post": { "tags": [ "xVIEW150_PartnerJoinPartnerDetail" ], "summary": "xVIEW150_PartnerJoinPartnerDetail: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW150_PartnerJoinPartnerDetail-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW150_PartnerJoinPartnerDetail_GetAllGraphByValue_D679108E5830", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW150_PartnerJoinPartnerDetail" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW150_PartnerJoinPartnerDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW150_PartnerJoinPartnerDetail" } } } } } } }, "/api/xVIEW150_PartnerJoinPartnerDetail/GetByValue": { "post": { "tags": [ "xVIEW150_PartnerJoinPartnerDetail" ], "summary": "xVIEW150_PartnerJoinPartnerDetail: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW150_PartnerJoinPartnerDetail-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW150_PartnerJoinPartnerDetail_GetByValue_9193E3C3C094", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW150_PartnerJoinPartnerDetail" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW150_PartnerJoinPartnerDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW150_PartnerJoinPartnerDetail" } } } } } } }, "/api/xVIEW150_PartnerJoinPartnerDetail/GetLookup": { "post": { "tags": [ "xVIEW150_PartnerJoinPartnerDetail" ], "summary": "xVIEW150_PartnerJoinPartnerDetail: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW150_PartnerJoinPartnerDetail-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW150_PartnerJoinPartnerDetail_GetLookup_79825857164D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/xVIEW150_PartnerJoinPartnerDetail/GetLookupByValue": { "post": { "tags": [ "xVIEW150_PartnerJoinPartnerDetail" ], "summary": "xVIEW150_PartnerJoinPartnerDetail: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW150_PartnerJoinPartnerDetail-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW150_PartnerJoinPartnerDetail_GetLookupByValue_AC47F1D52A6E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/xVIEW150_PartnerJoinPartnerDetail/Page": { "get": { "tags": [ "xVIEW150_PartnerJoinPartnerDetail" ], "summary": "xVIEW150_PartnerJoinPartnerDetail: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW150_PartnerJoinPartnerDetail-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW150_PartnerJoinPartnerDetail_GetPage_2633B4C04666", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW150_PartnerJoinPartnerDetail/PageAsc": { "get": { "tags": [ "xVIEW150_PartnerJoinPartnerDetail" ], "summary": "xVIEW150_PartnerJoinPartnerDetail: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW150_PartnerJoinPartnerDetail-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW150_PartnerJoinPartnerDetail_GetPageAsc_6354C2735FE1", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW150_PartnerJoinPartnerDetail/SearchByValue": { "post": { "tags": [ "xVIEW150_PartnerJoinPartnerDetail" ], "summary": "xVIEW150_PartnerJoinPartnerDetail: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW150_PartnerJoinPartnerDetail-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW150_PartnerJoinPartnerDetail_SearchByValue_1DFCDCF4AEE3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW150_PartnerJoinPartnerDetail" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW150_PartnerJoinPartnerDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW150_PartnerJoinPartnerDetail" } } } } } } }, "/api/xVIEW150_PartnerJoinPartnerDetail/TryGetByValue": { "post": { "tags": [ "xVIEW150_PartnerJoinPartnerDetail" ], "summary": "xVIEW150_PartnerJoinPartnerDetail: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW150_PartnerJoinPartnerDetail-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW150_PartnerJoinPartnerDetail_TryGetByValue_D6E7D3A68DB9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW150_PartnerJoinPartnerDetail" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW150_PartnerJoinPartnerDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW150_PartnerJoinPartnerDetail" } } } } } } }, "/api/xVIEW150_PartnerJoinPartnerDetail/UpsertGraph": { "put": { "tags": [ "xVIEW150_PartnerJoinPartnerDetail" ], "summary": "xVIEW150_PartnerJoinPartnerDetail: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW150_PartnerJoinPartnerDetail-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW150_PartnerJoinPartnerDetail_UpsertGraph_CB35F230AFFF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW150_PartnerJoinPartnerDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW150_PartnerJoinPartnerDetail" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW150_PartnerJoinPartnerDetail" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW150_PartnerJoinPartnerDetail" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW150_PartnerJoinPartnerDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW150_PartnerJoinPartnerDetail" } } } } } } }, "/api/xVIEW150_PartnerJoinPartnerDetail/UpsertGraphWithExtraFields": { "put": { "tags": [ "xVIEW150_PartnerJoinPartnerDetail" ], "summary": "xVIEW150_PartnerJoinPartnerDetail: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW150_PartnerJoinPartnerDetail-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW150_PartnerJoinPartnerDetail_UpsertGraphWithExtraFields_155733045DA1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW150_PartnerJoinPartnerDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW150_PartnerJoinPartnerDetail" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW150_PartnerJoinPartnerDetail" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW150_PartnerJoinPartnerDetail" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW150_PartnerJoinPartnerDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW150_PartnerJoinPartnerDetail" } } } } } } }, "/api/xVIEW150_PartnerJoinSupplier": { "get": { "tags": [ "xVIEW150_PartnerJoinSupplier" ], "summary": "xVIEW150_PartnerJoinSupplier: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW150_PartnerJoinSupplier-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW150_PartnerJoinSupplier_GetAll_E9F7146ECB47", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW150_PartnerJoinSupplier" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW150_PartnerJoinSupplier" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW150_PartnerJoinSupplier" } } } } } }, "post": { "tags": [ "xVIEW150_PartnerJoinSupplier" ], "summary": "xVIEW150_PartnerJoinSupplier: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW150_PartnerJoinSupplier-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW150_PartnerJoinSupplier_Post_94142A30FA35", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW150_PartnerJoinSupplier" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW150_PartnerJoinSupplier" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW150_PartnerJoinSupplier" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW150_PartnerJoinSupplier" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW150_PartnerJoinSupplier" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW150_PartnerJoinSupplier" } } } } } }, "put": { "tags": [ "xVIEW150_PartnerJoinSupplier" ], "summary": "xVIEW150_PartnerJoinSupplier: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW150_PartnerJoinSupplier-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW150_PartnerJoinSupplier_Put_521587C1C7C3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW150_PartnerJoinSupplier" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW150_PartnerJoinSupplier" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW150_PartnerJoinSupplier" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW150_PartnerJoinSupplier" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW150_PartnerJoinSupplier" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW150_PartnerJoinSupplier" } } } } } } }, "/api/xVIEW150_PartnerJoinSupplier/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "xVIEW150_PartnerJoinSupplier" ], "summary": "xVIEW150_PartnerJoinSupplier: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW150_PartnerJoinSupplier-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW150_PartnerJoinSupplier_GetPageByValue_C3D0F9FC1CA2", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW150_PartnerJoinSupplier/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "xVIEW150_PartnerJoinSupplier" ], "summary": "xVIEW150_PartnerJoinSupplier: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW150_PartnerJoinSupplier-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW150_PartnerJoinSupplier_GetPageByValue2_1C40FA5DE2BF", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW150_PartnerJoinSupplier/DeleteByFilter": { "post": { "tags": [ "xVIEW150_PartnerJoinSupplier" ], "summary": "xVIEW150_PartnerJoinSupplier: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW150_PartnerJoinSupplier-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW150_PartnerJoinSupplier_DeleteByFilter_7762CF9C4C29", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/xVIEW150_PartnerJoinSupplier/GetAllByValue": { "post": { "tags": [ "xVIEW150_PartnerJoinSupplier" ], "summary": "xVIEW150_PartnerJoinSupplier: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW150_PartnerJoinSupplier-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW150_PartnerJoinSupplier_GetAllByValue_EAD1D5C306E1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW150_PartnerJoinSupplier" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW150_PartnerJoinSupplier" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW150_PartnerJoinSupplier" } } } } } } }, "/api/xVIEW150_PartnerJoinSupplier/GetAllGraphByValue": { "post": { "tags": [ "xVIEW150_PartnerJoinSupplier" ], "summary": "xVIEW150_PartnerJoinSupplier: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW150_PartnerJoinSupplier-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW150_PartnerJoinSupplier_GetAllGraphByValue_FE602DA17B03", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW150_PartnerJoinSupplier" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW150_PartnerJoinSupplier" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW150_PartnerJoinSupplier" } } } } } } }, "/api/xVIEW150_PartnerJoinSupplier/GetByValue": { "post": { "tags": [ "xVIEW150_PartnerJoinSupplier" ], "summary": "xVIEW150_PartnerJoinSupplier: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW150_PartnerJoinSupplier-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW150_PartnerJoinSupplier_GetByValue_859E2715ACD4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW150_PartnerJoinSupplier" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW150_PartnerJoinSupplier" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW150_PartnerJoinSupplier" } } } } } } }, "/api/xVIEW150_PartnerJoinSupplier/GetLookup": { "post": { "tags": [ "xVIEW150_PartnerJoinSupplier" ], "summary": "xVIEW150_PartnerJoinSupplier: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW150_PartnerJoinSupplier-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW150_PartnerJoinSupplier_GetLookup_F15B69C90D41", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/xVIEW150_PartnerJoinSupplier/GetLookupByValue": { "post": { "tags": [ "xVIEW150_PartnerJoinSupplier" ], "summary": "xVIEW150_PartnerJoinSupplier: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW150_PartnerJoinSupplier-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW150_PartnerJoinSupplier_GetLookupByValue_5CAC2EED6C6A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/xVIEW150_PartnerJoinSupplier/Page": { "get": { "tags": [ "xVIEW150_PartnerJoinSupplier" ], "summary": "xVIEW150_PartnerJoinSupplier: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW150_PartnerJoinSupplier-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW150_PartnerJoinSupplier_GetPage_25F5E020D0E6", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW150_PartnerJoinSupplier/PageAsc": { "get": { "tags": [ "xVIEW150_PartnerJoinSupplier" ], "summary": "xVIEW150_PartnerJoinSupplier: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW150_PartnerJoinSupplier-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW150_PartnerJoinSupplier_GetPageAsc_712608FC57F2", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW150_PartnerJoinSupplier/SearchByValue": { "post": { "tags": [ "xVIEW150_PartnerJoinSupplier" ], "summary": "xVIEW150_PartnerJoinSupplier: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW150_PartnerJoinSupplier-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW150_PartnerJoinSupplier_SearchByValue_C7F177E461C4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW150_PartnerJoinSupplier" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW150_PartnerJoinSupplier" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW150_PartnerJoinSupplier" } } } } } } }, "/api/xVIEW150_PartnerJoinSupplier/TryGetByValue": { "post": { "tags": [ "xVIEW150_PartnerJoinSupplier" ], "summary": "xVIEW150_PartnerJoinSupplier: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW150_PartnerJoinSupplier-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW150_PartnerJoinSupplier_TryGetByValue_81698828368F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW150_PartnerJoinSupplier" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW150_PartnerJoinSupplier" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW150_PartnerJoinSupplier" } } } } } } }, "/api/xVIEW150_PartnerJoinSupplier/UpsertGraph": { "put": { "tags": [ "xVIEW150_PartnerJoinSupplier" ], "summary": "xVIEW150_PartnerJoinSupplier: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW150_PartnerJoinSupplier-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW150_PartnerJoinSupplier_UpsertGraph_612B0444D7F8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW150_PartnerJoinSupplier" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW150_PartnerJoinSupplier" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW150_PartnerJoinSupplier" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW150_PartnerJoinSupplier" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW150_PartnerJoinSupplier" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW150_PartnerJoinSupplier" } } } } } } }, "/api/xVIEW150_PartnerJoinSupplier/UpsertGraphWithExtraFields": { "put": { "tags": [ "xVIEW150_PartnerJoinSupplier" ], "summary": "xVIEW150_PartnerJoinSupplier: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW150_PartnerJoinSupplier-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW150_PartnerJoinSupplier_UpsertGraphWithExtraFields_BA6567BC09E1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW150_PartnerJoinSupplier" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW150_PartnerJoinSupplier" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW150_PartnerJoinSupplier" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW150_PartnerJoinSupplier" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW150_PartnerJoinSupplier" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW150_PartnerJoinSupplier" } } } } } } }, "/api/xVIEW150_PartnerPurchasePriceListHistoryTable": { "get": { "tags": [ "xVIEW150_PartnerPurchasePriceListHistoryTable" ], "summary": "xVIEW150_PartnerPurchasePriceListHistoryTable: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW150_PartnerPurchasePriceListHistoryTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW150_PartnerPurchasePriceListHistoryTable_GetAll_BF7D3CD1D248", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW150_PartnerPurchasePriceListHistoryTable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW150_PartnerPurchasePriceListHistoryTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW150_PartnerPurchasePriceListHistoryTable" } } } } } }, "post": { "tags": [ "xVIEW150_PartnerPurchasePriceListHistoryTable" ], "summary": "xVIEW150_PartnerPurchasePriceListHistoryTable: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW150_PartnerPurchasePriceListHistoryTable-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW150_PartnerPurchasePriceListHistoryTable_Post_82C76A1A1D64", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW150_PartnerPurchasePriceListHistoryTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW150_PartnerPurchasePriceListHistoryTable" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW150_PartnerPurchasePriceListHistoryTable" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW150_PartnerPurchasePriceListHistoryTable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW150_PartnerPurchasePriceListHistoryTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW150_PartnerPurchasePriceListHistoryTable" } } } } } }, "put": { "tags": [ "xVIEW150_PartnerPurchasePriceListHistoryTable" ], "summary": "xVIEW150_PartnerPurchasePriceListHistoryTable: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW150_PartnerPurchasePriceListHistoryTable-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW150_PartnerPurchasePriceListHistoryTable_Put_14746B00625B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW150_PartnerPurchasePriceListHistoryTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW150_PartnerPurchasePriceListHistoryTable" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW150_PartnerPurchasePriceListHistoryTable" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW150_PartnerPurchasePriceListHistoryTable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW150_PartnerPurchasePriceListHistoryTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW150_PartnerPurchasePriceListHistoryTable" } } } } } } }, "/api/xVIEW150_PartnerPurchasePriceListHistoryTable/{ArticleId}/{PartnerId}/PageFromViewByArticleIdAndPartnerId": { "get": { "tags": [ "xVIEW150_PartnerPurchasePriceListHistoryTable" ], "summary": "xVIEW150_PartnerPurchasePriceListHistoryTable: GetPageFromViewByArticleIdAndPartnerId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW150_PartnerPurchasePriceListHistoryTable-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW150_PartnerPurchasePriceListHistoryTable_GetPageFromViewByArticleIdAndPartnerId_B230061CDFE1", "parameters": [ { "name": "ArticleId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PartnerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW150_PartnerPurchasePriceListHistoryTable/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "xVIEW150_PartnerPurchasePriceListHistoryTable" ], "summary": "xVIEW150_PartnerPurchasePriceListHistoryTable: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW150_PartnerPurchasePriceListHistoryTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW150_PartnerPurchasePriceListHistoryTable_GetPageByValue_79383835EC46", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW150_PartnerPurchasePriceListHistoryTable/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "xVIEW150_PartnerPurchasePriceListHistoryTable" ], "summary": "xVIEW150_PartnerPurchasePriceListHistoryTable: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW150_PartnerPurchasePriceListHistoryTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW150_PartnerPurchasePriceListHistoryTable_GetPageByValue2_717FBDE57619", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW150_PartnerPurchasePriceListHistoryTable/DeleteByFilter": { "post": { "tags": [ "xVIEW150_PartnerPurchasePriceListHistoryTable" ], "summary": "xVIEW150_PartnerPurchasePriceListHistoryTable: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW150_PartnerPurchasePriceListHistoryTable-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW150_PartnerPurchasePriceListHistoryTable_DeleteByFilter_AB32FC4F1434", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/xVIEW150_PartnerPurchasePriceListHistoryTable/GetAllByValue": { "post": { "tags": [ "xVIEW150_PartnerPurchasePriceListHistoryTable" ], "summary": "xVIEW150_PartnerPurchasePriceListHistoryTable: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW150_PartnerPurchasePriceListHistoryTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW150_PartnerPurchasePriceListHistoryTable_GetAllByValue_7B6AC5E9A8D3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW150_PartnerPurchasePriceListHistoryTable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW150_PartnerPurchasePriceListHistoryTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW150_PartnerPurchasePriceListHistoryTable" } } } } } } }, "/api/xVIEW150_PartnerPurchasePriceListHistoryTable/GetAllGraphByValue": { "post": { "tags": [ "xVIEW150_PartnerPurchasePriceListHistoryTable" ], "summary": "xVIEW150_PartnerPurchasePriceListHistoryTable: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW150_PartnerPurchasePriceListHistoryTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW150_PartnerPurchasePriceListHistoryTable_GetAllGraphByValue_564F66FA90BE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW150_PartnerPurchasePriceListHistoryTable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW150_PartnerPurchasePriceListHistoryTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW150_PartnerPurchasePriceListHistoryTable" } } } } } } }, "/api/xVIEW150_PartnerPurchasePriceListHistoryTable/GetByValue": { "post": { "tags": [ "xVIEW150_PartnerPurchasePriceListHistoryTable" ], "summary": "xVIEW150_PartnerPurchasePriceListHistoryTable: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW150_PartnerPurchasePriceListHistoryTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW150_PartnerPurchasePriceListHistoryTable_GetByValue_8FD5EA2EF543", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW150_PartnerPurchasePriceListHistoryTable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW150_PartnerPurchasePriceListHistoryTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW150_PartnerPurchasePriceListHistoryTable" } } } } } } }, "/api/xVIEW150_PartnerPurchasePriceListHistoryTable/GetLookup": { "post": { "tags": [ "xVIEW150_PartnerPurchasePriceListHistoryTable" ], "summary": "xVIEW150_PartnerPurchasePriceListHistoryTable: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW150_PartnerPurchasePriceListHistoryTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW150_PartnerPurchasePriceListHistoryTable_GetLookup_4EE60BFAA912", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/xVIEW150_PartnerPurchasePriceListHistoryTable/GetLookupByValue": { "post": { "tags": [ "xVIEW150_PartnerPurchasePriceListHistoryTable" ], "summary": "xVIEW150_PartnerPurchasePriceListHistoryTable: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW150_PartnerPurchasePriceListHistoryTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW150_PartnerPurchasePriceListHistoryTable_GetLookupByValue_E2CFCB582A27", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/xVIEW150_PartnerPurchasePriceListHistoryTable/Page": { "get": { "tags": [ "xVIEW150_PartnerPurchasePriceListHistoryTable" ], "summary": "xVIEW150_PartnerPurchasePriceListHistoryTable: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW150_PartnerPurchasePriceListHistoryTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW150_PartnerPurchasePriceListHistoryTable_GetPage_F193E2A150AF", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW150_PartnerPurchasePriceListHistoryTable/PageAsc": { "get": { "tags": [ "xVIEW150_PartnerPurchasePriceListHistoryTable" ], "summary": "xVIEW150_PartnerPurchasePriceListHistoryTable: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW150_PartnerPurchasePriceListHistoryTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW150_PartnerPurchasePriceListHistoryTable_GetPageAsc_2A4E00143686", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW150_PartnerPurchasePriceListHistoryTable/PageFromView": { "get": { "tags": [ "xVIEW150_PartnerPurchasePriceListHistoryTable" ], "summary": "xVIEW150_PartnerPurchasePriceListHistoryTable: GetPageFromView", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW150_PartnerPurchasePriceListHistoryTable-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW150_PartnerPurchasePriceListHistoryTable_GetPageFromView_5842A94BB762", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW150_PartnerPurchasePriceListHistoryTable/SearchByValue": { "post": { "tags": [ "xVIEW150_PartnerPurchasePriceListHistoryTable" ], "summary": "xVIEW150_PartnerPurchasePriceListHistoryTable: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW150_PartnerPurchasePriceListHistoryTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW150_PartnerPurchasePriceListHistoryTable_SearchByValue_D6A8584144E2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW150_PartnerPurchasePriceListHistoryTable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW150_PartnerPurchasePriceListHistoryTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW150_PartnerPurchasePriceListHistoryTable" } } } } } } }, "/api/xVIEW150_PartnerPurchasePriceListHistoryTable/TryGetByValue": { "post": { "tags": [ "xVIEW150_PartnerPurchasePriceListHistoryTable" ], "summary": "xVIEW150_PartnerPurchasePriceListHistoryTable: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW150_PartnerPurchasePriceListHistoryTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW150_PartnerPurchasePriceListHistoryTable_TryGetByValue_C125A976ED78", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW150_PartnerPurchasePriceListHistoryTable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW150_PartnerPurchasePriceListHistoryTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW150_PartnerPurchasePriceListHistoryTable" } } } } } } }, "/api/xVIEW150_PartnerPurchasePriceListHistoryTable/UpsertGraph": { "put": { "tags": [ "xVIEW150_PartnerPurchasePriceListHistoryTable" ], "summary": "xVIEW150_PartnerPurchasePriceListHistoryTable: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW150_PartnerPurchasePriceListHistoryTable-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW150_PartnerPurchasePriceListHistoryTable_UpsertGraph_80A490E8763F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW150_PartnerPurchasePriceListHistoryTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW150_PartnerPurchasePriceListHistoryTable" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW150_PartnerPurchasePriceListHistoryTable" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW150_PartnerPurchasePriceListHistoryTable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW150_PartnerPurchasePriceListHistoryTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW150_PartnerPurchasePriceListHistoryTable" } } } } } } }, "/api/xVIEW150_PartnerPurchasePriceListHistoryTable/UpsertGraphWithExtraFields": { "put": { "tags": [ "xVIEW150_PartnerPurchasePriceListHistoryTable" ], "summary": "xVIEW150_PartnerPurchasePriceListHistoryTable: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW150_PartnerPurchasePriceListHistoryTable-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW150_PartnerPurchasePriceListHistoryTable_UpsertGraphWithExtraFields_A22D5493E20F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW150_PartnerPurchasePriceListHistoryTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW150_PartnerPurchasePriceListHistoryTable" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW150_PartnerPurchasePriceListHistoryTable" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW150_PartnerPurchasePriceListHistoryTable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW150_PartnerPurchasePriceListHistoryTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW150_PartnerPurchasePriceListHistoryTable" } } } } } } }, "/api/xVIEW180_EmployeeVacationEntitlementHistoryTable": { "get": { "tags": [ "xVIEW180_EmployeeVacationEntitlementHistoryTable" ], "summary": "xVIEW180_EmployeeVacationEntitlementHistoryTable: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW180_EmployeeVacationEntitlementHistoryTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW180_EmployeeVacationEntitlementHistoryTable_GetAll_E28CB7697713", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW180_EmployeeVacationEntitlementHistoryTable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW180_EmployeeVacationEntitlementHistoryTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW180_EmployeeVacationEntitlementHistoryTable" } } } } } }, "post": { "tags": [ "xVIEW180_EmployeeVacationEntitlementHistoryTable" ], "summary": "xVIEW180_EmployeeVacationEntitlementHistoryTable: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW180_EmployeeVacationEntitlementHistoryTable-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW180_EmployeeVacationEntitlementHistoryTable_Post_FB363C181D27", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW180_EmployeeVacationEntitlementHistoryTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW180_EmployeeVacationEntitlementHistoryTable" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW180_EmployeeVacationEntitlementHistoryTable" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW180_EmployeeVacationEntitlementHistoryTable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW180_EmployeeVacationEntitlementHistoryTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW180_EmployeeVacationEntitlementHistoryTable" } } } } } }, "put": { "tags": [ "xVIEW180_EmployeeVacationEntitlementHistoryTable" ], "summary": "xVIEW180_EmployeeVacationEntitlementHistoryTable: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW180_EmployeeVacationEntitlementHistoryTable-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW180_EmployeeVacationEntitlementHistoryTable_Put_074BFCAFE714", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW180_EmployeeVacationEntitlementHistoryTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW180_EmployeeVacationEntitlementHistoryTable" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW180_EmployeeVacationEntitlementHistoryTable" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW180_EmployeeVacationEntitlementHistoryTable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW180_EmployeeVacationEntitlementHistoryTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW180_EmployeeVacationEntitlementHistoryTable" } } } } } } }, "/api/xVIEW180_EmployeeVacationEntitlementHistoryTable/{EmployeeId}/PageFromViewByEmployeeId": { "get": { "tags": [ "xVIEW180_EmployeeVacationEntitlementHistoryTable" ], "summary": "xVIEW180_EmployeeVacationEntitlementHistoryTable: GetPageFromViewByEmployeeId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW180_EmployeeVacationEntitlementHistoryTable-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW180_EmployeeVacationEntitlementHistoryTable_GetPageFromViewByEmployeeId_F62A24C3FA4A", "parameters": [ { "name": "EmployeeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW180_EmployeeVacationEntitlementHistoryTable/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "xVIEW180_EmployeeVacationEntitlementHistoryTable" ], "summary": "xVIEW180_EmployeeVacationEntitlementHistoryTable: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW180_EmployeeVacationEntitlementHistoryTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW180_EmployeeVacationEntitlementHistoryTable_GetPageByValue_C8A5C5E44191", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW180_EmployeeVacationEntitlementHistoryTable/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "xVIEW180_EmployeeVacationEntitlementHistoryTable" ], "summary": "xVIEW180_EmployeeVacationEntitlementHistoryTable: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW180_EmployeeVacationEntitlementHistoryTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW180_EmployeeVacationEntitlementHistoryTable_GetPageByValue2_52B1B16D2BB5", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW180_EmployeeVacationEntitlementHistoryTable/DeleteByFilter": { "post": { "tags": [ "xVIEW180_EmployeeVacationEntitlementHistoryTable" ], "summary": "xVIEW180_EmployeeVacationEntitlementHistoryTable: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW180_EmployeeVacationEntitlementHistoryTable-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW180_EmployeeVacationEntitlementHistoryTable_DeleteByFilter_9460B8FC58A7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/xVIEW180_EmployeeVacationEntitlementHistoryTable/GetAllByValue": { "post": { "tags": [ "xVIEW180_EmployeeVacationEntitlementHistoryTable" ], "summary": "xVIEW180_EmployeeVacationEntitlementHistoryTable: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW180_EmployeeVacationEntitlementHistoryTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW180_EmployeeVacationEntitlementHistoryTable_GetAllByValue_02543E758CA9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW180_EmployeeVacationEntitlementHistoryTable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW180_EmployeeVacationEntitlementHistoryTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW180_EmployeeVacationEntitlementHistoryTable" } } } } } } }, "/api/xVIEW180_EmployeeVacationEntitlementHistoryTable/GetAllGraphByValue": { "post": { "tags": [ "xVIEW180_EmployeeVacationEntitlementHistoryTable" ], "summary": "xVIEW180_EmployeeVacationEntitlementHistoryTable: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW180_EmployeeVacationEntitlementHistoryTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW180_EmployeeVacationEntitlementHistoryTable_GetAllGraphByValue_60DB629EEB12", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW180_EmployeeVacationEntitlementHistoryTable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW180_EmployeeVacationEntitlementHistoryTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW180_EmployeeVacationEntitlementHistoryTable" } } } } } } }, "/api/xVIEW180_EmployeeVacationEntitlementHistoryTable/GetByValue": { "post": { "tags": [ "xVIEW180_EmployeeVacationEntitlementHistoryTable" ], "summary": "xVIEW180_EmployeeVacationEntitlementHistoryTable: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW180_EmployeeVacationEntitlementHistoryTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW180_EmployeeVacationEntitlementHistoryTable_GetByValue_30593B3F5ADE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW180_EmployeeVacationEntitlementHistoryTable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW180_EmployeeVacationEntitlementHistoryTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW180_EmployeeVacationEntitlementHistoryTable" } } } } } } }, "/api/xVIEW180_EmployeeVacationEntitlementHistoryTable/GetLookup": { "post": { "tags": [ "xVIEW180_EmployeeVacationEntitlementHistoryTable" ], "summary": "xVIEW180_EmployeeVacationEntitlementHistoryTable: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW180_EmployeeVacationEntitlementHistoryTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW180_EmployeeVacationEntitlementHistoryTable_GetLookup_AD638BE7BCA1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/xVIEW180_EmployeeVacationEntitlementHistoryTable/GetLookupByValue": { "post": { "tags": [ "xVIEW180_EmployeeVacationEntitlementHistoryTable" ], "summary": "xVIEW180_EmployeeVacationEntitlementHistoryTable: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW180_EmployeeVacationEntitlementHistoryTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW180_EmployeeVacationEntitlementHistoryTable_GetLookupByValue_FD3ACF96FF3F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/xVIEW180_EmployeeVacationEntitlementHistoryTable/Page": { "get": { "tags": [ "xVIEW180_EmployeeVacationEntitlementHistoryTable" ], "summary": "xVIEW180_EmployeeVacationEntitlementHistoryTable: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW180_EmployeeVacationEntitlementHistoryTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW180_EmployeeVacationEntitlementHistoryTable_GetPage_F80704128038", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW180_EmployeeVacationEntitlementHistoryTable/PageAsc": { "get": { "tags": [ "xVIEW180_EmployeeVacationEntitlementHistoryTable" ], "summary": "xVIEW180_EmployeeVacationEntitlementHistoryTable: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW180_EmployeeVacationEntitlementHistoryTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW180_EmployeeVacationEntitlementHistoryTable_GetPageAsc_5BA70B9C06DE", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW180_EmployeeVacationEntitlementHistoryTable/SearchByValue": { "post": { "tags": [ "xVIEW180_EmployeeVacationEntitlementHistoryTable" ], "summary": "xVIEW180_EmployeeVacationEntitlementHistoryTable: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW180_EmployeeVacationEntitlementHistoryTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW180_EmployeeVacationEntitlementHistoryTable_SearchByValue_B53FFDE95EAE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW180_EmployeeVacationEntitlementHistoryTable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW180_EmployeeVacationEntitlementHistoryTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW180_EmployeeVacationEntitlementHistoryTable" } } } } } } }, "/api/xVIEW180_EmployeeVacationEntitlementHistoryTable/TryGetByValue": { "post": { "tags": [ "xVIEW180_EmployeeVacationEntitlementHistoryTable" ], "summary": "xVIEW180_EmployeeVacationEntitlementHistoryTable: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW180_EmployeeVacationEntitlementHistoryTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW180_EmployeeVacationEntitlementHistoryTable_TryGetByValue_40EEB8237561", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW180_EmployeeVacationEntitlementHistoryTable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW180_EmployeeVacationEntitlementHistoryTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW180_EmployeeVacationEntitlementHistoryTable" } } } } } } }, "/api/xVIEW180_EmployeeVacationEntitlementHistoryTable/UpsertGraph": { "put": { "tags": [ "xVIEW180_EmployeeVacationEntitlementHistoryTable" ], "summary": "xVIEW180_EmployeeVacationEntitlementHistoryTable: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW180_EmployeeVacationEntitlementHistoryTable-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW180_EmployeeVacationEntitlementHistoryTable_UpsertGraph_C4657CE8E238", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW180_EmployeeVacationEntitlementHistoryTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW180_EmployeeVacationEntitlementHistoryTable" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW180_EmployeeVacationEntitlementHistoryTable" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW180_EmployeeVacationEntitlementHistoryTable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW180_EmployeeVacationEntitlementHistoryTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW180_EmployeeVacationEntitlementHistoryTable" } } } } } } }, "/api/xVIEW180_EmployeeVacationEntitlementHistoryTable/UpsertGraphWithExtraFields": { "put": { "tags": [ "xVIEW180_EmployeeVacationEntitlementHistoryTable" ], "summary": "xVIEW180_EmployeeVacationEntitlementHistoryTable: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW180_EmployeeVacationEntitlementHistoryTable-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW180_EmployeeVacationEntitlementHistoryTable_UpsertGraphWithExtraFields_22ADC7CE4CD1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW180_EmployeeVacationEntitlementHistoryTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW180_EmployeeVacationEntitlementHistoryTable" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW180_EmployeeVacationEntitlementHistoryTable" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW180_EmployeeVacationEntitlementHistoryTable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW180_EmployeeVacationEntitlementHistoryTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW180_EmployeeVacationEntitlementHistoryTable" } } } } } } }, "/api/xVIEW181_EmployeeVacationEntitlement": { "get": { "tags": [ "xVIEW181_EmployeeVacationEntitlement" ], "summary": "xVIEW181_EmployeeVacationEntitlement: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW181_EmployeeVacationEntitlement-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW181_EmployeeVacationEntitlement_GetAll_288A76CD32C0", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW181_EmployeeVacationEntitlement" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW181_EmployeeVacationEntitlement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW181_EmployeeVacationEntitlement" } } } } } }, "post": { "tags": [ "xVIEW181_EmployeeVacationEntitlement" ], "summary": "xVIEW181_EmployeeVacationEntitlement: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW181_EmployeeVacationEntitlement-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW181_EmployeeVacationEntitlement_Post_3FEF33C0FCE0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW181_EmployeeVacationEntitlement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW181_EmployeeVacationEntitlement" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW181_EmployeeVacationEntitlement" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW181_EmployeeVacationEntitlement" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW181_EmployeeVacationEntitlement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW181_EmployeeVacationEntitlement" } } } } } }, "put": { "tags": [ "xVIEW181_EmployeeVacationEntitlement" ], "summary": "xVIEW181_EmployeeVacationEntitlement: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW181_EmployeeVacationEntitlement-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW181_EmployeeVacationEntitlement_Put_AEFA7EF692F7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW181_EmployeeVacationEntitlement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW181_EmployeeVacationEntitlement" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW181_EmployeeVacationEntitlement" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW181_EmployeeVacationEntitlement" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW181_EmployeeVacationEntitlement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW181_EmployeeVacationEntitlement" } } } } } } }, "/api/xVIEW181_EmployeeVacationEntitlement/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "xVIEW181_EmployeeVacationEntitlement" ], "summary": "xVIEW181_EmployeeVacationEntitlement: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW181_EmployeeVacationEntitlement-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW181_EmployeeVacationEntitlement_GetPageByValue_5D3C87C2F52B", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW181_EmployeeVacationEntitlement/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "xVIEW181_EmployeeVacationEntitlement" ], "summary": "xVIEW181_EmployeeVacationEntitlement: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW181_EmployeeVacationEntitlement-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW181_EmployeeVacationEntitlement_GetPageByValue2_CE0942D18ACE", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW181_EmployeeVacationEntitlement/DeleteByFilter": { "post": { "tags": [ "xVIEW181_EmployeeVacationEntitlement" ], "summary": "xVIEW181_EmployeeVacationEntitlement: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW181_EmployeeVacationEntitlement-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW181_EmployeeVacationEntitlement_DeleteByFilter_7BD2FCB89988", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/xVIEW181_EmployeeVacationEntitlement/GetAllByValue": { "post": { "tags": [ "xVIEW181_EmployeeVacationEntitlement" ], "summary": "xVIEW181_EmployeeVacationEntitlement: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW181_EmployeeVacationEntitlement-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW181_EmployeeVacationEntitlement_GetAllByValue_00B219B1267E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW181_EmployeeVacationEntitlement" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW181_EmployeeVacationEntitlement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW181_EmployeeVacationEntitlement" } } } } } } }, "/api/xVIEW181_EmployeeVacationEntitlement/GetAllGraphByValue": { "post": { "tags": [ "xVIEW181_EmployeeVacationEntitlement" ], "summary": "xVIEW181_EmployeeVacationEntitlement: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW181_EmployeeVacationEntitlement-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW181_EmployeeVacationEntitlement_GetAllGraphByValue_1903D3A2A39F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW181_EmployeeVacationEntitlement" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW181_EmployeeVacationEntitlement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW181_EmployeeVacationEntitlement" } } } } } } }, "/api/xVIEW181_EmployeeVacationEntitlement/GetByValue": { "post": { "tags": [ "xVIEW181_EmployeeVacationEntitlement" ], "summary": "xVIEW181_EmployeeVacationEntitlement: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW181_EmployeeVacationEntitlement-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW181_EmployeeVacationEntitlement_GetByValue_01D0DBBAC309", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW181_EmployeeVacationEntitlement" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW181_EmployeeVacationEntitlement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW181_EmployeeVacationEntitlement" } } } } } } }, "/api/xVIEW181_EmployeeVacationEntitlement/GetLookup": { "post": { "tags": [ "xVIEW181_EmployeeVacationEntitlement" ], "summary": "xVIEW181_EmployeeVacationEntitlement: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW181_EmployeeVacationEntitlement-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW181_EmployeeVacationEntitlement_GetLookup_9074B956DD28", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/xVIEW181_EmployeeVacationEntitlement/GetLookupByValue": { "post": { "tags": [ "xVIEW181_EmployeeVacationEntitlement" ], "summary": "xVIEW181_EmployeeVacationEntitlement: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW181_EmployeeVacationEntitlement-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW181_EmployeeVacationEntitlement_GetLookupByValue_67D1D4EB8990", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/xVIEW181_EmployeeVacationEntitlement/Page": { "get": { "tags": [ "xVIEW181_EmployeeVacationEntitlement" ], "summary": "xVIEW181_EmployeeVacationEntitlement: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW181_EmployeeVacationEntitlement-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW181_EmployeeVacationEntitlement_GetPage_232862106E90", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW181_EmployeeVacationEntitlement/PageAsc": { "get": { "tags": [ "xVIEW181_EmployeeVacationEntitlement" ], "summary": "xVIEW181_EmployeeVacationEntitlement: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW181_EmployeeVacationEntitlement-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW181_EmployeeVacationEntitlement_GetPageAsc_4F4D0DD02138", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW181_EmployeeVacationEntitlement/SearchByValue": { "post": { "tags": [ "xVIEW181_EmployeeVacationEntitlement" ], "summary": "xVIEW181_EmployeeVacationEntitlement: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW181_EmployeeVacationEntitlement-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW181_EmployeeVacationEntitlement_SearchByValue_4B8DB5A4FB32", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW181_EmployeeVacationEntitlement" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW181_EmployeeVacationEntitlement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW181_EmployeeVacationEntitlement" } } } } } } }, "/api/xVIEW181_EmployeeVacationEntitlement/TryGetByValue": { "post": { "tags": [ "xVIEW181_EmployeeVacationEntitlement" ], "summary": "xVIEW181_EmployeeVacationEntitlement: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW181_EmployeeVacationEntitlement-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW181_EmployeeVacationEntitlement_TryGetByValue_0DFDC11CCD72", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW181_EmployeeVacationEntitlement" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW181_EmployeeVacationEntitlement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW181_EmployeeVacationEntitlement" } } } } } } }, "/api/xVIEW181_EmployeeVacationEntitlement/UpsertGraph": { "put": { "tags": [ "xVIEW181_EmployeeVacationEntitlement" ], "summary": "xVIEW181_EmployeeVacationEntitlement: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW181_EmployeeVacationEntitlement-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW181_EmployeeVacationEntitlement_UpsertGraph_F3CDE2932FFC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW181_EmployeeVacationEntitlement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW181_EmployeeVacationEntitlement" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW181_EmployeeVacationEntitlement" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW181_EmployeeVacationEntitlement" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW181_EmployeeVacationEntitlement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW181_EmployeeVacationEntitlement" } } } } } } }, "/api/xVIEW181_EmployeeVacationEntitlement/UpsertGraphWithExtraFields": { "put": { "tags": [ "xVIEW181_EmployeeVacationEntitlement" ], "summary": "xVIEW181_EmployeeVacationEntitlement: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW181_EmployeeVacationEntitlement-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW181_EmployeeVacationEntitlement_UpsertGraphWithExtraFields_F5EE52D4847C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW181_EmployeeVacationEntitlement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW181_EmployeeVacationEntitlement" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW181_EmployeeVacationEntitlement" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW181_EmployeeVacationEntitlement" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW181_EmployeeVacationEntitlement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW181_EmployeeVacationEntitlement" } } } } } } }, "/api/xVIEW193_WarehouseQuantityHistoryTable": { "get": { "tags": [ "xVIEW193_WarehouseQuantityHistoryTable" ], "summary": "xVIEW193_WarehouseQuantityHistoryTable: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW193_WarehouseQuantityHistoryTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW193_WarehouseQuantityHistoryTable_GetAll_B96A9776AB4A", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW193_WarehouseQuantityHistoryTable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW193_WarehouseQuantityHistoryTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW193_WarehouseQuantityHistoryTable" } } } } } }, "post": { "tags": [ "xVIEW193_WarehouseQuantityHistoryTable" ], "summary": "xVIEW193_WarehouseQuantityHistoryTable: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW193_WarehouseQuantityHistoryTable-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW193_WarehouseQuantityHistoryTable_Post_88C343690C17", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW193_WarehouseQuantityHistoryTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW193_WarehouseQuantityHistoryTable" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW193_WarehouseQuantityHistoryTable" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW193_WarehouseQuantityHistoryTable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW193_WarehouseQuantityHistoryTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW193_WarehouseQuantityHistoryTable" } } } } } }, "put": { "tags": [ "xVIEW193_WarehouseQuantityHistoryTable" ], "summary": "xVIEW193_WarehouseQuantityHistoryTable: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW193_WarehouseQuantityHistoryTable-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW193_WarehouseQuantityHistoryTable_Put_757631EADDBC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW193_WarehouseQuantityHistoryTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW193_WarehouseQuantityHistoryTable" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW193_WarehouseQuantityHistoryTable" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW193_WarehouseQuantityHistoryTable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW193_WarehouseQuantityHistoryTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW193_WarehouseQuantityHistoryTable" } } } } } } }, "/api/xVIEW193_WarehouseQuantityHistoryTable/{BinLocationId}/PageFromViewByBinLocationId": { "get": { "tags": [ "xVIEW193_WarehouseQuantityHistoryTable" ], "summary": "xVIEW193_WarehouseQuantityHistoryTable: GetPageFromViewByBinLocationId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW193_WarehouseQuantityHistoryTable-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW193_WarehouseQuantityHistoryTable_GetPageFromViewByBinLocationId_C9758A635B91", "parameters": [ { "name": "BinLocationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW193_WarehouseQuantityHistoryTable/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "xVIEW193_WarehouseQuantityHistoryTable" ], "summary": "xVIEW193_WarehouseQuantityHistoryTable: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW193_WarehouseQuantityHistoryTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW193_WarehouseQuantityHistoryTable_GetPageByValue_9D614F32460B", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW193_WarehouseQuantityHistoryTable/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "xVIEW193_WarehouseQuantityHistoryTable" ], "summary": "xVIEW193_WarehouseQuantityHistoryTable: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW193_WarehouseQuantityHistoryTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW193_WarehouseQuantityHistoryTable_GetPageByValue2_4084FFF25B33", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW193_WarehouseQuantityHistoryTable/{WarehouseId}/PageFromViewByWarehouseId": { "get": { "tags": [ "xVIEW193_WarehouseQuantityHistoryTable" ], "summary": "xVIEW193_WarehouseQuantityHistoryTable: GetPageFromViewByWarehouseId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW193_WarehouseQuantityHistoryTable-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW193_WarehouseQuantityHistoryTable_GetPageFromViewByWarehouseId_DE16CBCC76D9", "parameters": [ { "name": "WarehouseId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW193_WarehouseQuantityHistoryTable/DeleteByFilter": { "post": { "tags": [ "xVIEW193_WarehouseQuantityHistoryTable" ], "summary": "xVIEW193_WarehouseQuantityHistoryTable: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW193_WarehouseQuantityHistoryTable-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW193_WarehouseQuantityHistoryTable_DeleteByFilter_DEA8BD3CB2D5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/xVIEW193_WarehouseQuantityHistoryTable/GetAllByValue": { "post": { "tags": [ "xVIEW193_WarehouseQuantityHistoryTable" ], "summary": "xVIEW193_WarehouseQuantityHistoryTable: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW193_WarehouseQuantityHistoryTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW193_WarehouseQuantityHistoryTable_GetAllByValue_65E2120938B9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW193_WarehouseQuantityHistoryTable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW193_WarehouseQuantityHistoryTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW193_WarehouseQuantityHistoryTable" } } } } } } }, "/api/xVIEW193_WarehouseQuantityHistoryTable/GetAllGraphByValue": { "post": { "tags": [ "xVIEW193_WarehouseQuantityHistoryTable" ], "summary": "xVIEW193_WarehouseQuantityHistoryTable: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW193_WarehouseQuantityHistoryTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW193_WarehouseQuantityHistoryTable_GetAllGraphByValue_D525DA616B6E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW193_WarehouseQuantityHistoryTable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW193_WarehouseQuantityHistoryTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW193_WarehouseQuantityHistoryTable" } } } } } } }, "/api/xVIEW193_WarehouseQuantityHistoryTable/GetByValue": { "post": { "tags": [ "xVIEW193_WarehouseQuantityHistoryTable" ], "summary": "xVIEW193_WarehouseQuantityHistoryTable: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW193_WarehouseQuantityHistoryTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW193_WarehouseQuantityHistoryTable_GetByValue_C5405FE4AE40", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW193_WarehouseQuantityHistoryTable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW193_WarehouseQuantityHistoryTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW193_WarehouseQuantityHistoryTable" } } } } } } }, "/api/xVIEW193_WarehouseQuantityHistoryTable/GetLookup": { "post": { "tags": [ "xVIEW193_WarehouseQuantityHistoryTable" ], "summary": "xVIEW193_WarehouseQuantityHistoryTable: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW193_WarehouseQuantityHistoryTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW193_WarehouseQuantityHistoryTable_GetLookup_C39A2BCBC18A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/xVIEW193_WarehouseQuantityHistoryTable/GetLookupByValue": { "post": { "tags": [ "xVIEW193_WarehouseQuantityHistoryTable" ], "summary": "xVIEW193_WarehouseQuantityHistoryTable: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW193_WarehouseQuantityHistoryTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW193_WarehouseQuantityHistoryTable_GetLookupByValue_14AE41EC04B0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/xVIEW193_WarehouseQuantityHistoryTable/Page": { "get": { "tags": [ "xVIEW193_WarehouseQuantityHistoryTable" ], "summary": "xVIEW193_WarehouseQuantityHistoryTable: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW193_WarehouseQuantityHistoryTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW193_WarehouseQuantityHistoryTable_GetPage_053E4D26D4C2", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW193_WarehouseQuantityHistoryTable/PageAsc": { "get": { "tags": [ "xVIEW193_WarehouseQuantityHistoryTable" ], "summary": "xVIEW193_WarehouseQuantityHistoryTable: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW193_WarehouseQuantityHistoryTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW193_WarehouseQuantityHistoryTable_GetPageAsc_6C7C22DF0EB3", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW193_WarehouseQuantityHistoryTable/SearchByValue": { "post": { "tags": [ "xVIEW193_WarehouseQuantityHistoryTable" ], "summary": "xVIEW193_WarehouseQuantityHistoryTable: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW193_WarehouseQuantityHistoryTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW193_WarehouseQuantityHistoryTable_SearchByValue_486A3F973D5A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW193_WarehouseQuantityHistoryTable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW193_WarehouseQuantityHistoryTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW193_WarehouseQuantityHistoryTable" } } } } } } }, "/api/xVIEW193_WarehouseQuantityHistoryTable/TryGetByValue": { "post": { "tags": [ "xVIEW193_WarehouseQuantityHistoryTable" ], "summary": "xVIEW193_WarehouseQuantityHistoryTable: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW193_WarehouseQuantityHistoryTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW193_WarehouseQuantityHistoryTable_TryGetByValue_25C6657FD10B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW193_WarehouseQuantityHistoryTable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW193_WarehouseQuantityHistoryTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW193_WarehouseQuantityHistoryTable" } } } } } } }, "/api/xVIEW193_WarehouseQuantityHistoryTable/UpsertGraph": { "put": { "tags": [ "xVIEW193_WarehouseQuantityHistoryTable" ], "summary": "xVIEW193_WarehouseQuantityHistoryTable: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW193_WarehouseQuantityHistoryTable-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW193_WarehouseQuantityHistoryTable_UpsertGraph_69B23D1F233F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW193_WarehouseQuantityHistoryTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW193_WarehouseQuantityHistoryTable" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW193_WarehouseQuantityHistoryTable" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW193_WarehouseQuantityHistoryTable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW193_WarehouseQuantityHistoryTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW193_WarehouseQuantityHistoryTable" } } } } } } }, "/api/xVIEW193_WarehouseQuantityHistoryTable/UpsertGraphWithExtraFields": { "put": { "tags": [ "xVIEW193_WarehouseQuantityHistoryTable" ], "summary": "xVIEW193_WarehouseQuantityHistoryTable: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW193_WarehouseQuantityHistoryTable-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW193_WarehouseQuantityHistoryTable_UpsertGraphWithExtraFields_E754D0B789A4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW193_WarehouseQuantityHistoryTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW193_WarehouseQuantityHistoryTable" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW193_WarehouseQuantityHistoryTable" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW193_WarehouseQuantityHistoryTable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW193_WarehouseQuantityHistoryTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW193_WarehouseQuantityHistoryTable" } } } } } } }, "/api/xVIEW200_DocTypeSequence": { "get": { "tags": [ "xVIEW200_DocTypeSequence" ], "summary": "xVIEW200_DocTypeSequence: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW200_DocTypeSequence-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW200_DocTypeSequence_GetAll_82421DEE45A3", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW200_DocTypeSequence" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW200_DocTypeSequence" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW200_DocTypeSequence" } } } } } }, "post": { "tags": [ "xVIEW200_DocTypeSequence" ], "summary": "xVIEW200_DocTypeSequence: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW200_DocTypeSequence-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW200_DocTypeSequence_Post_649832A3607F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW200_DocTypeSequence" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW200_DocTypeSequence" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW200_DocTypeSequence" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW200_DocTypeSequence" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW200_DocTypeSequence" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW200_DocTypeSequence" } } } } } }, "put": { "tags": [ "xVIEW200_DocTypeSequence" ], "summary": "xVIEW200_DocTypeSequence: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW200_DocTypeSequence-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW200_DocTypeSequence_Put_D8AACC95A898", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW200_DocTypeSequence" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW200_DocTypeSequence" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW200_DocTypeSequence" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW200_DocTypeSequence" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW200_DocTypeSequence" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW200_DocTypeSequence" } } } } } } }, "/api/xVIEW200_DocTypeSequence/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "xVIEW200_DocTypeSequence" ], "summary": "xVIEW200_DocTypeSequence: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW200_DocTypeSequence-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW200_DocTypeSequence_GetPageByValue_F45E45A287D5", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW200_DocTypeSequence/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "xVIEW200_DocTypeSequence" ], "summary": "xVIEW200_DocTypeSequence: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW200_DocTypeSequence-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW200_DocTypeSequence_GetPageByValue2_D9D472F9C6D4", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW200_DocTypeSequence/DeleteByFilter": { "post": { "tags": [ "xVIEW200_DocTypeSequence" ], "summary": "xVIEW200_DocTypeSequence: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW200_DocTypeSequence-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW200_DocTypeSequence_DeleteByFilter_606AADD7A368", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/xVIEW200_DocTypeSequence/GetAllByValue": { "post": { "tags": [ "xVIEW200_DocTypeSequence" ], "summary": "xVIEW200_DocTypeSequence: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW200_DocTypeSequence-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW200_DocTypeSequence_GetAllByValue_949C38FDA3C3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW200_DocTypeSequence" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW200_DocTypeSequence" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW200_DocTypeSequence" } } } } } } }, "/api/xVIEW200_DocTypeSequence/GetAllGraphByValue": { "post": { "tags": [ "xVIEW200_DocTypeSequence" ], "summary": "xVIEW200_DocTypeSequence: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW200_DocTypeSequence-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW200_DocTypeSequence_GetAllGraphByValue_D178AB5B5445", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW200_DocTypeSequence" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW200_DocTypeSequence" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW200_DocTypeSequence" } } } } } } }, "/api/xVIEW200_DocTypeSequence/GetByValue": { "post": { "tags": [ "xVIEW200_DocTypeSequence" ], "summary": "xVIEW200_DocTypeSequence: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW200_DocTypeSequence-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW200_DocTypeSequence_GetByValue_5A51F677B14A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW200_DocTypeSequence" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW200_DocTypeSequence" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW200_DocTypeSequence" } } } } } } }, "/api/xVIEW200_DocTypeSequence/GetFullPage": { "get": { "tags": [ "xVIEW200_DocTypeSequence" ], "summary": "xVIEW200_DocTypeSequence: GetFullPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW200_DocTypeSequence-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW200_DocTypeSequence_GetFullPage_5E6F53AB03B5", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW200_DocTypeSequence/GetLookup": { "post": { "tags": [ "xVIEW200_DocTypeSequence" ], "summary": "xVIEW200_DocTypeSequence: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW200_DocTypeSequence-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW200_DocTypeSequence_GetLookup_D22B04D711CD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/xVIEW200_DocTypeSequence/GetLookupByValue": { "post": { "tags": [ "xVIEW200_DocTypeSequence" ], "summary": "xVIEW200_DocTypeSequence: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW200_DocTypeSequence-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW200_DocTypeSequence_GetLookupByValue_38B4F6337AA7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/xVIEW200_DocTypeSequence/Page": { "get": { "tags": [ "xVIEW200_DocTypeSequence" ], "summary": "xVIEW200_DocTypeSequence: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW200_DocTypeSequence-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW200_DocTypeSequence_GetPage_CC4BD875E0E1", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW200_DocTypeSequence/PageAsc": { "get": { "tags": [ "xVIEW200_DocTypeSequence" ], "summary": "xVIEW200_DocTypeSequence: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW200_DocTypeSequence-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW200_DocTypeSequence_GetPageAsc_1A41F5D4638F", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW200_DocTypeSequence/SearchByValue": { "post": { "tags": [ "xVIEW200_DocTypeSequence" ], "summary": "xVIEW200_DocTypeSequence: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW200_DocTypeSequence-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW200_DocTypeSequence_SearchByValue_4112593AEBEA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW200_DocTypeSequence" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW200_DocTypeSequence" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW200_DocTypeSequence" } } } } } } }, "/api/xVIEW200_DocTypeSequence/TryGetByValue": { "post": { "tags": [ "xVIEW200_DocTypeSequence" ], "summary": "xVIEW200_DocTypeSequence: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW200_DocTypeSequence-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW200_DocTypeSequence_TryGetByValue_46CE38F7CC3F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW200_DocTypeSequence" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW200_DocTypeSequence" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW200_DocTypeSequence" } } } } } } }, "/api/xVIEW200_DocTypeSequence/UpsertGraph": { "put": { "tags": [ "xVIEW200_DocTypeSequence" ], "summary": "xVIEW200_DocTypeSequence: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW200_DocTypeSequence-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW200_DocTypeSequence_UpsertGraph_E19007DD12A6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW200_DocTypeSequence" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW200_DocTypeSequence" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW200_DocTypeSequence" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW200_DocTypeSequence" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW200_DocTypeSequence" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW200_DocTypeSequence" } } } } } } }, "/api/xVIEW200_DocTypeSequence/UpsertGraphWithExtraFields": { "put": { "tags": [ "xVIEW200_DocTypeSequence" ], "summary": "xVIEW200_DocTypeSequence: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW200_DocTypeSequence-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW200_DocTypeSequence_UpsertGraphWithExtraFields_E13A324333C8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW200_DocTypeSequence" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW200_DocTypeSequence" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW200_DocTypeSequence" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW200_DocTypeSequence" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW200_DocTypeSequence" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW200_DocTypeSequence" } } } } } } }, "/api/xVIEW216_Doc_DeviceService": { "get": { "tags": [ "xVIEW216_Doc_DeviceService" ], "summary": "xVIEW216_Doc_DeviceService: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW216_Doc_DeviceService-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW216_Doc_DeviceService_GetAll_406B4C0BBD6F", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW216_Doc_DeviceService" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW216_Doc_DeviceService" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW216_Doc_DeviceService" } } } } } }, "post": { "tags": [ "xVIEW216_Doc_DeviceService" ], "summary": "xVIEW216_Doc_DeviceService: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW216_Doc_DeviceService-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW216_Doc_DeviceService_Post_74BC304BC6E0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW216_Doc_DeviceService" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW216_Doc_DeviceService" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW216_Doc_DeviceService" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW216_Doc_DeviceService" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW216_Doc_DeviceService" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW216_Doc_DeviceService" } } } } } }, "put": { "tags": [ "xVIEW216_Doc_DeviceService" ], "summary": "xVIEW216_Doc_DeviceService: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW216_Doc_DeviceService-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW216_Doc_DeviceService_Put_0A890D370BD0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW216_Doc_DeviceService" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW216_Doc_DeviceService" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW216_Doc_DeviceService" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW216_Doc_DeviceService" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW216_Doc_DeviceService" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW216_Doc_DeviceService" } } } } } } }, "/api/xVIEW216_Doc_DeviceService/{DeviceSerialNumberId}/PageFromViewByDeviceSerialNumberId": { "get": { "tags": [ "xVIEW216_Doc_DeviceService" ], "summary": "xVIEW216_Doc_DeviceService: GetPageFromViewByDeviceSerialNumberId", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW216_Doc_DeviceService-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW216_Doc_DeviceService_GetPageFromViewByDeviceSerialNumberId_895911FD8B7E", "parameters": [ { "name": "DeviceSerialNumberId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW216_Doc_DeviceService/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "xVIEW216_Doc_DeviceService" ], "summary": "xVIEW216_Doc_DeviceService: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW216_Doc_DeviceService-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW216_Doc_DeviceService_GetPageByValue_835737882CA4", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW216_Doc_DeviceService/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "xVIEW216_Doc_DeviceService" ], "summary": "xVIEW216_Doc_DeviceService: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW216_Doc_DeviceService-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW216_Doc_DeviceService_GetPageByValue2_D6C34049A928", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW216_Doc_DeviceService/DeleteByFilter": { "post": { "tags": [ "xVIEW216_Doc_DeviceService" ], "summary": "xVIEW216_Doc_DeviceService: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW216_Doc_DeviceService-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW216_Doc_DeviceService_DeleteByFilter_D9DBEC70B9A9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/xVIEW216_Doc_DeviceService/GetAllByValue": { "post": { "tags": [ "xVIEW216_Doc_DeviceService" ], "summary": "xVIEW216_Doc_DeviceService: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW216_Doc_DeviceService-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW216_Doc_DeviceService_GetAllByValue_D7F90FD5B72D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW216_Doc_DeviceService" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW216_Doc_DeviceService" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW216_Doc_DeviceService" } } } } } } }, "/api/xVIEW216_Doc_DeviceService/GetAllGraphByValue": { "post": { "tags": [ "xVIEW216_Doc_DeviceService" ], "summary": "xVIEW216_Doc_DeviceService: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW216_Doc_DeviceService-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW216_Doc_DeviceService_GetAllGraphByValue_D3532564B58A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW216_Doc_DeviceService" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW216_Doc_DeviceService" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW216_Doc_DeviceService" } } } } } } }, "/api/xVIEW216_Doc_DeviceService/GetByValue": { "post": { "tags": [ "xVIEW216_Doc_DeviceService" ], "summary": "xVIEW216_Doc_DeviceService: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW216_Doc_DeviceService-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW216_Doc_DeviceService_GetByValue_8D7E70A84A8E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW216_Doc_DeviceService" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW216_Doc_DeviceService" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW216_Doc_DeviceService" } } } } } } }, "/api/xVIEW216_Doc_DeviceService/GetLookup": { "post": { "tags": [ "xVIEW216_Doc_DeviceService" ], "summary": "xVIEW216_Doc_DeviceService: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW216_Doc_DeviceService-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW216_Doc_DeviceService_GetLookup_BC93C2A5F26D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/xVIEW216_Doc_DeviceService/GetLookupByValue": { "post": { "tags": [ "xVIEW216_Doc_DeviceService" ], "summary": "xVIEW216_Doc_DeviceService: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW216_Doc_DeviceService-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW216_Doc_DeviceService_GetLookupByValue_07945019D168", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/xVIEW216_Doc_DeviceService/Page": { "get": { "tags": [ "xVIEW216_Doc_DeviceService" ], "summary": "xVIEW216_Doc_DeviceService: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW216_Doc_DeviceService-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW216_Doc_DeviceService_GetPage_57380FF21D4B", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW216_Doc_DeviceService/PageAsc": { "get": { "tags": [ "xVIEW216_Doc_DeviceService" ], "summary": "xVIEW216_Doc_DeviceService: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW216_Doc_DeviceService-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW216_Doc_DeviceService_GetPageAsc_F69840B525C9", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW216_Doc_DeviceService/SearchByValue": { "post": { "tags": [ "xVIEW216_Doc_DeviceService" ], "summary": "xVIEW216_Doc_DeviceService: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW216_Doc_DeviceService-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW216_Doc_DeviceService_SearchByValue_503E7A6B13E5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW216_Doc_DeviceService" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW216_Doc_DeviceService" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW216_Doc_DeviceService" } } } } } } }, "/api/xVIEW216_Doc_DeviceService/TryGetByValue": { "post": { "tags": [ "xVIEW216_Doc_DeviceService" ], "summary": "xVIEW216_Doc_DeviceService: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW216_Doc_DeviceService-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW216_Doc_DeviceService_TryGetByValue_0ABBA964A04A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW216_Doc_DeviceService" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW216_Doc_DeviceService" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW216_Doc_DeviceService" } } } } } } }, "/api/xVIEW216_Doc_DeviceService/UpsertGraph": { "put": { "tags": [ "xVIEW216_Doc_DeviceService" ], "summary": "xVIEW216_Doc_DeviceService: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW216_Doc_DeviceService-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW216_Doc_DeviceService_UpsertGraph_3D35C9FA66D7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW216_Doc_DeviceService" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW216_Doc_DeviceService" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW216_Doc_DeviceService" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW216_Doc_DeviceService" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW216_Doc_DeviceService" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW216_Doc_DeviceService" } } } } } } }, "/api/xVIEW216_Doc_DeviceService/UpsertGraphWithExtraFields": { "put": { "tags": [ "xVIEW216_Doc_DeviceService" ], "summary": "xVIEW216_Doc_DeviceService: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW216_Doc_DeviceService-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW216_Doc_DeviceService_UpsertGraphWithExtraFields_FC25D974B7C9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW216_Doc_DeviceService" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW216_Doc_DeviceService" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW216_Doc_DeviceService" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW216_Doc_DeviceService" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW216_Doc_DeviceService" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW216_Doc_DeviceService" } } } } } } }, "/api/xVIEW360_MarketplaceSellerPosition": { "get": { "tags": [ "xVIEW360_MarketplaceSellerPosition" ], "summary": "xVIEW360_MarketplaceSellerPosition: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW360_MarketplaceSellerPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW360_MarketplaceSellerPosition_GetAll_1C5E014643AF", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW360_MarketplaceSellerPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW360_MarketplaceSellerPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW360_MarketplaceSellerPosition" } } } } } }, "post": { "tags": [ "xVIEW360_MarketplaceSellerPosition" ], "summary": "xVIEW360_MarketplaceSellerPosition: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW360_MarketplaceSellerPosition-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW360_MarketplaceSellerPosition_Post_422566624867", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW360_MarketplaceSellerPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW360_MarketplaceSellerPosition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW360_MarketplaceSellerPosition" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW360_MarketplaceSellerPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW360_MarketplaceSellerPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW360_MarketplaceSellerPosition" } } } } } }, "put": { "tags": [ "xVIEW360_MarketplaceSellerPosition" ], "summary": "xVIEW360_MarketplaceSellerPosition: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW360_MarketplaceSellerPosition-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW360_MarketplaceSellerPosition_Put_5E6F2674C6C1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW360_MarketplaceSellerPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW360_MarketplaceSellerPosition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW360_MarketplaceSellerPosition" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW360_MarketplaceSellerPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW360_MarketplaceSellerPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW360_MarketplaceSellerPosition" } } } } } } }, "/api/xVIEW360_MarketplaceSellerPosition/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "xVIEW360_MarketplaceSellerPosition" ], "summary": "xVIEW360_MarketplaceSellerPosition: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW360_MarketplaceSellerPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW360_MarketplaceSellerPosition_GetPageByValue_1AAC60574C44", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW360_MarketplaceSellerPosition/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "xVIEW360_MarketplaceSellerPosition" ], "summary": "xVIEW360_MarketplaceSellerPosition: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW360_MarketplaceSellerPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW360_MarketplaceSellerPosition_GetPageByValue2_492132CAF86B", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW360_MarketplaceSellerPosition/DeleteByFilter": { "post": { "tags": [ "xVIEW360_MarketplaceSellerPosition" ], "summary": "xVIEW360_MarketplaceSellerPosition: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW360_MarketplaceSellerPosition-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW360_MarketplaceSellerPosition_DeleteByFilter_3529F444E2BA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/xVIEW360_MarketplaceSellerPosition/GetAllByValue": { "post": { "tags": [ "xVIEW360_MarketplaceSellerPosition" ], "summary": "xVIEW360_MarketplaceSellerPosition: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW360_MarketplaceSellerPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW360_MarketplaceSellerPosition_GetAllByValue_89440349B994", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW360_MarketplaceSellerPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW360_MarketplaceSellerPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW360_MarketplaceSellerPosition" } } } } } } }, "/api/xVIEW360_MarketplaceSellerPosition/GetAllGraphByValue": { "post": { "tags": [ "xVIEW360_MarketplaceSellerPosition" ], "summary": "xVIEW360_MarketplaceSellerPosition: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW360_MarketplaceSellerPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW360_MarketplaceSellerPosition_GetAllGraphByValue_D45A54836489", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW360_MarketplaceSellerPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW360_MarketplaceSellerPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW360_MarketplaceSellerPosition" } } } } } } }, "/api/xVIEW360_MarketplaceSellerPosition/GetByValue": { "post": { "tags": [ "xVIEW360_MarketplaceSellerPosition" ], "summary": "xVIEW360_MarketplaceSellerPosition: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW360_MarketplaceSellerPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW360_MarketplaceSellerPosition_GetByValue_CBE577371DF7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW360_MarketplaceSellerPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW360_MarketplaceSellerPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW360_MarketplaceSellerPosition" } } } } } } }, "/api/xVIEW360_MarketplaceSellerPosition/GetLookup": { "post": { "tags": [ "xVIEW360_MarketplaceSellerPosition" ], "summary": "xVIEW360_MarketplaceSellerPosition: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW360_MarketplaceSellerPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW360_MarketplaceSellerPosition_GetLookup_40034B28674A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/xVIEW360_MarketplaceSellerPosition/GetLookupByValue": { "post": { "tags": [ "xVIEW360_MarketplaceSellerPosition" ], "summary": "xVIEW360_MarketplaceSellerPosition: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW360_MarketplaceSellerPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW360_MarketplaceSellerPosition_GetLookupByValue_5C7CF3813D63", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/xVIEW360_MarketplaceSellerPosition/Page": { "get": { "tags": [ "xVIEW360_MarketplaceSellerPosition" ], "summary": "xVIEW360_MarketplaceSellerPosition: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW360_MarketplaceSellerPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW360_MarketplaceSellerPosition_GetPage_8BAC1B687F82", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW360_MarketplaceSellerPosition/PageAsc": { "get": { "tags": [ "xVIEW360_MarketplaceSellerPosition" ], "summary": "xVIEW360_MarketplaceSellerPosition: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW360_MarketplaceSellerPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW360_MarketplaceSellerPosition_GetPageAsc_7834684800E4", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW360_MarketplaceSellerPosition/SearchByValue": { "post": { "tags": [ "xVIEW360_MarketplaceSellerPosition" ], "summary": "xVIEW360_MarketplaceSellerPosition: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW360_MarketplaceSellerPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW360_MarketplaceSellerPosition_SearchByValue_905F242A6FC6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW360_MarketplaceSellerPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW360_MarketplaceSellerPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW360_MarketplaceSellerPosition" } } } } } } }, "/api/xVIEW360_MarketplaceSellerPosition/TryGetByValue": { "post": { "tags": [ "xVIEW360_MarketplaceSellerPosition" ], "summary": "xVIEW360_MarketplaceSellerPosition: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW360_MarketplaceSellerPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW360_MarketplaceSellerPosition_TryGetByValue_03D519749803", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW360_MarketplaceSellerPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW360_MarketplaceSellerPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW360_MarketplaceSellerPosition" } } } } } } }, "/api/xVIEW360_MarketplaceSellerPosition/UpsertGraph": { "put": { "tags": [ "xVIEW360_MarketplaceSellerPosition" ], "summary": "xVIEW360_MarketplaceSellerPosition: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW360_MarketplaceSellerPosition-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW360_MarketplaceSellerPosition_UpsertGraph_3975435281C2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW360_MarketplaceSellerPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW360_MarketplaceSellerPosition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW360_MarketplaceSellerPosition" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW360_MarketplaceSellerPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW360_MarketplaceSellerPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW360_MarketplaceSellerPosition" } } } } } } }, "/api/xVIEW360_MarketplaceSellerPosition/UpsertGraphWithExtraFields": { "put": { "tags": [ "xVIEW360_MarketplaceSellerPosition" ], "summary": "xVIEW360_MarketplaceSellerPosition: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW360_MarketplaceSellerPosition-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW360_MarketplaceSellerPosition_UpsertGraphWithExtraFields_D98AAD8802E5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW360_MarketplaceSellerPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW360_MarketplaceSellerPosition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW360_MarketplaceSellerPosition" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW360_MarketplaceSellerPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW360_MarketplaceSellerPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW360_MarketplaceSellerPosition" } } } } } } }, "/api/xVIEW500_WarehouseInventoryList": { "get": { "tags": [ "xVIEW500_WarehouseInventoryList" ], "summary": "xVIEW500_WarehouseInventoryList: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW500_WarehouseInventoryList-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW500_WarehouseInventoryList_GetAll_71618091088F", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW500_WarehouseInventoryList" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW500_WarehouseInventoryList" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW500_WarehouseInventoryList" } } } } } }, "post": { "tags": [ "xVIEW500_WarehouseInventoryList" ], "summary": "xVIEW500_WarehouseInventoryList: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW500_WarehouseInventoryList-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW500_WarehouseInventoryList_Post_34785B53530C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW500_WarehouseInventoryList" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW500_WarehouseInventoryList" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW500_WarehouseInventoryList" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW500_WarehouseInventoryList" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW500_WarehouseInventoryList" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW500_WarehouseInventoryList" } } } } } }, "put": { "tags": [ "xVIEW500_WarehouseInventoryList" ], "summary": "xVIEW500_WarehouseInventoryList: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW500_WarehouseInventoryList-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW500_WarehouseInventoryList_Put_BA946BDED622", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW500_WarehouseInventoryList" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW500_WarehouseInventoryList" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW500_WarehouseInventoryList" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW500_WarehouseInventoryList" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW500_WarehouseInventoryList" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW500_WarehouseInventoryList" } } } } } } }, "/api/xVIEW500_WarehouseInventoryList/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "xVIEW500_WarehouseInventoryList" ], "summary": "xVIEW500_WarehouseInventoryList: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW500_WarehouseInventoryList-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW500_WarehouseInventoryList_GetPageByValue_8A29A1E6A1AA", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW500_WarehouseInventoryList/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "xVIEW500_WarehouseInventoryList" ], "summary": "xVIEW500_WarehouseInventoryList: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW500_WarehouseInventoryList-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW500_WarehouseInventoryList_GetPageByValue2_73106DC19B88", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW500_WarehouseInventoryList/DeleteByFilter": { "post": { "tags": [ "xVIEW500_WarehouseInventoryList" ], "summary": "xVIEW500_WarehouseInventoryList: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW500_WarehouseInventoryList-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW500_WarehouseInventoryList_DeleteByFilter_09AFE9E490CC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/xVIEW500_WarehouseInventoryList/GetAllByValue": { "post": { "tags": [ "xVIEW500_WarehouseInventoryList" ], "summary": "xVIEW500_WarehouseInventoryList: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW500_WarehouseInventoryList-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW500_WarehouseInventoryList_GetAllByValue_A07A90DA6672", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW500_WarehouseInventoryList" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW500_WarehouseInventoryList" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW500_WarehouseInventoryList" } } } } } } }, "/api/xVIEW500_WarehouseInventoryList/GetAllGraphByValue": { "post": { "tags": [ "xVIEW500_WarehouseInventoryList" ], "summary": "xVIEW500_WarehouseInventoryList: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW500_WarehouseInventoryList-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW500_WarehouseInventoryList_GetAllGraphByValue_5EA77BABD6E5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW500_WarehouseInventoryList" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW500_WarehouseInventoryList" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW500_WarehouseInventoryList" } } } } } } }, "/api/xVIEW500_WarehouseInventoryList/GetByValue": { "post": { "tags": [ "xVIEW500_WarehouseInventoryList" ], "summary": "xVIEW500_WarehouseInventoryList: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW500_WarehouseInventoryList-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW500_WarehouseInventoryList_GetByValue_DE41D078F3D0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW500_WarehouseInventoryList" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW500_WarehouseInventoryList" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW500_WarehouseInventoryList" } } } } } } }, "/api/xVIEW500_WarehouseInventoryList/GetLookup": { "post": { "tags": [ "xVIEW500_WarehouseInventoryList" ], "summary": "xVIEW500_WarehouseInventoryList: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW500_WarehouseInventoryList-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW500_WarehouseInventoryList_GetLookup_AEC2A7A8E0D3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/xVIEW500_WarehouseInventoryList/GetLookupByValue": { "post": { "tags": [ "xVIEW500_WarehouseInventoryList" ], "summary": "xVIEW500_WarehouseInventoryList: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW500_WarehouseInventoryList-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW500_WarehouseInventoryList_GetLookupByValue_361374F69C14", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/xVIEW500_WarehouseInventoryList/GetPageWarehouseInventoryList": { "get": { "tags": [ "xVIEW500_WarehouseInventoryList" ], "summary": "xVIEW500_WarehouseInventoryList: GetPageWarehouseInventoryList", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW500_WarehouseInventoryList-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW500_WarehouseInventoryList_GetPageWarehouseInventoryList_5C7633673CDF", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW500_WarehouseInventoryList/Page": { "get": { "tags": [ "xVIEW500_WarehouseInventoryList" ], "summary": "xVIEW500_WarehouseInventoryList: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW500_WarehouseInventoryList-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW500_WarehouseInventoryList_GetPage_1A90BED11126", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW500_WarehouseInventoryList/PageAsc": { "get": { "tags": [ "xVIEW500_WarehouseInventoryList" ], "summary": "xVIEW500_WarehouseInventoryList: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW500_WarehouseInventoryList-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW500_WarehouseInventoryList_GetPageAsc_9FE14EFA93D7", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW500_WarehouseInventoryList/SearchByValue": { "post": { "tags": [ "xVIEW500_WarehouseInventoryList" ], "summary": "xVIEW500_WarehouseInventoryList: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW500_WarehouseInventoryList-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW500_WarehouseInventoryList_SearchByValue_5172AE967879", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW500_WarehouseInventoryList" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW500_WarehouseInventoryList" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW500_WarehouseInventoryList" } } } } } } }, "/api/xVIEW500_WarehouseInventoryList/TryGetByValue": { "post": { "tags": [ "xVIEW500_WarehouseInventoryList" ], "summary": "xVIEW500_WarehouseInventoryList: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW500_WarehouseInventoryList-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW500_WarehouseInventoryList_TryGetByValue_BA2960CB4434", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW500_WarehouseInventoryList" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW500_WarehouseInventoryList" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW500_WarehouseInventoryList" } } } } } } }, "/api/xVIEW500_WarehouseInventoryList/UpsertGraph": { "put": { "tags": [ "xVIEW500_WarehouseInventoryList" ], "summary": "xVIEW500_WarehouseInventoryList: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW500_WarehouseInventoryList-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW500_WarehouseInventoryList_UpsertGraph_2E8351FC8527", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW500_WarehouseInventoryList" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW500_WarehouseInventoryList" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW500_WarehouseInventoryList" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW500_WarehouseInventoryList" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW500_WarehouseInventoryList" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW500_WarehouseInventoryList" } } } } } } }, "/api/xVIEW500_WarehouseInventoryList/UpsertGraphWithExtraFields": { "put": { "tags": [ "xVIEW500_WarehouseInventoryList" ], "summary": "xVIEW500_WarehouseInventoryList: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW500_WarehouseInventoryList-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW500_WarehouseInventoryList_UpsertGraphWithExtraFields_4B222F4EA6F7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW500_WarehouseInventoryList" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW500_WarehouseInventoryList" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW500_WarehouseInventoryList" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW500_WarehouseInventoryList" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW500_WarehouseInventoryList" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW500_WarehouseInventoryList" } } } } } } }, "/api/xVIEW501_WarehouseInventoryIndividualized": { "get": { "tags": [ "xVIEW501_WarehouseInventoryIndividualized" ], "summary": "xVIEW501_WarehouseInventoryIndividualized: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW501_WarehouseInventoryIndividualized-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW501_WarehouseInventoryIndividualized_GetAll_3B7485CD198C", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW501_WarehouseInventoryIndividualized" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW501_WarehouseInventoryIndividualized" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW501_WarehouseInventoryIndividualized" } } } } } }, "post": { "tags": [ "xVIEW501_WarehouseInventoryIndividualized" ], "summary": "xVIEW501_WarehouseInventoryIndividualized: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW501_WarehouseInventoryIndividualized-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW501_WarehouseInventoryIndividualized_Post_7E6E9A78D846", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW501_WarehouseInventoryIndividualized" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW501_WarehouseInventoryIndividualized" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW501_WarehouseInventoryIndividualized" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW501_WarehouseInventoryIndividualized" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW501_WarehouseInventoryIndividualized" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW501_WarehouseInventoryIndividualized" } } } } } }, "put": { "tags": [ "xVIEW501_WarehouseInventoryIndividualized" ], "summary": "xVIEW501_WarehouseInventoryIndividualized: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW501_WarehouseInventoryIndividualized-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW501_WarehouseInventoryIndividualized_Put_F38FF219E342", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW501_WarehouseInventoryIndividualized" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW501_WarehouseInventoryIndividualized" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW501_WarehouseInventoryIndividualized" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW501_WarehouseInventoryIndividualized" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW501_WarehouseInventoryIndividualized" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW501_WarehouseInventoryIndividualized" } } } } } } }, "/api/xVIEW501_WarehouseInventoryIndividualized/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "xVIEW501_WarehouseInventoryIndividualized" ], "summary": "xVIEW501_WarehouseInventoryIndividualized: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW501_WarehouseInventoryIndividualized-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW501_WarehouseInventoryIndividualized_GetPageByValue_C8F6143622AA", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW501_WarehouseInventoryIndividualized/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "xVIEW501_WarehouseInventoryIndividualized" ], "summary": "xVIEW501_WarehouseInventoryIndividualized: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW501_WarehouseInventoryIndividualized-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW501_WarehouseInventoryIndividualized_GetPageByValue2_73C39F6C1390", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW501_WarehouseInventoryIndividualized/DeleteByFilter": { "post": { "tags": [ "xVIEW501_WarehouseInventoryIndividualized" ], "summary": "xVIEW501_WarehouseInventoryIndividualized: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW501_WarehouseInventoryIndividualized-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW501_WarehouseInventoryIndividualized_DeleteByFilter_93CCCC90F6BB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/xVIEW501_WarehouseInventoryIndividualized/GetAllByValue": { "post": { "tags": [ "xVIEW501_WarehouseInventoryIndividualized" ], "summary": "xVIEW501_WarehouseInventoryIndividualized: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW501_WarehouseInventoryIndividualized-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW501_WarehouseInventoryIndividualized_GetAllByValue_827DF44A4013", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW501_WarehouseInventoryIndividualized" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW501_WarehouseInventoryIndividualized" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW501_WarehouseInventoryIndividualized" } } } } } } }, "/api/xVIEW501_WarehouseInventoryIndividualized/GetAllGraphByValue": { "post": { "tags": [ "xVIEW501_WarehouseInventoryIndividualized" ], "summary": "xVIEW501_WarehouseInventoryIndividualized: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW501_WarehouseInventoryIndividualized-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW501_WarehouseInventoryIndividualized_GetAllGraphByValue_6A7096335951", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW501_WarehouseInventoryIndividualized" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW501_WarehouseInventoryIndividualized" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW501_WarehouseInventoryIndividualized" } } } } } } }, "/api/xVIEW501_WarehouseInventoryIndividualized/GetByValue": { "post": { "tags": [ "xVIEW501_WarehouseInventoryIndividualized" ], "summary": "xVIEW501_WarehouseInventoryIndividualized: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW501_WarehouseInventoryIndividualized-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW501_WarehouseInventoryIndividualized_GetByValue_9064E867E727", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW501_WarehouseInventoryIndividualized" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW501_WarehouseInventoryIndividualized" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW501_WarehouseInventoryIndividualized" } } } } } } }, "/api/xVIEW501_WarehouseInventoryIndividualized/GetLookup": { "post": { "tags": [ "xVIEW501_WarehouseInventoryIndividualized" ], "summary": "xVIEW501_WarehouseInventoryIndividualized: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW501_WarehouseInventoryIndividualized-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW501_WarehouseInventoryIndividualized_GetLookup_3F9430972C01", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/xVIEW501_WarehouseInventoryIndividualized/GetLookupByValue": { "post": { "tags": [ "xVIEW501_WarehouseInventoryIndividualized" ], "summary": "xVIEW501_WarehouseInventoryIndividualized: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW501_WarehouseInventoryIndividualized-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW501_WarehouseInventoryIndividualized_GetLookupByValue_9FD8D4E57DEF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/xVIEW501_WarehouseInventoryIndividualized/GetPageWarehouseInventoryIndividualizedList": { "get": { "tags": [ "xVIEW501_WarehouseInventoryIndividualized" ], "summary": "xVIEW501_WarehouseInventoryIndividualized: GetPageWarehouseInventoryIndividualizedList", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW501_WarehouseInventoryIndividualized-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW501_WarehouseInventoryIndividualized_GetPageWarehouseInventoryIndividualizedList_D7AAB5202814", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW501_WarehouseInventoryIndividualized/Page": { "get": { "tags": [ "xVIEW501_WarehouseInventoryIndividualized" ], "summary": "xVIEW501_WarehouseInventoryIndividualized: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW501_WarehouseInventoryIndividualized-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW501_WarehouseInventoryIndividualized_GetPage_03C6FBA0061C", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW501_WarehouseInventoryIndividualized/PageAsc": { "get": { "tags": [ "xVIEW501_WarehouseInventoryIndividualized" ], "summary": "xVIEW501_WarehouseInventoryIndividualized: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW501_WarehouseInventoryIndividualized-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW501_WarehouseInventoryIndividualized_GetPageAsc_D65708A17599", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW501_WarehouseInventoryIndividualized/SearchByValue": { "post": { "tags": [ "xVIEW501_WarehouseInventoryIndividualized" ], "summary": "xVIEW501_WarehouseInventoryIndividualized: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW501_WarehouseInventoryIndividualized-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW501_WarehouseInventoryIndividualized_SearchByValue_46A7DCE68C05", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW501_WarehouseInventoryIndividualized" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW501_WarehouseInventoryIndividualized" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW501_WarehouseInventoryIndividualized" } } } } } } }, "/api/xVIEW501_WarehouseInventoryIndividualized/TryGetByValue": { "post": { "tags": [ "xVIEW501_WarehouseInventoryIndividualized" ], "summary": "xVIEW501_WarehouseInventoryIndividualized: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW501_WarehouseInventoryIndividualized-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW501_WarehouseInventoryIndividualized_TryGetByValue_B1CAF18D5B82", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW501_WarehouseInventoryIndividualized" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW501_WarehouseInventoryIndividualized" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW501_WarehouseInventoryIndividualized" } } } } } } }, "/api/xVIEW501_WarehouseInventoryIndividualized/UpsertGraph": { "put": { "tags": [ "xVIEW501_WarehouseInventoryIndividualized" ], "summary": "xVIEW501_WarehouseInventoryIndividualized: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW501_WarehouseInventoryIndividualized-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW501_WarehouseInventoryIndividualized_UpsertGraph_4024EF83071F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW501_WarehouseInventoryIndividualized" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW501_WarehouseInventoryIndividualized" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW501_WarehouseInventoryIndividualized" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW501_WarehouseInventoryIndividualized" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW501_WarehouseInventoryIndividualized" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW501_WarehouseInventoryIndividualized" } } } } } } }, "/api/xVIEW501_WarehouseInventoryIndividualized/UpsertGraphWithExtraFields": { "put": { "tags": [ "xVIEW501_WarehouseInventoryIndividualized" ], "summary": "xVIEW501_WarehouseInventoryIndividualized: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW501_WarehouseInventoryIndividualized-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW501_WarehouseInventoryIndividualized_UpsertGraphWithExtraFields_D3A6473D6D08", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW501_WarehouseInventoryIndividualized" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW501_WarehouseInventoryIndividualized" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW501_WarehouseInventoryIndividualized" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW501_WarehouseInventoryIndividualized" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW501_WarehouseInventoryIndividualized" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW501_WarehouseInventoryIndividualized" } } } } } } }, "/api/xVIEW552_ProcurementPurchase": { "get": { "tags": [ "xVIEW552_ProcurementPurchase" ], "summary": "xVIEW552_ProcurementPurchase: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW552_ProcurementPurchase-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW552_ProcurementPurchase_GetAll_A07D0236899F", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW552_ProcurementPurchase" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW552_ProcurementPurchase" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW552_ProcurementPurchase" } } } } } }, "post": { "tags": [ "xVIEW552_ProcurementPurchase" ], "summary": "xVIEW552_ProcurementPurchase: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW552_ProcurementPurchase-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW552_ProcurementPurchase_Post_4AEC5F25A69E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW552_ProcurementPurchase" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW552_ProcurementPurchase" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW552_ProcurementPurchase" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW552_ProcurementPurchase" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW552_ProcurementPurchase" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW552_ProcurementPurchase" } } } } } }, "put": { "tags": [ "xVIEW552_ProcurementPurchase" ], "summary": "xVIEW552_ProcurementPurchase: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW552_ProcurementPurchase-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW552_ProcurementPurchase_Put_916342EC2353", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW552_ProcurementPurchase" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW552_ProcurementPurchase" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW552_ProcurementPurchase" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW552_ProcurementPurchase" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW552_ProcurementPurchase" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW552_ProcurementPurchase" } } } } } } }, "/api/xVIEW552_ProcurementPurchase/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "xVIEW552_ProcurementPurchase" ], "summary": "xVIEW552_ProcurementPurchase: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW552_ProcurementPurchase-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW552_ProcurementPurchase_GetPageByValue_06E78CAD5064", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW552_ProcurementPurchase/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "xVIEW552_ProcurementPurchase" ], "summary": "xVIEW552_ProcurementPurchase: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW552_ProcurementPurchase-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW552_ProcurementPurchase_GetPageByValue2_60E724CE910F", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW552_ProcurementPurchase/DeleteByFilter": { "post": { "tags": [ "xVIEW552_ProcurementPurchase" ], "summary": "xVIEW552_ProcurementPurchase: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW552_ProcurementPurchase-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW552_ProcurementPurchase_DeleteByFilter_975D84B3374F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/xVIEW552_ProcurementPurchase/GetAllByValue": { "post": { "tags": [ "xVIEW552_ProcurementPurchase" ], "summary": "xVIEW552_ProcurementPurchase: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW552_ProcurementPurchase-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW552_ProcurementPurchase_GetAllByValue_11F3D4D92FAF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW552_ProcurementPurchase" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW552_ProcurementPurchase" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW552_ProcurementPurchase" } } } } } } }, "/api/xVIEW552_ProcurementPurchase/GetAllGraphByValue": { "post": { "tags": [ "xVIEW552_ProcurementPurchase" ], "summary": "xVIEW552_ProcurementPurchase: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW552_ProcurementPurchase-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW552_ProcurementPurchase_GetAllGraphByValue_870323CB76E3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW552_ProcurementPurchase" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW552_ProcurementPurchase" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW552_ProcurementPurchase" } } } } } } }, "/api/xVIEW552_ProcurementPurchase/GetByValue": { "post": { "tags": [ "xVIEW552_ProcurementPurchase" ], "summary": "xVIEW552_ProcurementPurchase: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW552_ProcurementPurchase-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW552_ProcurementPurchase_GetByValue_704F04A6D8CD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW552_ProcurementPurchase" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW552_ProcurementPurchase" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW552_ProcurementPurchase" } } } } } } }, "/api/xVIEW552_ProcurementPurchase/GetLookup": { "post": { "tags": [ "xVIEW552_ProcurementPurchase" ], "summary": "xVIEW552_ProcurementPurchase: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW552_ProcurementPurchase-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW552_ProcurementPurchase_GetLookup_C0C266F1BDF2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/xVIEW552_ProcurementPurchase/GetLookupByValue": { "post": { "tags": [ "xVIEW552_ProcurementPurchase" ], "summary": "xVIEW552_ProcurementPurchase: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW552_ProcurementPurchase-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW552_ProcurementPurchase_GetLookupByValue_E0D76F48ADD7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/xVIEW552_ProcurementPurchase/Page": { "get": { "tags": [ "xVIEW552_ProcurementPurchase" ], "summary": "xVIEW552_ProcurementPurchase: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW552_ProcurementPurchase-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW552_ProcurementPurchase_GetPage_20530ACA7071", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW552_ProcurementPurchase/PageAsc": { "get": { "tags": [ "xVIEW552_ProcurementPurchase" ], "summary": "xVIEW552_ProcurementPurchase: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW552_ProcurementPurchase-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW552_ProcurementPurchase_GetPageAsc_BA92C1FDD18A", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW552_ProcurementPurchase/SearchByValue": { "post": { "tags": [ "xVIEW552_ProcurementPurchase" ], "summary": "xVIEW552_ProcurementPurchase: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW552_ProcurementPurchase-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW552_ProcurementPurchase_SearchByValue_30CAF8ED3EA1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW552_ProcurementPurchase" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW552_ProcurementPurchase" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW552_ProcurementPurchase" } } } } } } }, "/api/xVIEW552_ProcurementPurchase/TryGetByValue": { "post": { "tags": [ "xVIEW552_ProcurementPurchase" ], "summary": "xVIEW552_ProcurementPurchase: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW552_ProcurementPurchase-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW552_ProcurementPurchase_TryGetByValue_3C96B22FD80E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW552_ProcurementPurchase" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW552_ProcurementPurchase" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW552_ProcurementPurchase" } } } } } } }, "/api/xVIEW552_ProcurementPurchase/UpsertGraph": { "put": { "tags": [ "xVIEW552_ProcurementPurchase" ], "summary": "xVIEW552_ProcurementPurchase: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW552_ProcurementPurchase-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW552_ProcurementPurchase_UpsertGraph_2FCCFD1D6AC4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW552_ProcurementPurchase" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW552_ProcurementPurchase" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW552_ProcurementPurchase" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW552_ProcurementPurchase" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW552_ProcurementPurchase" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW552_ProcurementPurchase" } } } } } } }, "/api/xVIEW552_ProcurementPurchase/UpsertGraphWithExtraFields": { "put": { "tags": [ "xVIEW552_ProcurementPurchase" ], "summary": "xVIEW552_ProcurementPurchase: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW552_ProcurementPurchase-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW552_ProcurementPurchase_UpsertGraphWithExtraFields_94959125AF59", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW552_ProcurementPurchase" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW552_ProcurementPurchase" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW552_ProcurementPurchase" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW552_ProcurementPurchase" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW552_ProcurementPurchase" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW552_ProcurementPurchase" } } } } } } }, "/api/xVIEW554_ProcurementProduction": { "get": { "tags": [ "xVIEW554_ProcurementProduction" ], "summary": "xVIEW554_ProcurementProduction: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW554_ProcurementProduction-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW554_ProcurementProduction_GetAll_65F9F63C0D7E", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW554_ProcurementProduction" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW554_ProcurementProduction" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW554_ProcurementProduction" } } } } } }, "post": { "tags": [ "xVIEW554_ProcurementProduction" ], "summary": "xVIEW554_ProcurementProduction: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW554_ProcurementProduction-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW554_ProcurementProduction_Post_A4BA6CC9F88A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW554_ProcurementProduction" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW554_ProcurementProduction" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW554_ProcurementProduction" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW554_ProcurementProduction" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW554_ProcurementProduction" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW554_ProcurementProduction" } } } } } }, "put": { "tags": [ "xVIEW554_ProcurementProduction" ], "summary": "xVIEW554_ProcurementProduction: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW554_ProcurementProduction-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW554_ProcurementProduction_Put_CC1EC1947000", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW554_ProcurementProduction" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW554_ProcurementProduction" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW554_ProcurementProduction" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW554_ProcurementProduction" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW554_ProcurementProduction" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW554_ProcurementProduction" } } } } } } }, "/api/xVIEW554_ProcurementProduction/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "xVIEW554_ProcurementProduction" ], "summary": "xVIEW554_ProcurementProduction: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW554_ProcurementProduction-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW554_ProcurementProduction_GetPageByValue_E56660D45925", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW554_ProcurementProduction/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "xVIEW554_ProcurementProduction" ], "summary": "xVIEW554_ProcurementProduction: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW554_ProcurementProduction-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW554_ProcurementProduction_GetPageByValue2_1E11345E8540", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW554_ProcurementProduction/DeleteByFilter": { "post": { "tags": [ "xVIEW554_ProcurementProduction" ], "summary": "xVIEW554_ProcurementProduction: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW554_ProcurementProduction-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW554_ProcurementProduction_DeleteByFilter_15E03BEF47BB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/xVIEW554_ProcurementProduction/GetAllByValue": { "post": { "tags": [ "xVIEW554_ProcurementProduction" ], "summary": "xVIEW554_ProcurementProduction: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW554_ProcurementProduction-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW554_ProcurementProduction_GetAllByValue_780A5C300B83", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW554_ProcurementProduction" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW554_ProcurementProduction" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW554_ProcurementProduction" } } } } } } }, "/api/xVIEW554_ProcurementProduction/GetAllGraphByValue": { "post": { "tags": [ "xVIEW554_ProcurementProduction" ], "summary": "xVIEW554_ProcurementProduction: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW554_ProcurementProduction-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW554_ProcurementProduction_GetAllGraphByValue_4F1BF02074C1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW554_ProcurementProduction" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW554_ProcurementProduction" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW554_ProcurementProduction" } } } } } } }, "/api/xVIEW554_ProcurementProduction/GetByValue": { "post": { "tags": [ "xVIEW554_ProcurementProduction" ], "summary": "xVIEW554_ProcurementProduction: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW554_ProcurementProduction-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW554_ProcurementProduction_GetByValue_1963CB130418", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW554_ProcurementProduction" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW554_ProcurementProduction" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW554_ProcurementProduction" } } } } } } }, "/api/xVIEW554_ProcurementProduction/GetLookup": { "post": { "tags": [ "xVIEW554_ProcurementProduction" ], "summary": "xVIEW554_ProcurementProduction: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW554_ProcurementProduction-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW554_ProcurementProduction_GetLookup_B70F68ABA648", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/xVIEW554_ProcurementProduction/GetLookupByValue": { "post": { "tags": [ "xVIEW554_ProcurementProduction" ], "summary": "xVIEW554_ProcurementProduction: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW554_ProcurementProduction-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW554_ProcurementProduction_GetLookupByValue_B8E056E23E73", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/xVIEW554_ProcurementProduction/Page": { "get": { "tags": [ "xVIEW554_ProcurementProduction" ], "summary": "xVIEW554_ProcurementProduction: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW554_ProcurementProduction-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW554_ProcurementProduction_GetPage_E109D31C3C88", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW554_ProcurementProduction/PageAsc": { "get": { "tags": [ "xVIEW554_ProcurementProduction" ], "summary": "xVIEW554_ProcurementProduction: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW554_ProcurementProduction-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW554_ProcurementProduction_GetPageAsc_ACF49F260DF9", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW554_ProcurementProduction/SearchByValue": { "post": { "tags": [ "xVIEW554_ProcurementProduction" ], "summary": "xVIEW554_ProcurementProduction: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW554_ProcurementProduction-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW554_ProcurementProduction_SearchByValue_00435E611206", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW554_ProcurementProduction" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW554_ProcurementProduction" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW554_ProcurementProduction" } } } } } } }, "/api/xVIEW554_ProcurementProduction/TryGetByValue": { "post": { "tags": [ "xVIEW554_ProcurementProduction" ], "summary": "xVIEW554_ProcurementProduction: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW554_ProcurementProduction-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW554_ProcurementProduction_TryGetByValue_974FCE493DF0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW554_ProcurementProduction" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW554_ProcurementProduction" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW554_ProcurementProduction" } } } } } } }, "/api/xVIEW554_ProcurementProduction/UpsertGraph": { "put": { "tags": [ "xVIEW554_ProcurementProduction" ], "summary": "xVIEW554_ProcurementProduction: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW554_ProcurementProduction-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW554_ProcurementProduction_UpsertGraph_FC859C4E6FCB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW554_ProcurementProduction" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW554_ProcurementProduction" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW554_ProcurementProduction" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW554_ProcurementProduction" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW554_ProcurementProduction" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW554_ProcurementProduction" } } } } } } }, "/api/xVIEW554_ProcurementProduction/UpsertGraphWithExtraFields": { "put": { "tags": [ "xVIEW554_ProcurementProduction" ], "summary": "xVIEW554_ProcurementProduction: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW554_ProcurementProduction-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW554_ProcurementProduction_UpsertGraphWithExtraFields_5BBB9E6DF033", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW554_ProcurementProduction" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW554_ProcurementProduction" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW554_ProcurementProduction" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW554_ProcurementProduction" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW554_ProcurementProduction" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW554_ProcurementProduction" } } } } } } }, "/api/xVIEW600_FinancePostingDraft": { "get": { "tags": [ "xVIEW600_FinancePostingDraft" ], "summary": "xVIEW600_FinancePostingDraft: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW600_FinancePostingDraft-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW600_FinancePostingDraft_GetAll_1FA0A9A1C135", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW600_FinancePostingDraft" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW600_FinancePostingDraft" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW600_FinancePostingDraft" } } } } } }, "post": { "tags": [ "xVIEW600_FinancePostingDraft" ], "summary": "xVIEW600_FinancePostingDraft: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW600_FinancePostingDraft-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW600_FinancePostingDraft_Post_7F30717EBF31", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW600_FinancePostingDraft" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW600_FinancePostingDraft" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW600_FinancePostingDraft" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW600_FinancePostingDraft" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW600_FinancePostingDraft" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW600_FinancePostingDraft" } } } } } }, "put": { "tags": [ "xVIEW600_FinancePostingDraft" ], "summary": "xVIEW600_FinancePostingDraft: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW600_FinancePostingDraft-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW600_FinancePostingDraft_Put_9C925D5B01C0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW600_FinancePostingDraft" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW600_FinancePostingDraft" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW600_FinancePostingDraft" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW600_FinancePostingDraft" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW600_FinancePostingDraft" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW600_FinancePostingDraft" } } } } } } }, "/api/xVIEW600_FinancePostingDraft/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "xVIEW600_FinancePostingDraft" ], "summary": "xVIEW600_FinancePostingDraft: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW600_FinancePostingDraft-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW600_FinancePostingDraft_GetPageByValue_17A7F722A835", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW600_FinancePostingDraft/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "xVIEW600_FinancePostingDraft" ], "summary": "xVIEW600_FinancePostingDraft: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW600_FinancePostingDraft-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW600_FinancePostingDraft_GetPageByValue2_32BFE43DD163", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW600_FinancePostingDraft/DeleteByFilter": { "post": { "tags": [ "xVIEW600_FinancePostingDraft" ], "summary": "xVIEW600_FinancePostingDraft: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW600_FinancePostingDraft-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW600_FinancePostingDraft_DeleteByFilter_EF99BAB79250", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/xVIEW600_FinancePostingDraft/GetAllByValue": { "post": { "tags": [ "xVIEW600_FinancePostingDraft" ], "summary": "xVIEW600_FinancePostingDraft: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW600_FinancePostingDraft-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW600_FinancePostingDraft_GetAllByValue_66D94794E7A6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW600_FinancePostingDraft" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW600_FinancePostingDraft" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW600_FinancePostingDraft" } } } } } } }, "/api/xVIEW600_FinancePostingDraft/GetAllGraphByValue": { "post": { "tags": [ "xVIEW600_FinancePostingDraft" ], "summary": "xVIEW600_FinancePostingDraft: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW600_FinancePostingDraft-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW600_FinancePostingDraft_GetAllGraphByValue_01BFA62CD3E6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW600_FinancePostingDraft" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW600_FinancePostingDraft" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW600_FinancePostingDraft" } } } } } } }, "/api/xVIEW600_FinancePostingDraft/GetByValue": { "post": { "tags": [ "xVIEW600_FinancePostingDraft" ], "summary": "xVIEW600_FinancePostingDraft: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW600_FinancePostingDraft-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW600_FinancePostingDraft_GetByValue_3199D3C27ED9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW600_FinancePostingDraft" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW600_FinancePostingDraft" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW600_FinancePostingDraft" } } } } } } }, "/api/xVIEW600_FinancePostingDraft/GetLookup": { "post": { "tags": [ "xVIEW600_FinancePostingDraft" ], "summary": "xVIEW600_FinancePostingDraft: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW600_FinancePostingDraft-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW600_FinancePostingDraft_GetLookup_74CAD6B16B43", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/xVIEW600_FinancePostingDraft/GetLookupByValue": { "post": { "tags": [ "xVIEW600_FinancePostingDraft" ], "summary": "xVIEW600_FinancePostingDraft: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW600_FinancePostingDraft-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW600_FinancePostingDraft_GetLookupByValue_AD0E11B89B8B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/xVIEW600_FinancePostingDraft/Page": { "get": { "tags": [ "xVIEW600_FinancePostingDraft" ], "summary": "xVIEW600_FinancePostingDraft: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW600_FinancePostingDraft-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW600_FinancePostingDraft_GetPage_2F1ECE0FAD53", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW600_FinancePostingDraft/PageAsc": { "get": { "tags": [ "xVIEW600_FinancePostingDraft" ], "summary": "xVIEW600_FinancePostingDraft: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW600_FinancePostingDraft-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW600_FinancePostingDraft_GetPageAsc_3BE8656B8479", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW600_FinancePostingDraft/SearchByValue": { "post": { "tags": [ "xVIEW600_FinancePostingDraft" ], "summary": "xVIEW600_FinancePostingDraft: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW600_FinancePostingDraft-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW600_FinancePostingDraft_SearchByValue_F3DEEF167371", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW600_FinancePostingDraft" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW600_FinancePostingDraft" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW600_FinancePostingDraft" } } } } } } }, "/api/xVIEW600_FinancePostingDraft/TryGetByValue": { "post": { "tags": [ "xVIEW600_FinancePostingDraft" ], "summary": "xVIEW600_FinancePostingDraft: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW600_FinancePostingDraft-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW600_FinancePostingDraft_TryGetByValue_500FFDE261A9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW600_FinancePostingDraft" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW600_FinancePostingDraft" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW600_FinancePostingDraft" } } } } } } }, "/api/xVIEW600_FinancePostingDraft/UpsertGraph": { "put": { "tags": [ "xVIEW600_FinancePostingDraft" ], "summary": "xVIEW600_FinancePostingDraft: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW600_FinancePostingDraft-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW600_FinancePostingDraft_UpsertGraph_747034F39FDF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW600_FinancePostingDraft" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW600_FinancePostingDraft" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW600_FinancePostingDraft" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW600_FinancePostingDraft" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW600_FinancePostingDraft" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW600_FinancePostingDraft" } } } } } } }, "/api/xVIEW600_FinancePostingDraft/UpsertGraphWithExtraFields": { "put": { "tags": [ "xVIEW600_FinancePostingDraft" ], "summary": "xVIEW600_FinancePostingDraft: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW600_FinancePostingDraft-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW600_FinancePostingDraft_UpsertGraphWithExtraFields_0B3CBB2E8A40", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW600_FinancePostingDraft" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW600_FinancePostingDraft" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW600_FinancePostingDraft" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW600_FinancePostingDraft" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW600_FinancePostingDraft" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW600_FinancePostingDraft" } } } } } } }, "/api/xVIEW600_FinancePostingList": { "get": { "tags": [ "xVIEW600_FinancePostingList" ], "summary": "xVIEW600_FinancePostingList: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW600_FinancePostingList-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW600_FinancePostingList_GetAll_C8B77592C549", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW600_FinancePostingList" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW600_FinancePostingList" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW600_FinancePostingList" } } } } } }, "post": { "tags": [ "xVIEW600_FinancePostingList" ], "summary": "xVIEW600_FinancePostingList: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW600_FinancePostingList-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW600_FinancePostingList_Post_E789814E20D8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW600_FinancePostingList" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW600_FinancePostingList" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW600_FinancePostingList" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW600_FinancePostingList" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW600_FinancePostingList" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW600_FinancePostingList" } } } } } }, "put": { "tags": [ "xVIEW600_FinancePostingList" ], "summary": "xVIEW600_FinancePostingList: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW600_FinancePostingList-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW600_FinancePostingList_Put_71B165BA6989", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW600_FinancePostingList" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW600_FinancePostingList" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW600_FinancePostingList" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW600_FinancePostingList" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW600_FinancePostingList" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW600_FinancePostingList" } } } } } } }, "/api/xVIEW600_FinancePostingList/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "xVIEW600_FinancePostingList" ], "summary": "xVIEW600_FinancePostingList: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW600_FinancePostingList-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW600_FinancePostingList_GetPageByValue_29ED06ED8C50", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW600_FinancePostingList/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "xVIEW600_FinancePostingList" ], "summary": "xVIEW600_FinancePostingList: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW600_FinancePostingList-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW600_FinancePostingList_GetPageByValue2_ECE7A2EB631C", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW600_FinancePostingList/DeleteByFilter": { "post": { "tags": [ "xVIEW600_FinancePostingList" ], "summary": "xVIEW600_FinancePostingList: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW600_FinancePostingList-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW600_FinancePostingList_DeleteByFilter_3A798523A9A8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/xVIEW600_FinancePostingList/GetAllByValue": { "post": { "tags": [ "xVIEW600_FinancePostingList" ], "summary": "xVIEW600_FinancePostingList: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW600_FinancePostingList-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW600_FinancePostingList_GetAllByValue_110EC9B84ADB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW600_FinancePostingList" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW600_FinancePostingList" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW600_FinancePostingList" } } } } } } }, "/api/xVIEW600_FinancePostingList/GetAllGraphByValue": { "post": { "tags": [ "xVIEW600_FinancePostingList" ], "summary": "xVIEW600_FinancePostingList: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW600_FinancePostingList-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW600_FinancePostingList_GetAllGraphByValue_EB426ACB2A42", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW600_FinancePostingList" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW600_FinancePostingList" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW600_FinancePostingList" } } } } } } }, "/api/xVIEW600_FinancePostingList/GetByValue": { "post": { "tags": [ "xVIEW600_FinancePostingList" ], "summary": "xVIEW600_FinancePostingList: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW600_FinancePostingList-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW600_FinancePostingList_GetByValue_5D613597338B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW600_FinancePostingList" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW600_FinancePostingList" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW600_FinancePostingList" } } } } } } }, "/api/xVIEW600_FinancePostingList/GetLookup": { "post": { "tags": [ "xVIEW600_FinancePostingList" ], "summary": "xVIEW600_FinancePostingList: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW600_FinancePostingList-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW600_FinancePostingList_GetLookup_C96D2C9C6CCF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/xVIEW600_FinancePostingList/GetLookupByValue": { "post": { "tags": [ "xVIEW600_FinancePostingList" ], "summary": "xVIEW600_FinancePostingList: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW600_FinancePostingList-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW600_FinancePostingList_GetLookupByValue_AAC32B5A297C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/xVIEW600_FinancePostingList/Page": { "get": { "tags": [ "xVIEW600_FinancePostingList" ], "summary": "xVIEW600_FinancePostingList: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW600_FinancePostingList-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW600_FinancePostingList_GetPage_CDAB9482D8B6", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW600_FinancePostingList/PageAsc": { "get": { "tags": [ "xVIEW600_FinancePostingList" ], "summary": "xVIEW600_FinancePostingList: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW600_FinancePostingList-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW600_FinancePostingList_GetPageAsc_026D859AD900", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW600_FinancePostingList/SearchByValue": { "post": { "tags": [ "xVIEW600_FinancePostingList" ], "summary": "xVIEW600_FinancePostingList: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW600_FinancePostingList-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW600_FinancePostingList_SearchByValue_49841342A674", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW600_FinancePostingList" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW600_FinancePostingList" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW600_FinancePostingList" } } } } } } }, "/api/xVIEW600_FinancePostingList/TryGetByValue": { "post": { "tags": [ "xVIEW600_FinancePostingList" ], "summary": "xVIEW600_FinancePostingList: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW600_FinancePostingList-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW600_FinancePostingList_TryGetByValue_0FFCCF311EB2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW600_FinancePostingList" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW600_FinancePostingList" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW600_FinancePostingList" } } } } } } }, "/api/xVIEW600_FinancePostingList/UpsertGraph": { "put": { "tags": [ "xVIEW600_FinancePostingList" ], "summary": "xVIEW600_FinancePostingList: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW600_FinancePostingList-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW600_FinancePostingList_UpsertGraph_3C0975FF0B62", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW600_FinancePostingList" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW600_FinancePostingList" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW600_FinancePostingList" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW600_FinancePostingList" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW600_FinancePostingList" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW600_FinancePostingList" } } } } } } }, "/api/xVIEW600_FinancePostingList/UpsertGraphWithExtraFields": { "put": { "tags": [ "xVIEW600_FinancePostingList" ], "summary": "xVIEW600_FinancePostingList: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW600_FinancePostingList-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW600_FinancePostingList_UpsertGraphWithExtraFields_EB5E45BD0996", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW600_FinancePostingList" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW600_FinancePostingList" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW600_FinancePostingList" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW600_FinancePostingList" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW600_FinancePostingList" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW600_FinancePostingList" } } } } } } }, "/api/xVIEW600_FinancePostingPositionDraft": { "get": { "tags": [ "xVIEW600_FinancePostingPositionDraft" ], "summary": "xVIEW600_FinancePostingPositionDraft: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW600_FinancePostingPositionDraft-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW600_FinancePostingPositionDraft_GetAll_A61A586B447F", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW600_FinancePostingPositionDraft" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW600_FinancePostingPositionDraft" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW600_FinancePostingPositionDraft" } } } } } }, "post": { "tags": [ "xVIEW600_FinancePostingPositionDraft" ], "summary": "xVIEW600_FinancePostingPositionDraft: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW600_FinancePostingPositionDraft-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW600_FinancePostingPositionDraft_Post_C96BD13828C1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW600_FinancePostingPositionDraft" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW600_FinancePostingPositionDraft" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW600_FinancePostingPositionDraft" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW600_FinancePostingPositionDraft" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW600_FinancePostingPositionDraft" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW600_FinancePostingPositionDraft" } } } } } }, "put": { "tags": [ "xVIEW600_FinancePostingPositionDraft" ], "summary": "xVIEW600_FinancePostingPositionDraft: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW600_FinancePostingPositionDraft-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW600_FinancePostingPositionDraft_Put_1B5B22DC4434", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW600_FinancePostingPositionDraft" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW600_FinancePostingPositionDraft" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW600_FinancePostingPositionDraft" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW600_FinancePostingPositionDraft" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW600_FinancePostingPositionDraft" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW600_FinancePostingPositionDraft" } } } } } } }, "/api/xVIEW600_FinancePostingPositionDraft/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "xVIEW600_FinancePostingPositionDraft" ], "summary": "xVIEW600_FinancePostingPositionDraft: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW600_FinancePostingPositionDraft-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW600_FinancePostingPositionDraft_GetPageByValue_58F113A54408", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW600_FinancePostingPositionDraft/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "xVIEW600_FinancePostingPositionDraft" ], "summary": "xVIEW600_FinancePostingPositionDraft: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW600_FinancePostingPositionDraft-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW600_FinancePostingPositionDraft_GetPageByValue2_A32F80131DDF", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW600_FinancePostingPositionDraft/DeleteByFilter": { "post": { "tags": [ "xVIEW600_FinancePostingPositionDraft" ], "summary": "xVIEW600_FinancePostingPositionDraft: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW600_FinancePostingPositionDraft-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW600_FinancePostingPositionDraft_DeleteByFilter_B3509AAC4099", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/xVIEW600_FinancePostingPositionDraft/GetAllByValue": { "post": { "tags": [ "xVIEW600_FinancePostingPositionDraft" ], "summary": "xVIEW600_FinancePostingPositionDraft: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW600_FinancePostingPositionDraft-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW600_FinancePostingPositionDraft_GetAllByValue_338594F0BAE3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW600_FinancePostingPositionDraft" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW600_FinancePostingPositionDraft" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW600_FinancePostingPositionDraft" } } } } } } }, "/api/xVIEW600_FinancePostingPositionDraft/GetAllGraphByValue": { "post": { "tags": [ "xVIEW600_FinancePostingPositionDraft" ], "summary": "xVIEW600_FinancePostingPositionDraft: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW600_FinancePostingPositionDraft-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW600_FinancePostingPositionDraft_GetAllGraphByValue_2A65B50A82B0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW600_FinancePostingPositionDraft" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW600_FinancePostingPositionDraft" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW600_FinancePostingPositionDraft" } } } } } } }, "/api/xVIEW600_FinancePostingPositionDraft/GetByValue": { "post": { "tags": [ "xVIEW600_FinancePostingPositionDraft" ], "summary": "xVIEW600_FinancePostingPositionDraft: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW600_FinancePostingPositionDraft-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW600_FinancePostingPositionDraft_GetByValue_0F8DFF406E6D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW600_FinancePostingPositionDraft" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW600_FinancePostingPositionDraft" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW600_FinancePostingPositionDraft" } } } } } } }, "/api/xVIEW600_FinancePostingPositionDraft/GetLookup": { "post": { "tags": [ "xVIEW600_FinancePostingPositionDraft" ], "summary": "xVIEW600_FinancePostingPositionDraft: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW600_FinancePostingPositionDraft-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW600_FinancePostingPositionDraft_GetLookup_D93BDEBCE0B8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/xVIEW600_FinancePostingPositionDraft/GetLookupByValue": { "post": { "tags": [ "xVIEW600_FinancePostingPositionDraft" ], "summary": "xVIEW600_FinancePostingPositionDraft: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW600_FinancePostingPositionDraft-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW600_FinancePostingPositionDraft_GetLookupByValue_0B8C20E7DF70", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/xVIEW600_FinancePostingPositionDraft/Page": { "get": { "tags": [ "xVIEW600_FinancePostingPositionDraft" ], "summary": "xVIEW600_FinancePostingPositionDraft: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW600_FinancePostingPositionDraft-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW600_FinancePostingPositionDraft_GetPage_198FF4E34488", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW600_FinancePostingPositionDraft/PageAsc": { "get": { "tags": [ "xVIEW600_FinancePostingPositionDraft" ], "summary": "xVIEW600_FinancePostingPositionDraft: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW600_FinancePostingPositionDraft-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW600_FinancePostingPositionDraft_GetPageAsc_12665593813F", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW600_FinancePostingPositionDraft/SearchByValue": { "post": { "tags": [ "xVIEW600_FinancePostingPositionDraft" ], "summary": "xVIEW600_FinancePostingPositionDraft: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW600_FinancePostingPositionDraft-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW600_FinancePostingPositionDraft_SearchByValue_6716BDE869CE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW600_FinancePostingPositionDraft" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW600_FinancePostingPositionDraft" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW600_FinancePostingPositionDraft" } } } } } } }, "/api/xVIEW600_FinancePostingPositionDraft/TryGetByValue": { "post": { "tags": [ "xVIEW600_FinancePostingPositionDraft" ], "summary": "xVIEW600_FinancePostingPositionDraft: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW600_FinancePostingPositionDraft-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW600_FinancePostingPositionDraft_TryGetByValue_F42DF7A434BB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW600_FinancePostingPositionDraft" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW600_FinancePostingPositionDraft" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW600_FinancePostingPositionDraft" } } } } } } }, "/api/xVIEW600_FinancePostingPositionDraft/UpsertGraph": { "put": { "tags": [ "xVIEW600_FinancePostingPositionDraft" ], "summary": "xVIEW600_FinancePostingPositionDraft: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW600_FinancePostingPositionDraft-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW600_FinancePostingPositionDraft_UpsertGraph_AEF523749665", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW600_FinancePostingPositionDraft" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW600_FinancePostingPositionDraft" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW600_FinancePostingPositionDraft" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW600_FinancePostingPositionDraft" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW600_FinancePostingPositionDraft" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW600_FinancePostingPositionDraft" } } } } } } }, "/api/xVIEW600_FinancePostingPositionDraft/UpsertGraphWithExtraFields": { "put": { "tags": [ "xVIEW600_FinancePostingPositionDraft" ], "summary": "xVIEW600_FinancePostingPositionDraft: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW600_FinancePostingPositionDraft-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW600_FinancePostingPositionDraft_UpsertGraphWithExtraFields_CE82D87486C1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW600_FinancePostingPositionDraft" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW600_FinancePostingPositionDraft" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW600_FinancePostingPositionDraft" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW600_FinancePostingPositionDraft" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW600_FinancePostingPositionDraft" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW600_FinancePostingPositionDraft" } } } } } } }, "/api/xVIEW605_FinanceAccountPlan": { "get": { "tags": [ "xVIEW605_FinanceAccountPlan" ], "summary": "xVIEW605_FinanceAccountPlan: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW605_FinanceAccountPlan-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW605_FinanceAccountPlan_GetAll_AC0D38A1C06C", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW605_FinanceAccountPlan" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW605_FinanceAccountPlan" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW605_FinanceAccountPlan" } } } } } }, "post": { "tags": [ "xVIEW605_FinanceAccountPlan" ], "summary": "xVIEW605_FinanceAccountPlan: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW605_FinanceAccountPlan-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW605_FinanceAccountPlan_Post_C44D942B536E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW605_FinanceAccountPlan" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW605_FinanceAccountPlan" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW605_FinanceAccountPlan" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW605_FinanceAccountPlan" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW605_FinanceAccountPlan" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW605_FinanceAccountPlan" } } } } } }, "put": { "tags": [ "xVIEW605_FinanceAccountPlan" ], "summary": "xVIEW605_FinanceAccountPlan: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW605_FinanceAccountPlan-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW605_FinanceAccountPlan_Put_EF79A72366FD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW605_FinanceAccountPlan" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW605_FinanceAccountPlan" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW605_FinanceAccountPlan" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW605_FinanceAccountPlan" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW605_FinanceAccountPlan" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW605_FinanceAccountPlan" } } } } } } }, "/api/xVIEW605_FinanceAccountPlan/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "xVIEW605_FinanceAccountPlan" ], "summary": "xVIEW605_FinanceAccountPlan: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW605_FinanceAccountPlan-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW605_FinanceAccountPlan_GetPageByValue_94EF8B7F03B1", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW605_FinanceAccountPlan/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "xVIEW605_FinanceAccountPlan" ], "summary": "xVIEW605_FinanceAccountPlan: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW605_FinanceAccountPlan-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW605_FinanceAccountPlan_GetPageByValue2_FA81091CC954", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW605_FinanceAccountPlan/DeleteByFilter": { "post": { "tags": [ "xVIEW605_FinanceAccountPlan" ], "summary": "xVIEW605_FinanceAccountPlan: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW605_FinanceAccountPlan-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW605_FinanceAccountPlan_DeleteByFilter_B8BA6E3927FD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/xVIEW605_FinanceAccountPlan/GetAllByValue": { "post": { "tags": [ "xVIEW605_FinanceAccountPlan" ], "summary": "xVIEW605_FinanceAccountPlan: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW605_FinanceAccountPlan-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW605_FinanceAccountPlan_GetAllByValue_56B287278BDA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW605_FinanceAccountPlan" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW605_FinanceAccountPlan" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW605_FinanceAccountPlan" } } } } } } }, "/api/xVIEW605_FinanceAccountPlan/GetAllGraphByValue": { "post": { "tags": [ "xVIEW605_FinanceAccountPlan" ], "summary": "xVIEW605_FinanceAccountPlan: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW605_FinanceAccountPlan-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW605_FinanceAccountPlan_GetAllGraphByValue_6DD646B7FFAF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW605_FinanceAccountPlan" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW605_FinanceAccountPlan" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW605_FinanceAccountPlan" } } } } } } }, "/api/xVIEW605_FinanceAccountPlan/GetByValue": { "post": { "tags": [ "xVIEW605_FinanceAccountPlan" ], "summary": "xVIEW605_FinanceAccountPlan: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW605_FinanceAccountPlan-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW605_FinanceAccountPlan_GetByValue_2B94B36DDEBD", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW605_FinanceAccountPlan" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW605_FinanceAccountPlan" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW605_FinanceAccountPlan" } } } } } } }, "/api/xVIEW605_FinanceAccountPlan/GetLookup": { "post": { "tags": [ "xVIEW605_FinanceAccountPlan" ], "summary": "xVIEW605_FinanceAccountPlan: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW605_FinanceAccountPlan-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW605_FinanceAccountPlan_GetLookup_9D68D36E43A2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/xVIEW605_FinanceAccountPlan/GetLookupByValue": { "post": { "tags": [ "xVIEW605_FinanceAccountPlan" ], "summary": "xVIEW605_FinanceAccountPlan: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW605_FinanceAccountPlan-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW605_FinanceAccountPlan_GetLookupByValue_43196B859AD9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/xVIEW605_FinanceAccountPlan/Page": { "get": { "tags": [ "xVIEW605_FinanceAccountPlan" ], "summary": "xVIEW605_FinanceAccountPlan: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW605_FinanceAccountPlan-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW605_FinanceAccountPlan_GetPage_433D7E031186", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW605_FinanceAccountPlan/PageAsc": { "get": { "tags": [ "xVIEW605_FinanceAccountPlan" ], "summary": "xVIEW605_FinanceAccountPlan: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW605_FinanceAccountPlan-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW605_FinanceAccountPlan_GetPageAsc_3818A9B85C1F", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW605_FinanceAccountPlan/SearchByValue": { "post": { "tags": [ "xVIEW605_FinanceAccountPlan" ], "summary": "xVIEW605_FinanceAccountPlan: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW605_FinanceAccountPlan-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW605_FinanceAccountPlan_SearchByValue_B9FDBEEB3A53", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW605_FinanceAccountPlan" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW605_FinanceAccountPlan" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW605_FinanceAccountPlan" } } } } } } }, "/api/xVIEW605_FinanceAccountPlan/TryGetByValue": { "post": { "tags": [ "xVIEW605_FinanceAccountPlan" ], "summary": "xVIEW605_FinanceAccountPlan: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW605_FinanceAccountPlan-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW605_FinanceAccountPlan_TryGetByValue_9F758FDDB77E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW605_FinanceAccountPlan" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW605_FinanceAccountPlan" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW605_FinanceAccountPlan" } } } } } } }, "/api/xVIEW605_FinanceAccountPlan/UpsertGraph": { "put": { "tags": [ "xVIEW605_FinanceAccountPlan" ], "summary": "xVIEW605_FinanceAccountPlan: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW605_FinanceAccountPlan-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW605_FinanceAccountPlan_UpsertGraph_F927ECACC717", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW605_FinanceAccountPlan" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW605_FinanceAccountPlan" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW605_FinanceAccountPlan" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW605_FinanceAccountPlan" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW605_FinanceAccountPlan" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW605_FinanceAccountPlan" } } } } } } }, "/api/xVIEW605_FinanceAccountPlan/UpsertGraphWithExtraFields": { "put": { "tags": [ "xVIEW605_FinanceAccountPlan" ], "summary": "xVIEW605_FinanceAccountPlan: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW605_FinanceAccountPlan-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW605_FinanceAccountPlan_UpsertGraphWithExtraFields_45AC9CFDC0EE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW605_FinanceAccountPlan" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW605_FinanceAccountPlan" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW605_FinanceAccountPlan" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW605_FinanceAccountPlan" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW605_FinanceAccountPlan" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW605_FinanceAccountPlan" } } } } } } }, "/api/xVIEW660_FinanceTransferPosition": { "get": { "tags": [ "xVIEW660_FinanceTransferPosition" ], "summary": "xVIEW660_FinanceTransferPosition: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW660_FinanceTransferPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW660_FinanceTransferPosition_GetAll_15B92C8256B0", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW660_FinanceTransferPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW660_FinanceTransferPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW660_FinanceTransferPosition" } } } } } }, "post": { "tags": [ "xVIEW660_FinanceTransferPosition" ], "summary": "xVIEW660_FinanceTransferPosition: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW660_FinanceTransferPosition-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW660_FinanceTransferPosition_Post_F5C5572A5CDB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW660_FinanceTransferPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW660_FinanceTransferPosition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW660_FinanceTransferPosition" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW660_FinanceTransferPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW660_FinanceTransferPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW660_FinanceTransferPosition" } } } } } }, "put": { "tags": [ "xVIEW660_FinanceTransferPosition" ], "summary": "xVIEW660_FinanceTransferPosition: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW660_FinanceTransferPosition-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW660_FinanceTransferPosition_Put_2FFDB06D57C3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW660_FinanceTransferPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW660_FinanceTransferPosition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW660_FinanceTransferPosition" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW660_FinanceTransferPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW660_FinanceTransferPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW660_FinanceTransferPosition" } } } } } } }, "/api/xVIEW660_FinanceTransferPosition/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "xVIEW660_FinanceTransferPosition" ], "summary": "xVIEW660_FinanceTransferPosition: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW660_FinanceTransferPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW660_FinanceTransferPosition_GetPageByValue_417207F53523", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW660_FinanceTransferPosition/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "xVIEW660_FinanceTransferPosition" ], "summary": "xVIEW660_FinanceTransferPosition: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW660_FinanceTransferPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW660_FinanceTransferPosition_GetPageByValue2_4A09BEC68757", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW660_FinanceTransferPosition/DeleteByFilter": { "post": { "tags": [ "xVIEW660_FinanceTransferPosition" ], "summary": "xVIEW660_FinanceTransferPosition: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW660_FinanceTransferPosition-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW660_FinanceTransferPosition_DeleteByFilter_3E352A9ABBC8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/xVIEW660_FinanceTransferPosition/GetAllByValue": { "post": { "tags": [ "xVIEW660_FinanceTransferPosition" ], "summary": "xVIEW660_FinanceTransferPosition: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW660_FinanceTransferPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW660_FinanceTransferPosition_GetAllByValue_CEED6102831B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW660_FinanceTransferPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW660_FinanceTransferPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW660_FinanceTransferPosition" } } } } } } }, "/api/xVIEW660_FinanceTransferPosition/GetAllGraphByValue": { "post": { "tags": [ "xVIEW660_FinanceTransferPosition" ], "summary": "xVIEW660_FinanceTransferPosition: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW660_FinanceTransferPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW660_FinanceTransferPosition_GetAllGraphByValue_C2ABB1E789C7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW660_FinanceTransferPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW660_FinanceTransferPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW660_FinanceTransferPosition" } } } } } } }, "/api/xVIEW660_FinanceTransferPosition/GetByValue": { "post": { "tags": [ "xVIEW660_FinanceTransferPosition" ], "summary": "xVIEW660_FinanceTransferPosition: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW660_FinanceTransferPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW660_FinanceTransferPosition_GetByValue_F51A7159037A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW660_FinanceTransferPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW660_FinanceTransferPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW660_FinanceTransferPosition" } } } } } } }, "/api/xVIEW660_FinanceTransferPosition/GetLookup": { "post": { "tags": [ "xVIEW660_FinanceTransferPosition" ], "summary": "xVIEW660_FinanceTransferPosition: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW660_FinanceTransferPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW660_FinanceTransferPosition_GetLookup_F44D3E524BA7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/xVIEW660_FinanceTransferPosition/GetLookupByValue": { "post": { "tags": [ "xVIEW660_FinanceTransferPosition" ], "summary": "xVIEW660_FinanceTransferPosition: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW660_FinanceTransferPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW660_FinanceTransferPosition_GetLookupByValue_3E4018DCED11", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/xVIEW660_FinanceTransferPosition/Page": { "get": { "tags": [ "xVIEW660_FinanceTransferPosition" ], "summary": "xVIEW660_FinanceTransferPosition: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW660_FinanceTransferPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW660_FinanceTransferPosition_GetPage_A9B5672D0443", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW660_FinanceTransferPosition/PageAsc": { "get": { "tags": [ "xVIEW660_FinanceTransferPosition" ], "summary": "xVIEW660_FinanceTransferPosition: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW660_FinanceTransferPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW660_FinanceTransferPosition_GetPageAsc_411963A15815", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW660_FinanceTransferPosition/SearchByValue": { "post": { "tags": [ "xVIEW660_FinanceTransferPosition" ], "summary": "xVIEW660_FinanceTransferPosition: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW660_FinanceTransferPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW660_FinanceTransferPosition_SearchByValue_A59997349F48", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW660_FinanceTransferPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW660_FinanceTransferPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW660_FinanceTransferPosition" } } } } } } }, "/api/xVIEW660_FinanceTransferPosition/TryGetByValue": { "post": { "tags": [ "xVIEW660_FinanceTransferPosition" ], "summary": "xVIEW660_FinanceTransferPosition: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW660_FinanceTransferPosition-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW660_FinanceTransferPosition_TryGetByValue_94BB45FF2709", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW660_FinanceTransferPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW660_FinanceTransferPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW660_FinanceTransferPosition" } } } } } } }, "/api/xVIEW660_FinanceTransferPosition/UpsertGraph": { "put": { "tags": [ "xVIEW660_FinanceTransferPosition" ], "summary": "xVIEW660_FinanceTransferPosition: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW660_FinanceTransferPosition-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW660_FinanceTransferPosition_UpsertGraph_AA2E92FA69C2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW660_FinanceTransferPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW660_FinanceTransferPosition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW660_FinanceTransferPosition" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW660_FinanceTransferPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW660_FinanceTransferPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW660_FinanceTransferPosition" } } } } } } }, "/api/xVIEW660_FinanceTransferPosition/UpsertGraphWithExtraFields": { "put": { "tags": [ "xVIEW660_FinanceTransferPosition" ], "summary": "xVIEW660_FinanceTransferPosition: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW660_FinanceTransferPosition-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW660_FinanceTransferPosition_UpsertGraphWithExtraFields_3427CBF516E3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW660_FinanceTransferPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW660_FinanceTransferPosition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW660_FinanceTransferPosition" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW660_FinanceTransferPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW660_FinanceTransferPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW660_FinanceTransferPosition" } } } } } } }, "/api/xVIEW670_DueAndOverDue": { "get": { "tags": [ "xVIEW670_DueAndOverDue" ], "summary": "xVIEW670_DueAndOverDue: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW670_DueAndOverDue-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW670_DueAndOverDue_GetAll_634083D25E1C", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW670_DueAndOverDue" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW670_DueAndOverDue" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW670_DueAndOverDue" } } } } } }, "post": { "tags": [ "xVIEW670_DueAndOverDue" ], "summary": "xVIEW670_DueAndOverDue: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW670_DueAndOverDue-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW670_DueAndOverDue_Post_39550EFC98F3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW670_DueAndOverDue" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW670_DueAndOverDue" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW670_DueAndOverDue" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW670_DueAndOverDue" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW670_DueAndOverDue" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW670_DueAndOverDue" } } } } } }, "put": { "tags": [ "xVIEW670_DueAndOverDue" ], "summary": "xVIEW670_DueAndOverDue: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW670_DueAndOverDue-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW670_DueAndOverDue_Put_9A5068394B7F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW670_DueAndOverDue" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW670_DueAndOverDue" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW670_DueAndOverDue" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW670_DueAndOverDue" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW670_DueAndOverDue" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW670_DueAndOverDue" } } } } } } }, "/api/xVIEW670_DueAndOverDue/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "xVIEW670_DueAndOverDue" ], "summary": "xVIEW670_DueAndOverDue: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW670_DueAndOverDue-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW670_DueAndOverDue_GetPageByValue_5F6C8D28D654", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW670_DueAndOverDue/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "xVIEW670_DueAndOverDue" ], "summary": "xVIEW670_DueAndOverDue: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW670_DueAndOverDue-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW670_DueAndOverDue_GetPageByValue2_527DBF362940", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW670_DueAndOverDue/DeleteByFilter": { "post": { "tags": [ "xVIEW670_DueAndOverDue" ], "summary": "xVIEW670_DueAndOverDue: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW670_DueAndOverDue-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW670_DueAndOverDue_DeleteByFilter_69E0B6E84C92", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/xVIEW670_DueAndOverDue/GetAllByValue": { "post": { "tags": [ "xVIEW670_DueAndOverDue" ], "summary": "xVIEW670_DueAndOverDue: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW670_DueAndOverDue-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW670_DueAndOverDue_GetAllByValue_01A82DCC6FE5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW670_DueAndOverDue" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW670_DueAndOverDue" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW670_DueAndOverDue" } } } } } } }, "/api/xVIEW670_DueAndOverDue/GetAllGraphByValue": { "post": { "tags": [ "xVIEW670_DueAndOverDue" ], "summary": "xVIEW670_DueAndOverDue: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW670_DueAndOverDue-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW670_DueAndOverDue_GetAllGraphByValue_662ED681CFB0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW670_DueAndOverDue" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW670_DueAndOverDue" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW670_DueAndOverDue" } } } } } } }, "/api/xVIEW670_DueAndOverDue/GetByValue": { "post": { "tags": [ "xVIEW670_DueAndOverDue" ], "summary": "xVIEW670_DueAndOverDue: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW670_DueAndOverDue-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW670_DueAndOverDue_GetByValue_D788069BC489", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW670_DueAndOverDue" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW670_DueAndOverDue" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW670_DueAndOverDue" } } } } } } }, "/api/xVIEW670_DueAndOverDue/GetLookup": { "post": { "tags": [ "xVIEW670_DueAndOverDue" ], "summary": "xVIEW670_DueAndOverDue: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW670_DueAndOverDue-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW670_DueAndOverDue_GetLookup_3F88E8C8D869", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/xVIEW670_DueAndOverDue/GetLookupByValue": { "post": { "tags": [ "xVIEW670_DueAndOverDue" ], "summary": "xVIEW670_DueAndOverDue: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW670_DueAndOverDue-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW670_DueAndOverDue_GetLookupByValue_065D1B856216", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/xVIEW670_DueAndOverDue/Page": { "get": { "tags": [ "xVIEW670_DueAndOverDue" ], "summary": "xVIEW670_DueAndOverDue: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW670_DueAndOverDue-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW670_DueAndOverDue_GetPage_636976041401", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW670_DueAndOverDue/PageAsc": { "get": { "tags": [ "xVIEW670_DueAndOverDue" ], "summary": "xVIEW670_DueAndOverDue: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW670_DueAndOverDue-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW670_DueAndOverDue_GetPageAsc_519EBDCB6FE6", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW670_DueAndOverDue/SearchByValue": { "post": { "tags": [ "xVIEW670_DueAndOverDue" ], "summary": "xVIEW670_DueAndOverDue: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW670_DueAndOverDue-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW670_DueAndOverDue_SearchByValue_77A69A3D2B49", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW670_DueAndOverDue" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW670_DueAndOverDue" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW670_DueAndOverDue" } } } } } } }, "/api/xVIEW670_DueAndOverDue/TryGetByValue": { "post": { "tags": [ "xVIEW670_DueAndOverDue" ], "summary": "xVIEW670_DueAndOverDue: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW670_DueAndOverDue-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW670_DueAndOverDue_TryGetByValue_8F260E650CE8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW670_DueAndOverDue" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW670_DueAndOverDue" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW670_DueAndOverDue" } } } } } } }, "/api/xVIEW670_DueAndOverDue/UpsertGraph": { "put": { "tags": [ "xVIEW670_DueAndOverDue" ], "summary": "xVIEW670_DueAndOverDue: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW670_DueAndOverDue-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW670_DueAndOverDue_UpsertGraph_1A720B31307C", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW670_DueAndOverDue" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW670_DueAndOverDue" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW670_DueAndOverDue" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW670_DueAndOverDue" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW670_DueAndOverDue" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW670_DueAndOverDue" } } } } } } }, "/api/xVIEW670_DueAndOverDue/UpsertGraphWithExtraFields": { "put": { "tags": [ "xVIEW670_DueAndOverDue" ], "summary": "xVIEW670_DueAndOverDue: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW670_DueAndOverDue-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW670_DueAndOverDue_UpsertGraphWithExtraFields_1538E6B76D85", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW670_DueAndOverDue" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW670_DueAndOverDue" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW670_DueAndOverDue" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW670_DueAndOverDue" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW670_DueAndOverDue" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW670_DueAndOverDue" } } } } } } }, "/api/xVIEW821_CountryPackageIntrastatCandidate": { "get": { "tags": [ "xVIEW821_CountryPackageIntrastatCandidate" ], "summary": "xVIEW821_CountryPackageIntrastatCandidate: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW821_CountryPackageIntrastatCandidate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW821_CountryPackageIntrastatCandidate_GetAll_1F5777B690DD", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW821_CountryPackageIntrastatCandidate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW821_CountryPackageIntrastatCandidate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW821_CountryPackageIntrastatCandidate" } } } } } }, "post": { "tags": [ "xVIEW821_CountryPackageIntrastatCandidate" ], "summary": "xVIEW821_CountryPackageIntrastatCandidate: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW821_CountryPackageIntrastatCandidate-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW821_CountryPackageIntrastatCandidate_Post_B8825989FA29", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW821_CountryPackageIntrastatCandidate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW821_CountryPackageIntrastatCandidate" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW821_CountryPackageIntrastatCandidate" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW821_CountryPackageIntrastatCandidate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW821_CountryPackageIntrastatCandidate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW821_CountryPackageIntrastatCandidate" } } } } } }, "put": { "tags": [ "xVIEW821_CountryPackageIntrastatCandidate" ], "summary": "xVIEW821_CountryPackageIntrastatCandidate: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW821_CountryPackageIntrastatCandidate-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW821_CountryPackageIntrastatCandidate_Put_C3A3393F4CA1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW821_CountryPackageIntrastatCandidate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW821_CountryPackageIntrastatCandidate" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW821_CountryPackageIntrastatCandidate" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW821_CountryPackageIntrastatCandidate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW821_CountryPackageIntrastatCandidate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW821_CountryPackageIntrastatCandidate" } } } } } } }, "/api/xVIEW821_CountryPackageIntrastatCandidate/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "xVIEW821_CountryPackageIntrastatCandidate" ], "summary": "xVIEW821_CountryPackageIntrastatCandidate: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW821_CountryPackageIntrastatCandidate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW821_CountryPackageIntrastatCandidate_GetPageByValue_7F3348C0F271", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW821_CountryPackageIntrastatCandidate/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "xVIEW821_CountryPackageIntrastatCandidate" ], "summary": "xVIEW821_CountryPackageIntrastatCandidate: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW821_CountryPackageIntrastatCandidate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW821_CountryPackageIntrastatCandidate_GetPageByValue2_9189890DAD80", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW821_CountryPackageIntrastatCandidate/DeleteByFilter": { "post": { "tags": [ "xVIEW821_CountryPackageIntrastatCandidate" ], "summary": "xVIEW821_CountryPackageIntrastatCandidate: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW821_CountryPackageIntrastatCandidate-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW821_CountryPackageIntrastatCandidate_DeleteByFilter_E1E12490D618", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/xVIEW821_CountryPackageIntrastatCandidate/GetAllByValue": { "post": { "tags": [ "xVIEW821_CountryPackageIntrastatCandidate" ], "summary": "xVIEW821_CountryPackageIntrastatCandidate: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW821_CountryPackageIntrastatCandidate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW821_CountryPackageIntrastatCandidate_GetAllByValue_F980ACDF8F7B", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW821_CountryPackageIntrastatCandidate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW821_CountryPackageIntrastatCandidate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW821_CountryPackageIntrastatCandidate" } } } } } } }, "/api/xVIEW821_CountryPackageIntrastatCandidate/GetAllGraphByValue": { "post": { "tags": [ "xVIEW821_CountryPackageIntrastatCandidate" ], "summary": "xVIEW821_CountryPackageIntrastatCandidate: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW821_CountryPackageIntrastatCandidate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW821_CountryPackageIntrastatCandidate_GetAllGraphByValue_7AB28C0542DC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW821_CountryPackageIntrastatCandidate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW821_CountryPackageIntrastatCandidate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW821_CountryPackageIntrastatCandidate" } } } } } } }, "/api/xVIEW821_CountryPackageIntrastatCandidate/GetByValue": { "post": { "tags": [ "xVIEW821_CountryPackageIntrastatCandidate" ], "summary": "xVIEW821_CountryPackageIntrastatCandidate: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW821_CountryPackageIntrastatCandidate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW821_CountryPackageIntrastatCandidate_GetByValue_C5A592B80924", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW821_CountryPackageIntrastatCandidate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW821_CountryPackageIntrastatCandidate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW821_CountryPackageIntrastatCandidate" } } } } } } }, "/api/xVIEW821_CountryPackageIntrastatCandidate/GetLookup": { "post": { "tags": [ "xVIEW821_CountryPackageIntrastatCandidate" ], "summary": "xVIEW821_CountryPackageIntrastatCandidate: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW821_CountryPackageIntrastatCandidate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW821_CountryPackageIntrastatCandidate_GetLookup_1C8AEF8002A7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/xVIEW821_CountryPackageIntrastatCandidate/GetLookupByValue": { "post": { "tags": [ "xVIEW821_CountryPackageIntrastatCandidate" ], "summary": "xVIEW821_CountryPackageIntrastatCandidate: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW821_CountryPackageIntrastatCandidate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW821_CountryPackageIntrastatCandidate_GetLookupByValue_4FC26109B9AF", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/xVIEW821_CountryPackageIntrastatCandidate/Page": { "get": { "tags": [ "xVIEW821_CountryPackageIntrastatCandidate" ], "summary": "xVIEW821_CountryPackageIntrastatCandidate: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW821_CountryPackageIntrastatCandidate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW821_CountryPackageIntrastatCandidate_GetPage_A88F5A5453BC", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW821_CountryPackageIntrastatCandidate/PageAsc": { "get": { "tags": [ "xVIEW821_CountryPackageIntrastatCandidate" ], "summary": "xVIEW821_CountryPackageIntrastatCandidate: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW821_CountryPackageIntrastatCandidate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW821_CountryPackageIntrastatCandidate_GetPageAsc_612B16CCBFA2", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/xVIEW821_CountryPackageIntrastatCandidate/SearchByValue": { "post": { "tags": [ "xVIEW821_CountryPackageIntrastatCandidate" ], "summary": "xVIEW821_CountryPackageIntrastatCandidate: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW821_CountryPackageIntrastatCandidate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW821_CountryPackageIntrastatCandidate_SearchByValue_AFB27B17237E", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW821_CountryPackageIntrastatCandidate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW821_CountryPackageIntrastatCandidate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW821_CountryPackageIntrastatCandidate" } } } } } } }, "/api/xVIEW821_CountryPackageIntrastatCandidate/TryGetByValue": { "post": { "tags": [ "xVIEW821_CountryPackageIntrastatCandidate" ], "summary": "xVIEW821_CountryPackageIntrastatCandidate: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW821_CountryPackageIntrastatCandidate-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW821_CountryPackageIntrastatCandidate_TryGetByValue_5EF69ED31310", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW821_CountryPackageIntrastatCandidate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW821_CountryPackageIntrastatCandidate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW821_CountryPackageIntrastatCandidate" } } } } } } }, "/api/xVIEW821_CountryPackageIntrastatCandidate/UpsertGraph": { "put": { "tags": [ "xVIEW821_CountryPackageIntrastatCandidate" ], "summary": "xVIEW821_CountryPackageIntrastatCandidate: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW821_CountryPackageIntrastatCandidate-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW821_CountryPackageIntrastatCandidate_UpsertGraph_EE8E541574A0", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW821_CountryPackageIntrastatCandidate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW821_CountryPackageIntrastatCandidate" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW821_CountryPackageIntrastatCandidate" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW821_CountryPackageIntrastatCandidate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW821_CountryPackageIntrastatCandidate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW821_CountryPackageIntrastatCandidate" } } } } } } }, "/api/xVIEW821_CountryPackageIntrastatCandidate/UpsertGraphWithExtraFields": { "put": { "tags": [ "xVIEW821_CountryPackageIntrastatCandidate" ], "summary": "xVIEW821_CountryPackageIntrastatCandidate: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: xVIEW821_CountryPackageIntrastatCandidate-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "xVIEW821_CountryPackageIntrastatCandidate_UpsertGraphWithExtraFields_6BAA76473116", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW821_CountryPackageIntrastatCandidate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW821_CountryPackageIntrastatCandidate" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW821_CountryPackageIntrastatCandidate" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW821_CountryPackageIntrastatCandidate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW821_CountryPackageIntrastatCandidate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW821_CountryPackageIntrastatCandidate" } } } } } } }, "/api/XXField/GetLookupForForeignKeyTable": { "post": { "tags": [ "XXField" ], "summary": "XXField: GetLookupForForeignKeyTable", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: XXField-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "XXField_GetLookupForForeignKeyTable_FE4ADF0CB720", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.XXFieldLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.XXFieldLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.XXFieldLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem_Of_System.String" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem_Of_System.String" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem_Of_System.String" } } } } } } }, "/api/XXField/GetXXFieldsData": { "post": { "tags": [ "XXField" ], "summary": "XXField: GetXXFieldsData", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: XXField-Read.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "XXField_GetXXFieldsData_3FFDB04B9F46", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GetXXFieldsDataRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GetXXFieldsDataRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GetXXFieldsDataRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_System.Collections.Generic.Dictionary_Of_System.String_And_System.Object" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_System.Collections.Generic.Dictionary_Of_System.String_And_System.Object" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_System.Collections.Generic.Dictionary_Of_System.String_And_System.Object" } } } } } } }, "/api/XXField/UpdateXXFieldsData": { "post": { "tags": [ "XXField" ], "summary": "XXField: UpdateXXFieldsData", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: XXField-Update.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "XXField_UpdateXXFieldsData_55078255BAFE", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/XXTable": { "get": { "tags": [ "XXTable" ], "summary": "XXTable: GetAll", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: XXTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "XXTable_GetAll_C944D104C587", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.XXTable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.XXTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.XXTable" } } } } } }, "post": { "tags": [ "XXTable" ], "summary": "XXTable: Post", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: XXTable-Create.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "XXTable_Post_75A4911A43CA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.XXTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.XXTable" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.XXTable" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.XXTable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.XXTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.XXTable" } } } } } }, "put": { "tags": [ "XXTable" ], "summary": "XXTable: Put", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: XXTable-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "XXTable_Put_38C57C26635A", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.XXTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.XXTable" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.XXTable" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.XXTable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.XXTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.XXTable" } } } } } } }, "/api/XXTable/{PropertyName}/{Value}/PageByValue": { "get": { "tags": [ "XXTable" ], "summary": "XXTable: GetPageByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: XXTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "XXTable_GetPageByValue_2D54142CD921", "parameters": [ { "name": "PropertyName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/XXTable/{PropertyName1}/{Value1}/{PropertyName2}/{Value2}/PageByValue": { "get": { "tags": [ "XXTable" ], "summary": "XXTable: GetPageByValue2", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: XXTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "XXTable_GetPageByValue2_A363B69A84A4", "parameters": [ { "name": "PropertyName1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value1", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PropertyName2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Value2", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/XXTable/DeleteByFilter": { "post": { "tags": [ "XXTable" ], "summary": "XXTable: DeleteByFilter", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: XXTable-Delete.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "XXTable_DeleteByFilter_C964402E21EA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Boolean" } } } } } } }, "/api/XXTable/DeleteRow": { "post": { "tags": [ "XXTable" ], "summary": "XXTable: DeleteRow", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: XXTable-Delete.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "XXTable_DeleteRow_1A4CEE86D34F", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Server.Controllers.XXTableRowDeleteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Server.Controllers.XXTableRowDeleteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Server.Controllers.XXTableRowDeleteRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.String" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.String" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.String" } } } } } } }, "/api/XXTable/GetAllByValue": { "post": { "tags": [ "XXTable" ], "summary": "XXTable: GetAllByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: XXTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "XXTable_GetAllByValue_1A0F175E9A4D", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.XXTable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.XXTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.XXTable" } } } } } } }, "/api/XXTable/GetAllGraphByValue": { "post": { "tags": [ "XXTable" ], "summary": "XXTable: GetAllGraphByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: XXTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "XXTable_GetAllGraphByValue_6580F5B34FA6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.XXTable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.XXTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.XXTable" } } } } } } }, "/api/XXTable/GetByValue": { "post": { "tags": [ "XXTable" ], "summary": "XXTable: GetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: XXTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "XXTable_GetByValue_012E0E40FD44", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.XXTable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.XXTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.XXTable" } } } } } } }, "/api/XXTable/GetLookup": { "post": { "tags": [ "XXTable" ], "summary": "XXTable: GetLookup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: XXTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "XXTable_GetLookup_908D544D5FB8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/XXTable/GetLookupByValue": { "post": { "tags": [ "XXTable" ], "summary": "XXTable: GetLookupByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: XXTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "XXTable_GetLookupByValue_657971819AE5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericLookupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem" } } } } } } }, "/api/XXTable/InsertRow": { "post": { "tags": [ "XXTable" ], "summary": "XXTable: InsertRow", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: XXTable-Create.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "XXTable_InsertRow_9FB1B1301FDA", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Server.Controllers.XXTableRowInsertRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Server.Controllers.XXTableRowInsertRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Server.Controllers.XXTableRowInsertRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Server.Controllers.InsertRowResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Server.Controllers.InsertRowResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Server.Controllers.InsertRowResponse" } } } } } } }, "/api/XXTable/Page": { "get": { "tags": [ "XXTable" ], "summary": "XXTable: GetPage", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: XXTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "XXTable_GetPage_79F1645A0E8A", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/XXTable/PageAsc": { "get": { "tags": [ "XXTable" ], "summary": "XXTable: GetPageAsc", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: XXTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "XXTable_GetPageAsc_335B582BCD38", "parameters": [ { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/XXTable/PageFromDB/{XXTableName}": { "get": { "tags": [ "XXTable" ], "summary": "XXTable: GetPageFromDB", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: XXTable-Read.\n\nGrid options are individual query parameters, not a JSON request body. sort, group, filter, select, totalSummary and groupSummary contain URL-encoded JSON. Always supply a positive take (recommended 50; maximum 1000). Negative skip becomes 0. Individual actions may implement only a subset of grid options; grouped results differ from ordinary lists.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "XXTable_GetPageFromDB_3E29C664B9C7", "parameters": [ { "name": "XXTableName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "Number of rows to skip. Negative values are normalized to 0.", "schema": { "type": "integer" } }, { "name": "take", "in": "query", "description": "Requested page size. Use 1–1000; values above 1000 are clamped. Do not rely on zero or omitted take for bounded paging.", "schema": { "type": "integer" } }, { "name": "requireTotalCount", "in": "query", "description": "Request the total row count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "requireGroupCount", "in": "query", "description": "Request the group count when supported by the action.", "schema": { "type": "boolean" } }, { "name": "isCountQuery", "in": "query", "description": "Request a count-only result when supported by the action.", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "description": "JSON sorting array, for example [{\"selector\":\"Id\",\"desc\":false}].", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "JSON grouping array; action-specific support.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "JSON filter expression, for example [\"Id\",\"=\",123]. Field names are entity property names.", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "JSON array of selected field names; action-specific support.", "schema": { "type": "string" } }, { "name": "totalSummary", "in": "query", "description": "JSON total-summary descriptors; action-specific support.", "schema": { "type": "string" } }, { "name": "groupSummary", "in": "query", "description": "JSON group-summary descriptors; action-specific support.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/XXTable/SearchByValue": { "post": { "tags": [ "XXTable" ], "summary": "XXTable: SearchByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: XXTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "XXTable_SearchByValue_A1330C92AAE9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.XXTable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.XXTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.XXTable" } } } } } } }, "/api/XXTable/TryGetByValue": { "post": { "tags": [ "XXTable" ], "summary": "XXTable: TryGetByValue", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: XXTable-Read.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "XXTable_TryGetByValue_4F5E679DEA63", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.GenericQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.XXTable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.XXTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.XXTable" } } } } } } }, "/api/XXTable/UpsertGraph": { "put": { "tags": [ "XXTable" ], "summary": "XXTable: UpsertGraph", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: XXTable-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "XXTable_UpsertGraph_DFCF5E3F50F9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.XXTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.XXTable" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.XXTable" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.XXTable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.XXTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.XXTable" } } } } } } }, "/api/XXTable/UpsertGraphWithExtraFields": { "put": { "tags": [ "XXTable" ], "summary": "XXTable: UpsertGraphWithExtraFields", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: XXTable-Update.\n\nInherited entity operation. Follow the generic-operation conventions in API-Developer-Guide.md; entity validation and relationships still apply.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "XXTable_UpsertGraphWithExtraFields_468E9F9BFE01", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.XXTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.XXTable" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.XXTable" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.XXTable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.XXTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.XXTable" } } } } } } }, "/DatabaseBackup/Backup": { "post": { "tags": [ "DatabaseBackup" ], "summary": "DatabaseBackup: Backup", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DatabaseBackup-Create.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DatabaseBackup_Backup_54EA7E420A03", "responses": { "200": { "description": "OK" } } } }, "/DatabaseBackup/Maintenance": { "post": { "tags": [ "DatabaseBackup" ], "summary": "DatabaseBackup: RunMaintenance", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DatabaseBackup-Update.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DatabaseBackup_RunMaintenance_81CE85BFC9FD", "responses": { "200": { "description": "OK" } } } }, "/DatabaseBackup/ShrinkLogExceptionally": { "post": { "tags": [ "DatabaseBackup" ], "summary": "DatabaseBackup: ShrinkLogExceptionally", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: DatabaseBackup-Update.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "DatabaseBackup_ShrinkLogExceptionally_1ED319659F29", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Maintenance.ExceptionalLogShrinkRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Maintenance.ExceptionalLogShrinkRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Maintenance.ExceptionalLogShrinkRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Maintenance.DatabaseMaintenanceOperationResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Maintenance.DatabaseMaintenanceOperationResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Models.Maintenance.DatabaseMaintenanceOperationResult" } } } } } } }, "/Maintenance/CheckConstraints": { "post": { "tags": [ "Maintenance" ], "summary": "Maintenance: CheckConstraints", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Maintenance-Create.\n\nThe action does not declare a concrete success response type. No success payload schema is inferred; consult the operation-specific guide or confirm a sample in a test environment before generating a client.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Maintenance_CheckConstraints_286DB4E3C95C", "responses": { "200": { "description": "OK" } } } }, "/Maintenance/RecompileDependentViews": { "post": { "tags": [ "Maintenance" ], "summary": "Maintenance: RecompileDependentViews", "description": "Requires an authenticated X-ERP application session. Company context comes from the login session.\n\nWeb API permission checks: Maintenance-Create.\n\nResponse formats vary by operation. For APIEntityResponse payloads, check success even on HTTP 200. Unexpected failures handled by the API middleware return HTTP 500 with an error ID; see the developer guide.", "operationId": "Maintenance_RecompileDependentViews_CDF3B37FEAAA", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.String" } }, "application/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.String" } }, "text/json": { "schema": { "$ref": "#/components/schemas/XERP.Shared.Context.APIEntityResponse_Of_System.String" } } } } } } } }, "components": { "schemas": { "DevExtreme.AspNet.Data.GroupingInfo": { "type": "object", "properties": { "selector": { "type": "string", "nullable": true }, "desc": { "type": "boolean" }, "groupInterval": { "type": "string", "nullable": true }, "isExpanded": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "DevExtreme.AspNet.Data.SortingInfo": { "type": "object", "properties": { "selector": { "type": "string", "nullable": true }, "desc": { "type": "boolean" } }, "additionalProperties": false }, "DevExtreme.AspNet.Data.SummaryInfo": { "type": "object", "properties": { "selector": { "type": "string", "nullable": true }, "summaryType": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Microsoft.Data.SqlTypes.SqlVector_Of_System.Single": { "type": "object", "properties": { "isNull": { "type": "boolean", "readOnly": true }, "length": { "type": "integer", "format": "int32", "readOnly": true }, "memory": { "$ref": "#/components/schemas/System.ReadOnlyMemory_Of_System.Single" } }, "additionalProperties": false }, "Microsoft.EntityFrameworkCore.HierarchyId": { "type": "object", "additionalProperties": false }, "System.ReadOnlyMemory_Of_System.Single": { "type": "object", "properties": { "length": { "type": "integer", "format": "int32", "readOnly": true }, "isEmpty": { "type": "boolean", "readOnly": true }, "span": { "$ref": "#/components/schemas/System.ReadOnlySpan_Of_System.Single" } }, "additionalProperties": false }, "System.ReadOnlySpan_Of_System.Single": { "type": "object", "properties": { "length": { "type": "integer", "format": "int32", "readOnly": true }, "isEmpty": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "XERP.Client.ApiClients.CalendarInfoRequest": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time" }, "calendarNameIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true } }, "additionalProperties": false }, "XERP.Server.Controllers.AI.AIAssistantRequest": { "type": "object", "properties": { "question": { "type": "string", "nullable": true }, "context": { "type": "string", "nullable": true }, "conversationId": { "type": "string", "nullable": true }, "imageBase64": { "type": "string", "nullable": true }, "imageMimeType": { "type": "string", "nullable": true }, "fileBase64": { "type": "string", "nullable": true }, "fileMimeType": { "type": "string", "nullable": true }, "fileName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Server.Controllers.AI.AICustomEmailPromptRequest": { "type": "object", "properties": { "aiEmailInfoId": { "type": "integer", "format": "int32" }, "emailBody": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Server.Controllers.AI.AICustomTextPromptRequest": { "type": "object", "properties": { "aiTextInfoId": { "type": "integer", "format": "int32" }, "text": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Server.Controllers.AI.AIExtractPartnerFromEmailRequest": { "type": "object", "properties": { "emailId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Server.Controllers.AI.AISaveDroppedFileRequest": { "type": "object", "properties": { "fileName": { "type": "string", "nullable": true }, "fileMimeType": { "type": "string", "nullable": true }, "fileBase64": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Server.Controllers.AI.AIStyleRequest": { "type": "object", "properties": { "text": { "type": "string", "nullable": true }, "style": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Server.Controllers.AI.AITextRequest": { "type": "object", "properties": { "text": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Server.Controllers.AI.AIToneRequest": { "type": "object", "properties": { "text": { "type": "string", "nullable": true }, "tone": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Server.Controllers.AI.AITranslateRequest": { "type": "object", "properties": { "text": { "type": "string", "nullable": true }, "language": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Server.Controllers.CreateSessionRequest": { "type": "object", "properties": { "partnerId": { "type": "integer", "format": "int32" }, "tokenHash": { "type": "string", "nullable": true }, "expiresAt": { "type": "string", "format": "date-time", "nullable": true }, "deviceInfo": { "type": "string", "nullable": true }, "ipAddress": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Server.Controllers.InsertRowResponse": { "type": "object", "properties": { "generatedId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Server.Controllers.PartnerCredentialValidationRequest": { "type": "object", "properties": { "email": { "type": "string", "nullable": true }, "password": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Server.Controllers.PartnerCredentialValidationResult": { "type": "object", "properties": { "isValid": { "type": "boolean" }, "isLockedOut": { "type": "boolean" }, "requiresPasswordChange": { "type": "boolean" }, "requiresRehash": { "type": "boolean" }, "partner": { "$ref": "#/components/schemas/XERP.Server.Controllers.PartnerValidationDto" } }, "additionalProperties": false }, "XERP.Server.Controllers.PartnerSessionInfo": { "type": "object", "properties": { "tokenHash": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "expiresAt": { "type": "string", "format": "date-time" }, "lastActivityAt": { "type": "string", "format": "date-time", "nullable": true }, "deviceInfo": { "type": "string", "nullable": true }, "ipAddress": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Server.Controllers.PartnerTokenKeyRequest": { "type": "object", "properties": { "partnerId": { "type": "integer", "format": "int32" }, "loginProvider": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Server.Controllers.PartnerValidationDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "email": { "type": "string", "nullable": true }, "normalizedEmail": { "type": "string", "nullable": true }, "emailConfirmed": { "type": "boolean" }, "matchcode": { "type": "string", "nullable": true }, "name1": { "type": "string", "nullable": true }, "name2": { "type": "string", "nullable": true }, "name3": { "type": "string", "nullable": true }, "street": { "type": "string", "nullable": true }, "zip": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "countryId": { "type": "string", "nullable": true }, "tel1": { "type": "string", "nullable": true }, "tel2": { "type": "string", "nullable": true }, "mobile": { "type": "string", "nullable": true }, "fax": { "type": "string", "nullable": true }, "homepage": { "type": "string", "nullable": true }, "languageId": { "type": "string", "nullable": true }, "privatePerson": { "type": "boolean" }, "twoFactorEnabled": { "type": "boolean" }, "securityStamp": { "type": "string", "nullable": true }, "lockoutEnabled": { "type": "boolean" }, "active": { "type": "boolean" }, "dateCreated": { "type": "string", "format": "date-time" }, "dateModified": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "XERP.Server.Controllers.PasskeyWithPartnerResult": { "type": "object", "properties": { "passkey": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerPasskey" }, "partner": { "$ref": "#/components/schemas/XERP.Shared.Models.Partner" } }, "additionalProperties": false }, "XERP.Server.Controllers.RemovePasskeyRequest": { "type": "object", "properties": { "partnerId": { "type": "integer", "format": "int32" }, "credentialId": { "type": "string", "format": "byte", "nullable": true } }, "additionalProperties": false }, "XERP.Server.Controllers.RevokeAllSessionsRequest": { "type": "object", "properties": { "partnerId": { "type": "integer", "format": "int32" }, "excludeTokenHash": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Server.Controllers.ValidateSessionRequest": { "type": "object", "properties": { "partnerId": { "type": "integer", "format": "int32" }, "tokenHash": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Server.Controllers.XXTableRowDeleteRequest": { "type": "object", "properties": { "tableName": { "type": "string", "nullable": true }, "keyFieldName": { "type": "string", "nullable": true }, "keyFieldValue": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Server.Controllers.XXTableRowInsertRequest": { "type": "object", "properties": { "tableName": { "type": "string", "nullable": true }, "fieldsData": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.XXFieldWithValue" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Boolean": { "type": "object", "properties": { "data": { "type": "boolean" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.Dictionary_Of_System.String_And_System.String": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AdminApiAuthType": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminApiAuthType" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AdminBank": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminBank" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AdminBankAccountEBankingType": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminBankAccountEBankingType" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AdminCompanySetting": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCompanySetting" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AdminCountry": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCountry" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AdminCurrency": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCurrency" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AdminCurrencyApi": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCurrencyApi" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AdminCurrencyRate": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCurrencyRate" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AdminDecimalPlace": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminDecimalPlace" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AdminEDocType": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminEDocType" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AdminFederalState": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminFederalState" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AdminFiscalPeriod": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminFiscalPeriod" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AdminLanguage": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminLanguage" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AdminLocation": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminLocation" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AdminMonth": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminMonth" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AdminProgramAiLanguage": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminProgramAiLanguage" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AdminProgramSetting": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminProgramSetting" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AdminRoute": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminRoute" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AdminSvg": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminSvg" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AdminTimeZone": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminTimeZone" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AdminYear": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminYear" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AdminZip": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminZip" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AiChatInfo": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.AiChatInfo" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AiChatSetting": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.AiChatSetting" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AiEmailInfo": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.AiEmailInfo" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AiEmbedding": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.AiEmbedding" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AiTextInfo": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.AiTextInfo" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AppUser": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.AppUser" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.Archive": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Archive" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArchiveDunning": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArchiveDunning" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.Article": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Article" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleAccessory": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleAccessory" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleCategory": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleCategory" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleCategoryName": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleCategoryName" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleCost": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleCost" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleDimensionText": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleDimensionText" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleEInvoiceUoM": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleEInvoiceUoM" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleGroup": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleGroup" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleIndividualization": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleIndividualization" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleIndividualizationQuantity": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleIndividualizationQuantity" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleIndividualizationType": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleIndividualizationType" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleInfoText": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleInfoText" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleMacro": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleMacro" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleOrderText": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleOrderText" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticlePicture": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticlePicture" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticlePriceCalculation": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticlePriceCalculation" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticlePriceUnit": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticlePriceUnit" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleProcurementType": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProcurementType" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleProduct": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProduct" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleProductDependencyType": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProductDependencyType" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleProductionStepComponent": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProductionStepComponent" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleProductionStepComponentType": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProductionStepComponentType" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleProductionStepResource": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProductionStepResource" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleQuantity": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleQuantity" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleSalesPriceList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleSalesPriceList" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleSalesPriceListName": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleSalesPriceListName" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleSet": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleSet" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleTemplate": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleTemplate" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleType": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleType" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleUoM": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleUoM" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ArticleUoMConversion": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleUoMConversion" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.Attachment": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Attachment" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AttachmentFile": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.AttachmentFile" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AttachmentStatus": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.AttachmentStatus" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AuthorizationPage": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.AuthorizationPage" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.AuthorizationWebApi": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.AuthorizationWebApi" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.Bulletin": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Bulletin" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.BulletinCategory": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.BulletinCategory" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.BulletinRead": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.BulletinRead" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CalendarAppointment": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarAppointment" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CalendarAppointmentAttachment": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarAppointmentAttachment" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CalendarAppointmentCategory": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarAppointmentCategory" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CalendarHoliday": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarHoliday" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CalendarName": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarName" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CalendarWeekDay": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarWeekDay" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CalendarWorkingDay": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarWorkingDay" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CountryPackageDatevExport": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageDatevExport" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CountryPackageElsterExport": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageElsterExport" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CountryPackageIntrastatArticle": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatArticle" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CountryPackageIntrastatCommodityCode": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatCommodityCode" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CountryPackageIntrastatDeclaration": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDeclaration" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CountryPackageIntrastatDeclarationPosition": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDeclarationPosition" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CountryPackageIntrastatDeclarationStatus": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDeclarationStatus" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CountryPackageIntrastatDirection": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDirection" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CountryPackageIntrastatDocPosition": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDocPosition" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CountryPackageIntrastatPartner": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatPartner" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CountryPackageIntrastatReportingEntity": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatReportingEntity" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CountryPackageIntrastatTransactionType": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatTransactionType" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CountryPackageIntrastatTransportMode": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatTransportMode" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CountryPackagePrivacyProcessingActivity": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackagePrivacyProcessingActivity" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CountryPackagePrivacyProcessingActivityObject": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackagePrivacyProcessingActivityObject" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.Crm": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Crm" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CrmActivity": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CrmActivity" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CrmActivityType": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CrmActivityType" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CrmGroup": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CrmGroup" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CrmStatus": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CrmStatus" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.CrmType": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CrmType" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.Dashboard": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Dashboard" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DeviceService": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DeviceService" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.Doc": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocApproval": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocApproval" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocBillingAddress": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocBillingAddress" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocCategory": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocCategory" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocContract": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocContract" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocContractCyclePeriod": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocContractCyclePeriod" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocContractStatus": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocContractStatus" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocDeliveryAddress": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocDeliveryAddress" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocFooterText": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocFooterText" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocHeaderText": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocHeaderText" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocPosition": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocPositionDimensionText": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionDimensionText" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocPositionInfoText": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionInfoText" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocPositionOrderText": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionOrderText" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocPositionStatus": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionStatus" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocPositionType": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionType" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocPositionWarehousing": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionWarehousing" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocStatus": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocStatus" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocType": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocType" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocTypeInventoryStatus": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocTypeInventoryStatus" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocTypePrepaymentFactor": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocTypePrepaymentFactor" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocTypeRevenueEffective": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocTypeRevenueEffective" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocTypeWarehousingEffective": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocTypeWarehousingEffective" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocXml": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXml" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocXmlAssignment": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXmlAssignment" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.DocXmlPosition": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXmlPosition" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.Email": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Email" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmailAccount": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailAccount" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmailAttachment": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailAttachment" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmailFolder": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailFolder" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmailLog": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailLog" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmailRuleField": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailRuleField" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmailRuleIn": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailRuleIn" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmailRuleOut": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailRuleOut" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmailSignature": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailSignature" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmailSignatureAttachment": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailSignatureAttachment" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmailSpamProtectionSender": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailSpamProtectionSender" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmailSpamProtectionSubject": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailSpamProtectionSubject" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmailSystem": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailSystem" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmailTemplate": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailTemplate" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmailTemplateAttachment": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailTemplateAttachment" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmailTemplateGroup": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailTemplateGroup" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.Employee": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Employee" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmployeeCommissionGroup": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeCommissionGroup" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmployeeCommissionGroupName": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeCommissionGroupName" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmployeeGroup": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeGroup" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmployeeVacationEntitlement": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeVacationEntitlement" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmployeeVacationRequest": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeVacationRequest" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmployeeVacationRequestApproval": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeVacationRequestApproval" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmployeeVacationType": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeVacationType" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.EmployeeVacationYear": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeVacationYear" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ExternalAspNetRole": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetRole" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ExternalAspNetRoleClaim": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetRoleClaim" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ExternalAspNetUser": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetUser" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ExternalAspNetUserClaim": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetUserClaim" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ExternalAspNetUserLogin": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetUserLogin" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ExternalAspNetUserToken": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetUserToken" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ExternalAuthorizationPage": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAuthorizationPage" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ExternalAuthorizationRolePagePermission": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAuthorizationRolePagePermission" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ExternalAuthorizationRoleWebApiPermission": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAuthorizationRoleWebApiPermission" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ExternalAuthorizationWebApi": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAuthorizationWebApi" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ExtraApi": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraApi" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ExtraCode": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraCode" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ExtraField": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraField" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ExtraPage": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraPage" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ExtraPlugin": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraPlugin" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ExtraTable": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraTable" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ExtraTableIndexType": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraTableIndexType" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FieldService": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FieldService" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FieldServiceResource": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FieldServiceResource" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FieldServiceResourceGroup": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FieldServiceResourceGroup" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FieldServiceResourceSegment": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FieldServiceResourceSegment" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FieldServiceStatus": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FieldServiceStatus" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceAccountAssignment": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountAssignment" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceAccountCategory": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountCategory" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceAccountDetermination": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountDetermination" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceAccountGroup": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountGroup" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceAccountInternalReconciliation": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountInternalReconciliation" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceAccountInternalReconciliationPosition": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountInternalReconciliationPosition" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceAccountPlan": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountPlan" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceAccountPurpose": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountPurpose" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceAccountType": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountType" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceBalanceGroup": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceBalanceGroup" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceBusinessAssessmentGroup": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceBusinessAssessmentGroup" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceClosingPosting": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceClosingPosting" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceClosingPostingPosition": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceClosingPostingPosition" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceCompanyBankAccount": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceCompanyBankAccount" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceCostBearer": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceCostBearer" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceCostCenter": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceCostCenter" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceCostType": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceCostType" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceDunning": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceDunning" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceDunningLevel": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceDunningLevel" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceDunningPosition": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceDunningPosition" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceEInvoiceTaxKeyCategory": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceEInvoiceTaxKeyCategory" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceFixedAsset": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAsset" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceFixedAssetClass": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetClass" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationCyclePeriod": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDepreciationCyclePeriod" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationMethod": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDepreciationMethod" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationPlan": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDepreciationPlan" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationType": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDepreciationType" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationTypeDetail": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDepreciationTypeDetail" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceFixedAssetDetail": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDetail" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceFixedAssetGroup": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetGroup" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceFixedAssetStatus": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetStatus" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceGroupArticle": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceGroupArticle" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceGroupArticleDetail": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceGroupArticleDetail" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceGroupPartner": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceGroupPartner" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceOpenItem": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItem" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceOpenItemInternalReconciliation": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItemInternalReconciliation" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceOpenItemInternalReconciliationPosition": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItemInternalReconciliationPosition" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceOpenItemOrigin": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItemOrigin" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceOpenItemStatus": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItemStatus" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceOpenItemType": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItemType" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceOpeningBalance": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpeningBalance" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceOpeningBalancePosition": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpeningBalancePosition" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinancePayment": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePayment" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinancePaymentPosition": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePaymentPosition" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinancePosting": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePosting" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinancePostingDraft": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingDraft" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinancePostingPeriod": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPeriod" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinancePostingPeriodStatus": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPeriodStatus" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinancePostingPosition": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPosition" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinancePostingPositionDraft": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionDraft" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinancePostingPositionTemplate": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionTemplate" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinancePostingSource": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingSource" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinancePostingStatus": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingStatus" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinancePostingTemplate": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingTemplate" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceProfitLossGroup": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceProfitLossGroup" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceTaxKey": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTaxKey" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceTaxKeyDetail": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTaxKeyDetail" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceTaxKeyKind": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTaxKeyKind" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceTransfer": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransfer" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceTransferBankStatement": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferBankStatement" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceTransferCategory": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferCategory" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceTransferCategoryAccountType": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferCategoryAccountType" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceTransferPosition": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPosition" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceTransferPositionAccountPlan": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionAccountPlan" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceTransferPositionOpenItem": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionOpenItem" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceTransferPositionTextKey": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionTextKey" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceTransferSuggestion": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferSuggestion" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FinanceTransferSuggestionField": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferSuggestionField" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FormattedSearch": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FormattedSearch" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.FormattedSearchFireMode": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FormattedSearchFireMode" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.Helpdesk": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Helpdesk" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.HelpdeskCategory": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskCategory" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.HelpdeskDialog": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskDialog" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.HelpdeskDialogProtocol": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskDialogProtocol" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.HelpdeskNotification": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskNotification" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.HelpdeskNotificationEvent": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskNotificationEvent" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.HelpdeskPrio": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskPrio" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.HelpdeskSetting": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskSetting" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.HelpdeskStar": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskStar" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.HelpdeskStatusSupporter": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskStatusSupporter" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.HelpdeskTopic": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskTopic" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.Intercom": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Intercom" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.IntercomGroup": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.IntercomGroup" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.IntercomPrio": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.IntercomPrio" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.IntercomRecipientStatus": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.IntercomRecipientStatus" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.IntercomSenderStatus": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.IntercomSenderStatus" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.Map": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Map" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.Marketplace": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Marketplace" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.MarketplaceSellerArticle": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.MarketplaceSellerArticle" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.MarketplaceSellerPosition": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.MarketplaceSellerPosition" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.MarketplaceSetting": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.MarketplaceSetting" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.MassEmail": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.MassEmail" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.MassEmailRecipient": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.MassEmailRecipient" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.OutputControlButton": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.OutputControlButton" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.OutputControlFormat": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.OutputControlFormat" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.OutputControlMedium": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.OutputControlMedium" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.OutputControlPrinterConfiguration": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.OutputControlPrinterConfiguration" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PackingListBox": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PackingListBox" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PackingListBoxPosition": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PackingListBoxPosition" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PackingListBoxType": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PackingListBoxType" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.Partner": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Partner" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerBankAccount": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerBankAccount" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerBillingAddress": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerBillingAddress" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerCatalogNumber": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerCatalogNumber" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerCategory": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerCategory" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerCategoryName": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerCategoryName" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerContactPerson": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerContactPerson" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryContactPerson": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerContactPersonEmailCategoryContactPerson" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryDocType": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerContactPersonEmailCategoryDocType" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryName": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerContactPersonEmailCategoryName" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerDeliveryAddress": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDeliveryAddress" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerDetail": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDetail" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerDetailBanking": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDetailBanking" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerDetailOutput": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDetailOutput" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerDirectDebitType": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDirectDebitType" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerDiscountGroup": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDiscountGroup" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerDiscountGroupName": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDiscountGroupName" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerGroup": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerGroup" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerInfo": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerInfo" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerPasskey": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerPasskey" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerPaymentType": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerPaymentType" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerPicture": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerPicture" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerPurchasePriceList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerPurchasePriceList" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerTermsOfDelivery": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerTermsOfDelivery" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerTermsOfPayment": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerTermsOfPayment" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerTermsOfPaymentUNTDID": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerTermsOfPaymentUNTDID" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerToken": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerToken" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PartnerType": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerType" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PhoneCall": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PhoneCall" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PhoneFolder": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PhoneFolder" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PhoneLine": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PhoneLine" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PhoneLineEmployee": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PhoneLineEmployee" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.PhoneLog": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PhoneLog" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.Procurement": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Procurement" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.Production": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Production" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ProductionDataAcquisition": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisition" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ProductionDataAcquisitionReasonCode": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisitionReasonCode" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ProductionDataAcquisitionStatus": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisitionStatus" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ProductionDataAcquisitionWorkplace": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisitionWorkplace" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ProductionDataAcquisitionWorkplaceStatus": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisitionWorkplaceStatus" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ProductionDurationUnit": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDurationUnit" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ProductionPositionResource": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionResource" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ProductionPositionResourceGroup": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionResourceGroup" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ProductionPositionType": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionType" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ProductionPositionWarehousing": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionWarehousing" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ProductionStatus": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionStatus" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.Project": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Project" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ProjectDependencyType": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ProjectDependencyType" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ProjectStatus": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ProjectStatus" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ReportTemplate": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ReportTemplate" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ReportTemplateListItem": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ReportTemplateListItem" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ReportType": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ReportType" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.Resource": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Resource" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ResourceGroup": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ResourceGroup" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ShippingCarrier": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ShippingCarrier" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ShippingRate": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ShippingRate" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ShippingType": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ShippingType" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ShippingZone": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ShippingZone" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.SmartPool": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.SmartPool" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.SmartPoolApproval": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.SmartPoolApproval" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.SmartPoolLinkedEntity": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.SmartPoolLinkedEntity" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.SmartPoolOcr": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.SmartPoolOcr" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.StickyNote": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.StickyNote" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.SupportSetting": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.SupportSetting" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.SystemDataType": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemDataType" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.SystemDatabaseChangeLog": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemDatabaseChangeLog" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.SystemDatabaseLanguage": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemDatabaseLanguage" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.SystemDesktop": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemDesktop" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.SystemDesktopColumn": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemDesktopColumn" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.SystemKeyCombination": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemKeyCombination" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.SystemMapping": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemMapping" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.SystemMappingFileType": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemMappingFileType" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.SystemMappingFormatName": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemMappingFormatName" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.SystemMappingSystemColumn": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemMappingSystemColumn" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.SystemTable": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemTable" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.SystemTableField": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemTableField" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.SystemVersion": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemVersion" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.SystemView": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemView" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.TextBlock": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.TextBlock" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.TextBlockGroup": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.TextBlockGroup" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.TextVariable": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.TextVariable" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.TimeTracking": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.TimeTracking" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.TimeTrackingSetting": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.TimeTrackingSetting" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ToolboxButton": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxButton" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.ToolboxField": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxField" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.TranslationArticleInfoText": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationArticleInfoText" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.TranslationArticleName1": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationArticleName1" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.TranslationArticleName2": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationArticleName2" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.TranslationArticleOrderText": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationArticleOrderText" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.TranslationArticleUoM": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationArticleUoM" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.TranslationDocType": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationDocType" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.Warehouse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Warehouse" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WarehouseBinLocation": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseBinLocation" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WarehouseInfo": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInfo" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WarehouseInventoryCounting": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryCounting" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WarehouseInventoryCountingPosition": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryCountingPosition" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WarehouseInventoryRevaluation": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryRevaluation" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WarehouseInventoryRevaluationPosition": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryRevaluationPosition" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WarehouseMedium": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseMedium" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WarehouseQuantity": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseQuantity" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WarehouseTransfer": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseTransfer" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WarehouseTransferPosition": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseTransferPosition" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WarehouseType": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseType" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WebshopActivityLog": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopActivityLog" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WebshopCss": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopCss" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WebshopIcon": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopIcon" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WebshopSetting": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopSetting" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WebshopUserCart": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopUserCart" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.Wiki": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Wiki" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WikiCategory": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WikiCategory" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WikiStatus": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WikiStatus" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WorkspaceRoleDesktop": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceRoleDesktop" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WorkspaceRoleDesktopButton": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceRoleDesktopButton" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WorkspaceRoleMenu": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceRoleMenu" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WorkspaceRoleMenuButton": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceRoleMenuButton" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WorkspaceUserColumnSetting": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceUserColumnSetting" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.WorkspaceUserFieldSetting": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceUserFieldSetting" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.XXTable": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.XXTable" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW124_ArticlePositionQuantityOpenSum": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW124_ArticlePositionQuantityOpenSum" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW124_ArticleProductionPositionQuantityOpenSum": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW124_ArticleProductionPositionQuantityOpenSum" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW124_ArticleQuantityInventorySum": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW124_ArticleQuantityInventorySum" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW125_ArticleHistoryTable": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW125_ArticleHistoryTable" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW139_ArticleIndividualizationQuantityHistory": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW139_ArticleIndividualizationQuantityHistory" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW140_ArticleQuantityHistoryTable": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW140_ArticleQuantityHistoryTable" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW150_PartnerJoinCustomer": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW150_PartnerJoinCustomer" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW150_PartnerJoinPartnerDetail": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW150_PartnerJoinPartnerDetail" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW150_PartnerJoinSupplier": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW150_PartnerJoinSupplier" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW150_PartnerPurchasePriceListHistoryTable": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW150_PartnerPurchasePriceListHistoryTable" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW180_EmployeeVacationEntitlementHistoryTable": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW180_EmployeeVacationEntitlementHistoryTable" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW181_EmployeeVacationEntitlement": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW181_EmployeeVacationEntitlement" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW193_WarehouseQuantityHistoryTable": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW193_WarehouseQuantityHistoryTable" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW200_DocTypeSequence": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW200_DocTypeSequence" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW216_Doc_DeviceService": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW216_Doc_DeviceService" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW360_MarketplaceSellerPosition": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW360_MarketplaceSellerPosition" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW420_ProductionPosition": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW420_ProductionPosition" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW500_WarehouseInventoryList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW500_WarehouseInventoryList" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW501_WarehouseInventoryIndividualized": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW501_WarehouseInventoryIndividualized" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW552_ProcurementPurchase": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW552_ProcurementPurchase" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW554_ProcurementProduction": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW554_ProcurementProduction" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW600_FinancePostingDraft": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW600_FinancePostingDraft" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW600_FinancePostingList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW600_FinancePostingList" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW600_FinancePostingPositionDraft": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW600_FinancePostingPositionDraft" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW605_FinanceAccountPlan": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW605_FinanceAccountPlan" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW660_FinanceTransferPosition": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW660_FinanceTransferPosition" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW670_DueAndOverDue": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW670_DueAndOverDue" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW821_CountryPackageIntrastatCandidate": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW821_CountryPackageIntrastatCandidate" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW_Article": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW_Article" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW_Doc": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW_Doc" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW_Employee": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW_Employee" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.IEnumerable_Of_XERP.Shared.Models.xVIEW_Partner": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW_Partner" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_System.Collections.Generic.Dictionary_Of_System.String_And_System.Object": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": { } }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_System.String": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "string" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Server.Controllers.PartnerSessionInfo": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Server.Controllers.PartnerSessionInfo" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminApiAuthType": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminApiAuthType" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminBank": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminBank" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminBankAccountEBankingType": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminBankAccountEBankingType" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminCompanySetting": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCompanySetting" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminCountry": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCountry" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminCurrency": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCurrency" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminCurrencyApi": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCurrencyApi" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminCurrencyRate": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCurrencyRate" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminDecimalPlace": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminDecimalPlace" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminEDocType": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminEDocType" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminFederalState": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminFederalState" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminFiscalPeriod": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminFiscalPeriod" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminLanguage": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminLanguage" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminLocation": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminLocation" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminMonth": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminMonth" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminProgramAiLanguage": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminProgramAiLanguage" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminProgramSetting": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminProgramSetting" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminRoute": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminRoute" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminSvg": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminSvg" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminTimeZone": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminTimeZone" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminYear": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminYear" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AdminZip": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminZip" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AiChatInfo": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.AiChatInfo" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AiChatSetting": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.AiChatSetting" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AiEmailInfo": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.AiEmailInfo" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AiEmbedding": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.AiEmbedding" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AiTextInfo": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.AiTextInfo" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AppRoleDto": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.AppRoleDto" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AppUser": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.AppUser" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AppUserDto": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.AppUserDto" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Archive": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Archive" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArchiveDunning": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArchiveDunning" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Article": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Article" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleAccessory": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleAccessory" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleCategory": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleCategory" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleCategoryName": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleCategoryName" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleCost": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleCost" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleDimensionText": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleDimensionText" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleEInvoiceUoM": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleEInvoiceUoM" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleGroup": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleGroup" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleIndividualization": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleIndividualization" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleIndividualizationQuantity": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleIndividualizationQuantity" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleIndividualizationType": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleIndividualizationType" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleInfoText": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleInfoText" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleMacro": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleMacro" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleOrderText": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleOrderText" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticlePicture": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticlePicture" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticlePriceCalculation": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticlePriceCalculation" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticlePriceUnit": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticlePriceUnit" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleProcurementType": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProcurementType" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleProduct": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProduct" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleProductDependencyType": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProductDependencyType" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleProductionStepComponent": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProductionStepComponent" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleProductionStepComponentType": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProductionStepComponentType" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleProductionStepResource": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProductionStepResource" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleQuantity": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleQuantity" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleSalesPriceList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleSalesPriceList" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleSalesPriceListName": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleSalesPriceListName" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleSet": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleSet" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleTemplate": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleTemplate" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleType": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleType" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleUoM": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleUoM" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ArticleUoMConversion": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleUoMConversion" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Attachment": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Attachment" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AttachmentFile": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.AttachmentFile" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AttachmentFileDto": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.AttachmentFileDto" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AttachmentStatus": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.AttachmentStatus" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AuthorizationPage": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.AuthorizationPage" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.AuthorizationWebApi": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.AuthorizationWebApi" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Bulletin": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Bulletin" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.BulletinCategory": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.BulletinCategory" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.BulletinRead": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.BulletinRead" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CalendarAppointment": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarAppointment" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CalendarAppointmentAttachment": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarAppointmentAttachment" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CalendarAppointmentCategory": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarAppointmentCategory" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CalendarHoliday": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarHoliday" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CalendarName": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarName" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CalendarWeekDay": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarWeekDay" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CalendarWorkingDay": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarWorkingDay" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CashFlowDataPointModel": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CashFlowDataPointModel" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ComponentHierarchyResult": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ComponentHierarchyResult" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageDatevExport": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageDatevExport" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageElsterExport": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageElsterExport" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatArticle": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatArticle" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatCommodityCode": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatCommodityCode" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatDeclaration": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDeclaration" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatDeclarationPosition": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDeclarationPosition" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatDeclarationStatus": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDeclarationStatus" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatDirection": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDirection" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatDocPosition": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDocPosition" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatPartner": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatPartner" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatPreviewPosition": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatPreviewPosition" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatReportingEntity": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatReportingEntity" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatTransactionType": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatTransactionType" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackageIntrastatTransportMode": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatTransportMode" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackagePrivacyProcessingActivity": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackagePrivacyProcessingActivity" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CountryPackagePrivacyProcessingActivityObject": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackagePrivacyProcessingActivityObject" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Crm": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Crm" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CrmActivity": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CrmActivity" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CrmActivityType": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CrmActivityType" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CrmGroup": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CrmGroup" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CrmStatus": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CrmStatus" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.CrmType": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CrmType" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Dashboard": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Dashboard" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DbTableDefault": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DbTableDefault" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DeviceService": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DeviceService" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Doc": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocApproval": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocApproval" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocBillingAddress": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocBillingAddress" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocCategory": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocCategory" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocContract": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocContract" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocContractCyclePeriod": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocContractCyclePeriod" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocContractStatus": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocContractStatus" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocDeliveryAddress": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocDeliveryAddress" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocFooterText": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocFooterText" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocHeaderText": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocHeaderText" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocPosition": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocPositionDimensionText": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionDimensionText" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocPositionInfoText": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionInfoText" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocPositionOrderText": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionOrderText" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocPositionStatus": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionStatus" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocPositionType": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionType" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocPositionWarehousing": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionWarehousing" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocPostingErrorMessage": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPostingErrorMessage" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocStatus": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocStatus" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocType": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocType" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocTypeInventoryStatus": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocTypeInventoryStatus" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocTypePrepaymentFactor": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocTypePrepaymentFactor" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocTypeRevenueEffective": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocTypeRevenueEffective" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocTypeWarehousingEffective": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocTypeWarehousingEffective" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocXml": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXml" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocXmlAssignment": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXmlAssignment" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.DocXmlPosition": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXmlPosition" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Dto.ArticleCarouselDto": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Dto.ArticleCarouselDto" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Dto.CalendarAttachmentDto": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Dto.CalendarAttachmentDto" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Dto.CalendarAttendeeTrackingDto": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Dto.CalendarAttendeeTrackingDto" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Dto.CategoryNameDto": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Dto.CategoryNameDto" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Dto.UserCartDto": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Dto.UserCartDto" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Email": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Email" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailAccount": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailAccount" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailAttachment": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailAttachment" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailFolder": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailFolder" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailLog": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailLog" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailRuleField": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailRuleField" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailRuleIn": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailRuleIn" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailRuleOut": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailRuleOut" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailSignature": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailSignature" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailSignatureAttachment": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailSignatureAttachment" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailSpamProtectionSender": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailSpamProtectionSender" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailSpamProtectionSubject": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailSpamProtectionSubject" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailSystem": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailSystem" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailTemplate": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailTemplate" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailTemplateAttachment": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailTemplateAttachment" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmailTemplateGroup": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailTemplateGroup" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Employee": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Employee" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmployeeCalendarColorDto": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeCalendarColorDto" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmployeeCommissionGroup": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeCommissionGroup" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmployeeCommissionGroupName": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeCommissionGroupName" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmployeeGroup": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeGroup" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmployeeVacationEntitlement": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeVacationEntitlement" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmployeeVacationRequest": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeVacationRequest" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmployeeVacationRequestApproval": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeVacationRequestApproval" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmployeeVacationType": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeVacationType" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.EmployeeVacationYear": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeVacationYear" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAspNetRole": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetRole" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAspNetRoleClaim": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetRoleClaim" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAspNetUser": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetUser" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAspNetUserClaim": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetUserClaim" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAspNetUserLogin": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetUserLogin" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAspNetUserToken": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetUserToken" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAuthorizationPage": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAuthorizationPage" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAuthorizationRolePagePermission": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAuthorizationRolePagePermission" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAuthorizationRoleWebApiPermission": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAuthorizationRoleWebApiPermission" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExternalAuthorizationWebApi": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAuthorizationWebApi" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExtraApi": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraApi" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExtraCode": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraCode" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExtraField": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraField" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExtraPage": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraPage" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExtraPlugin": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraPlugin" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExtraTable": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraTable" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ExtraTableIndexType": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraTableIndexType" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FieldService": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FieldService" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FieldServiceResource": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FieldServiceResource" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FieldServiceResourceGroup": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FieldServiceResourceGroup" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FieldServiceResourceSegment": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FieldServiceResourceSegment" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FieldServiceStatus": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FieldServiceStatus" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountAssignment": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountAssignment" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountCategory": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountCategory" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountDetermination": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountDetermination" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountGroup": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountGroup" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountInternalReconciliation": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountInternalReconciliation" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountInternalReconciliationPosition": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountInternalReconciliationPosition" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountPlan": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountPlan" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountPurpose": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountPurpose" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceAccountType": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountType" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceBalanceGroup": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceBalanceGroup" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceBusinessAssessmentGroup": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceBusinessAssessmentGroup" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceClosingPosting": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceClosingPosting" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceClosingPostingPosition": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceClosingPostingPosition" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceCompanyBankAccount": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceCompanyBankAccount" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceCostBearer": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceCostBearer" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceCostCenter": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceCostCenter" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceCostType": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceCostType" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceDunning": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceDunning" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceDunningLevel": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceDunningLevel" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceDunningPosition": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceDunningPosition" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceEInvoiceTaxKeyCategory": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceEInvoiceTaxKeyCategory" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAsset": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAsset" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetClass": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetClass" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationCyclePeriod": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDepreciationCyclePeriod" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationMethod": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDepreciationMethod" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationPlan": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDepreciationPlan" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationType": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDepreciationType" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationTypeDetail": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDepreciationTypeDetail" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetDetail": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDetail" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetGroup": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetGroup" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceFixedAssetStatus": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetStatus" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceGroupArticle": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceGroupArticle" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceGroupArticleDetail": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceGroupArticleDetail" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceGroupPartner": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceGroupPartner" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceOpenItem": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItem" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceOpenItemInternalReconciliation": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItemInternalReconciliation" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceOpenItemInternalReconciliationPosition": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItemInternalReconciliationPosition" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceOpenItemOrigin": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItemOrigin" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceOpenItemStatus": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItemStatus" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceOpenItemType": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItemType" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceOpeningBalance": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpeningBalance" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceOpeningBalancePosition": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpeningBalancePosition" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePayment": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePayment" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePaymentPosition": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePaymentPosition" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePosting": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePosting" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingDraft": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingDraft" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingPeriod": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPeriod" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingPeriodStatus": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPeriodStatus" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingPosition": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPosition" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingPositionDraft": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionDraft" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingPositionTemplate": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionTemplate" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingSource": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingSource" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingStatus": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingStatus" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinancePostingTemplate": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingTemplate" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceProfitLossGroup": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceProfitLossGroup" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTaxKey": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTaxKey" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTaxKeyDetail": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTaxKeyDetail" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTaxKeyKind": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTaxKeyKind" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransfer": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransfer" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferBankStatement": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferBankStatement" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferCategory": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferCategory" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferCategoryAccountType": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferCategoryAccountType" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferPosition": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPosition" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferPositionAccountPlan": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionAccountPlan" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferPositionOpenItem": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionOpenItem" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferPositionTextKey": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionTextKey" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferSuggestion": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferSuggestion" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FinanceTransferSuggestionField": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferSuggestionField" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FormattedSearch": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FormattedSearch" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.FormattedSearchFireMode": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FormattedSearchFireMode" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Helpdesk": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Helpdesk" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskCategory": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskCategory" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskDialog": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskDialog" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskDialogProtocol": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskDialogProtocol" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskNotification": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskNotification" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskNotificationEvent": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskNotificationEvent" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskPrio": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskPrio" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskSetting": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskSetting" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskStar": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskStar" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskStatusSupporter": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskStatusSupporter" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.HelpdeskTopic": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskTopic" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.InsertArticleResult": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.InsertArticleResult" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Intercom": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Intercom" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.IntercomGroup": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.IntercomGroup" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.IntercomPrio": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.IntercomPrio" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.IntercomRecipientStatus": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.IntercomRecipientStatus" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.IntercomSenderStatus": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.IntercomSenderStatus" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.LookupItem" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.LookupItem_Of_System.String": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.LookupItem_Of_System.String" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Map": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Map" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Marketplace": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Marketplace" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.MarketplaceSellerArticle": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.MarketplaceSellerArticle" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.MarketplaceSellerPosition": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.MarketplaceSellerPosition" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.MarketplaceSetting": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.MarketplaceSetting" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.MassEmail": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.MassEmail" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.MassEmailRecipient": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.MassEmailRecipient" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.MassEmailRecipientCandidate": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.MassEmailRecipientCandidate" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.OutputControlButton": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.OutputControlButton" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.OutputControlFormat": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.OutputControlFormat" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.OutputControlMedium": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.OutputControlMedium" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.OutputControlPrinterConfiguration": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.OutputControlPrinterConfiguration" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PackingListBox": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PackingListBox" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PackingListBoxPosition": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PackingListBoxPosition" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PackingListBoxType": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PackingListBoxType" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Partner": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Partner" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerBankAccount": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerBankAccount" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerBillingAddress": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerBillingAddress" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerCatalogNumber": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerCatalogNumber" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerCategory": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerCategory" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerCategoryName": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerCategoryName" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerContactPerson": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerContactPerson" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryContactPerson": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerContactPersonEmailCategoryContactPerson" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryDocType": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerContactPersonEmailCategoryDocType" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryName": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerContactPersonEmailCategoryName" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerDeliveryAddress": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDeliveryAddress" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerDetail": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDetail" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerDetailBanking": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDetailBanking" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerDetailOutput": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDetailOutput" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerDirectDebitType": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDirectDebitType" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerDiscountGroup": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDiscountGroup" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerDiscountGroupName": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDiscountGroupName" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerGroup": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerGroup" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerInfo": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerInfo" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerPasskey": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerPasskey" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerPaymentType": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerPaymentType" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerPicture": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerPicture" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerPurchasePriceList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerPurchasePriceList" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerTermsOfDelivery": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerTermsOfDelivery" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerTermsOfPayment": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerTermsOfPayment" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerTermsOfPaymentUNTDID": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerTermsOfPaymentUNTDID" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerToken": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerToken" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PartnerType": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerType" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PhoneCall": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PhoneCall" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PhoneFolder": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PhoneFolder" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PhoneLine": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PhoneLine" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PhoneLineEmployee": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PhoneLineEmployee" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.PhoneLog": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PhoneLog" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Procurement": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Procurement" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Production": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Production" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionDataAcquisition": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisition" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionDataAcquisitionReasonCode": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisitionReasonCode" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionDataAcquisitionStatus": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisitionStatus" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionDataAcquisitionWorkplace": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisitionWorkplace" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionDataAcquisitionWorkplaceStatus": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisitionWorkplaceStatus" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionDurationUnit": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDurationUnit" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionGanttChartModel": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionGanttChartModel" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionPositionResource": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionResource" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionPositionResourceGroup": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionResourceGroup" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionPositionResourceSegment": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionResourceSegment" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionPositionType": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionType" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionPositionWarehousing": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionWarehousing" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionSegmentModel": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionSegmentModel" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProductionStatus": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionStatus" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Project": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Project" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProjectDependencyType": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ProjectDependencyType" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ProjectStatus": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ProjectStatus" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.QuantityCompletedResult": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.QuantityCompletedResult" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ReportTemplate": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ReportTemplate" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ReportType": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ReportType" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Resource": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Resource" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ResourceAssignmentModel": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ResourceAssignmentModel" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ResourceGroup": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ResourceGroup" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.RoleAllPagesPermissionDto": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.RoleAllPagesPermissionDto" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.RoleAllWebApisPermissionDto": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.RoleAllWebApisPermissionDto" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SaveDraftWarehousingResult": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.SaveDraftWarehousingResult" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ServerInfo": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ServerInfo" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ShippingCarrier": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ShippingCarrier" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ShippingRate": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ShippingRate" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ShippingType": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ShippingType" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ShippingZone": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ShippingZone" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SmartPool": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.SmartPool" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SmartPoolApproval": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.SmartPoolApproval" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SmartPoolLinkedEntity": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.SmartPoolLinkedEntity" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SmartPoolOcr": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.SmartPoolOcr" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.StickyNote": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.StickyNote" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SupportSetting": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.SupportSetting" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemDataType": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemDataType" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemDatabaseChangeLog": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemDatabaseChangeLog" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemDatabaseLanguage": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemDatabaseLanguage" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemDesktop": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemDesktop" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemDesktopColumn": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemDesktopColumn" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemKeyCombination": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemKeyCombination" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemMapping": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemMapping" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemMappingFileType": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemMappingFileType" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemMappingFormatName": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemMappingFormatName" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemMappingSystemColumn": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemMappingSystemColumn" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemTable": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemTable" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemTableField": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemTableField" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemVersion": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemVersion" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.SystemView": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemView" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TextBlock": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.TextBlock" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TextBlockGroup": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.TextBlockGroup" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TextVariable": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.TextVariable" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TimeTracking": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.TimeTracking" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TimeTrackingSetting": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.TimeTrackingSetting" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ToolboxButton": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxButton" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ToolboxField": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxField" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ToolboxFieldOptionDto": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldOptionDto" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.ToolboxFieldRuntimeValue": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeValue" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TransferDocXmlToDocErrorMessages": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.TransferDocXmlToDocErrorMessages" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TranslationArticleInfoText": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationArticleInfoText" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TranslationArticleName1": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationArticleName1" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TranslationArticleName2": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationArticleName2" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TranslationArticleOrderText": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationArticleOrderText" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TranslationArticleUoM": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationArticleUoM" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.TranslationDocType": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationDocType" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Warehouse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Warehouse" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseBinLocation": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseBinLocation" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseInfo": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInfo" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseInventoryCounting": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryCounting" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseInventoryCountingPosition": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryCountingPosition" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseInventoryRevaluation": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryRevaluation" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseInventoryRevaluationPosition": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryRevaluationPosition" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseMedium": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseMedium" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseQuantity": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseQuantity" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseTransfer": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseTransfer" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseTransferPosition": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseTransferPosition" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WarehouseType": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseType" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WebshopActivityLog": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopActivityLog" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WebshopCss": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopCss" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WebshopIcon": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopIcon" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WebshopRating": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopRating" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WebshopSetting": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopSetting" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WebshopUserCart": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopUserCart" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.Wiki": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Wiki" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WikiCategory": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WikiCategory" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WikiStatus": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WikiStatus" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WorkspaceRoleDesktop": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceRoleDesktop" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WorkspaceRoleDesktopButton": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceRoleDesktopButton" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WorkspaceRoleMenu": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceRoleMenu" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WorkspaceRoleMenuButton": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceRoleMenuButton" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WorkspaceUserColumnSetting": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceUserColumnSetting" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.WorkspaceUserFieldSetting": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceUserFieldSetting" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.XXTable": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.XXTable" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xPROC263_DocXml_Positions_SaveResult": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xPROC263_DocXml_Positions_SaveResult" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xPROC418U_Production_PackResult": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xPROC418U_Production_PackResult" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xPROC550_ProcurementWizard_QuantityUsedResult": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xPROC550_ProcurementWizard_QuantityUsedResult" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xPROC609_FinanceTransfer_PostingResult": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xPROC609_FinanceTransfer_PostingResult" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xPROC696_FinanceFixedAssetWizard_PostingResult": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xPROC696_FinanceFixedAssetWizard_PostingResult" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW124_ArticlePositionQuantityOpenSum": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW124_ArticlePositionQuantityOpenSum" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW124_ArticleProductionPositionQuantityOpenSum": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW124_ArticleProductionPositionQuantityOpenSum" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW124_ArticleQuantityInventorySum": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW124_ArticleQuantityInventorySum" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW125_ArticleHistoryTable": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW125_ArticleHistoryTable" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW139_ArticleIndividualizationQuantityHistory": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW139_ArticleIndividualizationQuantityHistory" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW140_ArticleQuantityHistoryTable": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW140_ArticleQuantityHistoryTable" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW150_PartnerJoinCustomer": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW150_PartnerJoinCustomer" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW150_PartnerJoinPartnerDetail": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW150_PartnerJoinPartnerDetail" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW150_PartnerJoinSupplier": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW150_PartnerJoinSupplier" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW150_PartnerPurchasePriceListHistoryTable": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW150_PartnerPurchasePriceListHistoryTable" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW180_EmployeeVacationEntitlementHistoryTable": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW180_EmployeeVacationEntitlementHistoryTable" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW181_EmployeeVacationEntitlement": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW181_EmployeeVacationEntitlement" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW192_WarehouseWarehouseBinLocationHierarchy": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW192_WarehouseWarehouseBinLocationHierarchy" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW193_WarehouseQuantityHistoryTable": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW193_WarehouseQuantityHistoryTable" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW200_DocTypeSequence": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW200_DocTypeSequence" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW216_Doc_DeviceService": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW216_Doc_DeviceService" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW220_DocPosition": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW220_DocPosition" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW225_DocPositionWarehousing": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW225_DocPositionWarehousing" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW265_DocXmlPosition": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW265_DocXmlPosition" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW360_MarketplaceSellerPosition": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW360_MarketplaceSellerPosition" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW420_ProductionPosition": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW420_ProductionPosition" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW425_ProductionPositionWarehousing": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW425_ProductionPositionWarehousing" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW450_ProductionDataAcquisition": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW450_ProductionDataAcquisition" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW500_WarehouseInventoryList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW500_WarehouseInventoryList" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW501_WarehouseInventoryIndividualized": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW501_WarehouseInventoryIndividualized" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW520_WarehouseInventoryCountingPosition": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW520_WarehouseInventoryCountingPosition" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW521_WarehouseInventoryRevaluationPosition": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW521_WarehouseInventoryRevaluationPosition" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW522_WarehouseTransferPosition": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW522_WarehouseTransferPosition" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW552_ProcurementPurchase": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW552_ProcurementPurchase" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW554_ProcurementProduction": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW554_ProcurementProduction" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW600_FinancePostingDraft": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW600_FinancePostingDraft" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW600_FinancePostingList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW600_FinancePostingList" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW600_FinancePostingPositionDraft": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW600_FinancePostingPositionDraft" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW603_FinanceOpenItemReconciliationPosition": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW603_FinanceOpenItemReconciliationPosition" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW605_FinanceAccountPlan": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW605_FinanceAccountPlan" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW621_FinanceAccountReconciliationPosition": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW621_FinanceAccountReconciliationPosition" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW635_FinanceOpeningBalancePosition": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW635_FinanceOpeningBalancePosition" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW645_FinanceClosingPostingPosition": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW645_FinanceClosingPostingPosition" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW660_FinanceTransferPosition": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW660_FinanceTransferPosition" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW661_FinanceTransferPositionAccountPlan": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW661_FinanceTransferPositionAccountPlan" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW662_FinanceTransferPositionOpenItem": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW662_FinanceTransferPositionOpenItem" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW670_DueAndOverDue": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW670_DueAndOverDue" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW821_CountryPackageIntrastatCandidate": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW821_CountryPackageIntrastatCandidate" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW_Article": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW_Article" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW_Doc": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW_Doc" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW_Employee": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW_Employee" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW_Partner": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW_Partner" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models.xVIEW_SmartPool": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW_SmartPool" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Collections.Generic.List_Of_XERP.Shared.Models_MasterDb.License": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models_MasterDb.License" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Int32": { "type": "object", "properties": { "data": { "type": "integer", "format": "int32" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Nullable_Of_System.DateTimeOffset": { "type": "object", "properties": { "data": { "type": "string", "format": "date-time", "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Nullable_Of_System.Int32": { "type": "object", "properties": { "data": { "type": "integer", "format": "int32", "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.Nullable_Of_System.Int64": { "type": "object", "properties": { "data": { "type": "integer", "format": "int64", "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_System.String": { "type": "object", "properties": { "data": { "type": "string", "nullable": true }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Server.Controllers.InsertRowResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Server.Controllers.InsertRowResponse" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Server.Controllers.PartnerCredentialValidationResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Server.Controllers.PartnerCredentialValidationResult" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Server.Controllers.PasskeyWithPartnerResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Server.Controllers.PasskeyWithPartnerResult" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AddToCartDto": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.AddToCartDto" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminApiAuthType": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminApiAuthType" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminBank": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminBank" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminBankAccountEBankingType": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminBankAccountEBankingType" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminCompanySetting": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCompanySetting" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminCountry": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCountry" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminCurrency": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCurrency" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminCurrencyApi": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCurrencyApi" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminCurrencyRate": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCurrencyRate" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminDecimalPlace": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminDecimalPlace" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminEDocType": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminEDocType" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminFederalState": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminFederalState" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminFiscalPeriod": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminFiscalPeriod" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminLanguage": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminLanguage" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminLocation": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminLocation" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminMonth": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminMonth" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminProgramAiLanguage": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminProgramAiLanguage" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminProgramSetting": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminProgramSetting" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminRoute": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminRoute" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminSvg": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminSvg" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminTimeZone": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminTimeZone" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminYear": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminYear" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AdminZip": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminZip" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AiChatInfo": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.AiChatInfo" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AiChatSetting": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.AiChatSetting" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AiEmailInfo": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.AiEmailInfo" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AiEmbedding": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.AiEmbedding" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AiTextInfo": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.AiTextInfo" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AppRoleDto": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.AppRoleDto" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AppUser": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.AppUser" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AppUserDto": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.AppUserDto" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Archive": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.Archive" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArchiveDunning": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.ArchiveDunning" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Article": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.Article" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleAccessory": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleAccessory" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleCategory": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleCategory" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleCategoryName": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleCategoryName" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleCost": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleCost" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleDimensionText": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleDimensionText" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleEInvoiceUoM": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleEInvoiceUoM" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleGroup": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleGroup" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleIndividualization": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleIndividualization" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleIndividualizationQuantity": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleIndividualizationQuantity" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleIndividualizationType": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleIndividualizationType" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleInfoText": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleInfoText" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleMacro": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleMacro" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleOrderText": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleOrderText" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticlePicture": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticlePicture" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticlePriceCalculation": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticlePriceCalculation" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticlePriceUnit": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticlePriceUnit" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProcurementType": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProcurementType" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProduct": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProduct" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProductDependencyType": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProductDependencyType" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProductionStepComponent": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProductionStepComponent" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProductionStepComponentType": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProductionStepComponentType" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleProductionStepResource": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProductionStepResource" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleQuantity": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleQuantity" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleSalesPriceList": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleSalesPriceList" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleSalesPriceListName": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleSalesPriceListName" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleSet": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleSet" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleTemplate": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleTemplate" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleType": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleType" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleUoM": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleUoM" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ArticleUoMConversion": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleUoMConversion" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Attachment": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.Attachment" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AttachmentFile": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.AttachmentFile" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AttachmentFileDto": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.AttachmentFileDto" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AttachmentStatus": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.AttachmentStatus" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AuthorizationPage": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.AuthorizationPage" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.AuthorizationWebApi": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.AuthorizationWebApi" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Bulletin": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.Bulletin" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.BulletinCategory": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.BulletinCategory" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.BulletinRead": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.BulletinRead" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarAppointment": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarAppointment" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarAppointmentAttachment": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarAppointmentAttachment" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarAppointmentCategory": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarAppointmentCategory" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarHoliday": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarHoliday" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarName": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarName" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarWeekDay": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarWeekDay" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CalendarWorkingDay": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarWorkingDay" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageDatevExport": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageDatevExport" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageElsterExport": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageElsterExport" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatArticle": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatArticle" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatCommodityCode": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatCommodityCode" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatDeclaration": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDeclaration" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatDeclarationPosition": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDeclarationPosition" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatDeclarationStatus": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDeclarationStatus" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatDirection": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDirection" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatDocPosition": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDocPosition" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatPartner": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatPartner" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatReportingEntity": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatReportingEntity" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatTransactionType": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatTransactionType" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackageIntrastatTransportMode": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatTransportMode" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackagePrivacyProcessingActivity": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackagePrivacyProcessingActivity" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CountryPackagePrivacyProcessingActivityObject": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackagePrivacyProcessingActivityObject" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Crm": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.Crm" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CrmActivity": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.CrmActivity" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CrmActivityType": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.CrmActivityType" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CrmGroup": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.CrmGroup" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CrmStatus": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.CrmStatus" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.CrmType": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.CrmType" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dashboard": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.Dashboard" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminApiAuthType": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminApiAuthType" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminBank": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminBank" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminBankAccountEBankingType": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminBankAccountEBankingType" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminCompanySetting": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminCompanySetting" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminCountry": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminCountry" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminCurrency": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminCurrency" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminCurrencyApi": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminCurrencyApi" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminCurrencyRate": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminCurrencyRate" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminDecimalPlace": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminDecimalPlace" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminEDocType": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminEDocType" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminFederalState": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminFederalState" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminFiscalPeriod": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminFiscalPeriod" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminLanguage": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminLanguage" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminLocation": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminLocation" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminMonth": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminMonth" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminProgramAiLanguage": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminProgramAiLanguage" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminProgramSetting": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminProgramSetting" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminRoute": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminRoute" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminSvg": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminSvg" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminTimeZone": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminTimeZone" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminYear": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminYear" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminZip": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminZip" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AiChatInfo": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AiChatInfo" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AiChatSetting": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AiChatSetting" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AiEmailInfo": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AiEmailInfo" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AiEmbedding": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AiEmbedding" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AiTextInfo": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AiTextInfo" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AppUser": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AppUser" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Archive": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Archive" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArchiveDunning": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArchiveDunning" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Article": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Article" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleAccessory": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleAccessory" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleCategory": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleCategory" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleCategoryName": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleCategoryName" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleCost": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleCost" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleDimensionText": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleDimensionText" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleEInvoiceUoM": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleEInvoiceUoM" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleGroup": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleGroup" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleIndividualization": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleIndividualization" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleIndividualizationQuantity": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleIndividualizationQuantity" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleIndividualizationType": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleIndividualizationType" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleInfoText": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleInfoText" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleMacro": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleMacro" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleOrderText": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleOrderText" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticlePicture": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticlePicture" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticlePriceCalculation": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticlePriceCalculation" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticlePriceUnit": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticlePriceUnit" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleProcurementType": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleProcurementType" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleProduct": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleProduct" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleProductDependencyType": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleProductDependencyType" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleProductionStepComponent": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleProductionStepComponent" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleProductionStepComponentType": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleProductionStepComponentType" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleProductionStepResource": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleProductionStepResource" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleQuantity": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleQuantity" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleSalesPriceList": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleSalesPriceList" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleSalesPriceListName": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleSalesPriceListName" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleSet": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleSet" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleTemplate": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleTemplate" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleType": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleType" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleUoM": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleUoM" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleUoMConversion": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleUoMConversion" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Attachment": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Attachment" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AttachmentFile": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AttachmentFile" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AttachmentStatus": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AttachmentStatus" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AuthorizationPage": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AuthorizationPage" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AuthorizationWebApi": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AuthorizationWebApi" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Bulletin": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Bulletin" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.BulletinCategory": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.BulletinCategory" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.BulletinRead": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.BulletinRead" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CalendarAppointment": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CalendarAppointment" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CalendarAppointmentAttachment": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CalendarAppointmentAttachment" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CalendarAppointmentCategory": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CalendarAppointmentCategory" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CalendarHoliday": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CalendarHoliday" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CalendarName": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CalendarName" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CalendarWeekDay": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CalendarWeekDay" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CalendarWorkingDay": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CalendarWorkingDay" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageDatevExport": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageDatevExport" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageElsterExport": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageElsterExport" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatArticle": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatArticle" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatCommodityCode": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatCommodityCode" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatDeclaration": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatDeclaration" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatDeclarationPosition": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatDeclarationPosition" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatDeclarationStatus": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatDeclarationStatus" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatDirection": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatDirection" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatDocPosition": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatDocPosition" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatPartner": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatPartner" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatReportingEntity": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatReportingEntity" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatTransactionType": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatTransactionType" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatTransportMode": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatTransportMode" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackagePrivacyProcessingActivity": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackagePrivacyProcessingActivity" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackagePrivacyProcessingActivityObject": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackagePrivacyProcessingActivityObject" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Crm": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Crm" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CrmActivity": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CrmActivity" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CrmActivityType": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CrmActivityType" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CrmGroup": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CrmGroup" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CrmStatus": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CrmStatus" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CrmType": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CrmType" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Dashboard": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Dashboard" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DeviceService": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DeviceService" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Doc": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Doc" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocApproval": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocApproval" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocBillingAddress": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocBillingAddress" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocCategory": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocCategory" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocContract": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocContract" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocContractCyclePeriod": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocContractCyclePeriod" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocContractStatus": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocContractStatus" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocDeliveryAddress": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocDeliveryAddress" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocFooterText": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocFooterText" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocHeaderText": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocHeaderText" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocPosition": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocPosition" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocPositionDimensionText": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocPositionDimensionText" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocPositionInfoText": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocPositionInfoText" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocPositionOrderText": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocPositionOrderText" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocPositionStatus": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocPositionStatus" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocPositionType": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocPositionType" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocPositionWarehousing": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocPositionWarehousing" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocStatus": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocStatus" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocType": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocType" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocTypeInventoryStatus": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocTypeInventoryStatus" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocTypePrepaymentFactor": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocTypePrepaymentFactor" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocTypeRevenueEffective": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocTypeRevenueEffective" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocTypeWarehousingEffective": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocTypeWarehousingEffective" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocXml": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocXml" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocXmlAssignment": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocXmlAssignment" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocXmlPosition": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocXmlPosition" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Email": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Email" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailAccount": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailAccount" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailAttachment": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailAttachment" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailFolder": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailFolder" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailLog": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailLog" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailRuleField": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailRuleField" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailRuleIn": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailRuleIn" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailRuleOut": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailRuleOut" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailSignature": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailSignature" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailSignatureAttachment": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailSignatureAttachment" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailSpamProtectionSender": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailSpamProtectionSender" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailSpamProtectionSubject": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailSpamProtectionSubject" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailSystem": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailSystem" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailTemplate": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailTemplate" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailTemplateAttachment": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailTemplateAttachment" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailTemplateGroup": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailTemplateGroup" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Employee": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Employee" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmployeeCommissionGroup": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmployeeCommissionGroup" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmployeeCommissionGroupName": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmployeeCommissionGroupName" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmployeeGroup": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmployeeGroup" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmployeeVacationEntitlement": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmployeeVacationEntitlement" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmployeeVacationRequest": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmployeeVacationRequest" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmployeeVacationRequestApproval": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmployeeVacationRequestApproval" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmployeeVacationType": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmployeeVacationType" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmployeeVacationYear": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmployeeVacationYear" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAspNetRole": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAspNetRole" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAspNetRoleClaim": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAspNetRoleClaim" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAspNetUser": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAspNetUser" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAspNetUserClaim": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAspNetUserClaim" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAspNetUserLogin": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAspNetUserLogin" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAspNetUserToken": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAspNetUserToken" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAuthorizationPage": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAuthorizationPage" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAuthorizationRolePagePermission": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAuthorizationRolePagePermission" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAuthorizationRoleWebApiPermission": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAuthorizationRoleWebApiPermission" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAuthorizationWebApi": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAuthorizationWebApi" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExtraApi": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExtraApi" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExtraCode": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExtraCode" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExtraField": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExtraField" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExtraPage": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExtraPage" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExtraPlugin": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExtraPlugin" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExtraTable": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExtraTable" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExtraTableIndexType": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExtraTableIndexType" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FieldService": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FieldService" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FieldServiceResource": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FieldServiceResource" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FieldServiceResourceGroup": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FieldServiceResourceGroup" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FieldServiceResourceSegment": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FieldServiceResourceSegment" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FieldServiceStatus": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FieldServiceStatus" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceAccountAssignment": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceAccountAssignment" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceAccountCategory": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceAccountCategory" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceAccountDetermination": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceAccountDetermination" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceAccountGroup": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceAccountGroup" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceAccountInternalReconciliation": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceAccountInternalReconciliation" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceAccountInternalReconciliationPosition": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceAccountInternalReconciliationPosition" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceAccountPlan": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceAccountPlan" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceAccountPurpose": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceAccountPurpose" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceAccountType": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceAccountType" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceBalanceGroup": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceBalanceGroup" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceBusinessAssessmentGroup": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceBusinessAssessmentGroup" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceClosingPosting": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceClosingPosting" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceClosingPostingPosition": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceClosingPostingPosition" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceCompanyBankAccount": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceCompanyBankAccount" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceCostBearer": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceCostBearer" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceCostCenter": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceCostCenter" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceCostType": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceCostType" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceDunning": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceDunning" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceDunningLevel": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceDunningLevel" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceDunningPosition": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceDunningPosition" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceEInvoiceTaxKeyCategory": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceEInvoiceTaxKeyCategory" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAsset": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAsset" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAssetClass": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAssetClass" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationCyclePeriod": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationCyclePeriod" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationMethod": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationMethod" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationPlan": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationPlan" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationType": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationType" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationTypeDetail": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationTypeDetail" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAssetDetail": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAssetDetail" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAssetGroup": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAssetGroup" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAssetStatus": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAssetStatus" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceGroupArticle": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceGroupArticle" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceGroupArticleDetail": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceGroupArticleDetail" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceGroupPartner": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceGroupPartner" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceOpenItem": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceOpenItem" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceOpenItemInternalReconciliation": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceOpenItemInternalReconciliation" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceOpenItemInternalReconciliationPosition": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceOpenItemInternalReconciliationPosition" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceOpenItemOrigin": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceOpenItemOrigin" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceOpenItemStatus": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceOpenItemStatus" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceOpenItemType": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceOpenItemType" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceOpeningBalance": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceOpeningBalance" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceOpeningBalancePosition": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceOpeningBalancePosition" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePayment": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePayment" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePaymentPosition": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePaymentPosition" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePosting": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePosting" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePostingDraft": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePostingDraft" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePostingPeriod": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePostingPeriod" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePostingPeriodStatus": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePostingPeriodStatus" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePostingPosition": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePostingPosition" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePostingPositionDraft": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePostingPositionDraft" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePostingPositionTemplate": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePostingPositionTemplate" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePostingSource": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePostingSource" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePostingStatus": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePostingStatus" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePostingTemplate": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePostingTemplate" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceProfitLossGroup": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceProfitLossGroup" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTaxKey": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTaxKey" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTaxKeyDetail": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTaxKeyDetail" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTaxKeyKind": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTaxKeyKind" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransfer": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransfer" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransferBankStatement": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransferBankStatement" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransferCategory": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransferCategory" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransferCategoryAccountType": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransferCategoryAccountType" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransferPosition": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransferPosition" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransferPositionAccountPlan": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransferPositionAccountPlan" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransferPositionOpenItem": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransferPositionOpenItem" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransferPositionTextKey": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransferPositionTextKey" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransferSuggestion": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransferSuggestion" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransferSuggestionField": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransferSuggestionField" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FormattedSearch": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FormattedSearch" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FormattedSearchFireMode": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FormattedSearchFireMode" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Helpdesk": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Helpdesk" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskCategory": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskCategory" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskDialog": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskDialog" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskDialogProtocol": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskDialogProtocol" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskNotification": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskNotification" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskNotificationEvent": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskNotificationEvent" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskPrio": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskPrio" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskSetting": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskSetting" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskStar": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskStar" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskStatusSupporter": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskStatusSupporter" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskTopic": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskTopic" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Intercom": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Intercom" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.IntercomGroup": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.IntercomGroup" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.IntercomPrio": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.IntercomPrio" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.IntercomRecipientStatus": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.IntercomRecipientStatus" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.IntercomSenderStatus": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.IntercomSenderStatus" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Map": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Map" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Marketplace": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Marketplace" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.MarketplaceSellerArticle": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.MarketplaceSellerArticle" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.MarketplaceSellerPosition": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.MarketplaceSellerPosition" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.MarketplaceSetting": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.MarketplaceSetting" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.MassEmail": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.MassEmail" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.MassEmailRecipient": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.MassEmailRecipient" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.OutputControlButton": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.OutputControlButton" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.OutputControlFormat": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.OutputControlFormat" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.OutputControlMedium": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.OutputControlMedium" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.OutputControlPrinterConfiguration": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.OutputControlPrinterConfiguration" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PackingListBox": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PackingListBox" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PackingListBoxPosition": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PackingListBoxPosition" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PackingListBoxType": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PackingListBoxType" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Partner": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Partner" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerBankAccount": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerBankAccount" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerBillingAddress": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerBillingAddress" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerCatalogNumber": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerCatalogNumber" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerCategory": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerCategory" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerCategoryName": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerCategoryName" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerContactPerson": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerContactPerson" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryContactPerson": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryContactPerson" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryDocType": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryDocType" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryName": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryName" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerDeliveryAddress": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerDeliveryAddress" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerDetail": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerDetail" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerDetailBanking": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerDetailBanking" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerDetailOutput": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerDetailOutput" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerDirectDebitType": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerDirectDebitType" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerDiscountGroup": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerDiscountGroup" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerDiscountGroupName": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerDiscountGroupName" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerGroup": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerGroup" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerInfo": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerInfo" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerPasskey": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerPasskey" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerPaymentType": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerPaymentType" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerPicture": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerPicture" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerPurchasePriceList": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerPurchasePriceList" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerTermsOfDelivery": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerTermsOfDelivery" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerTermsOfPayment": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerTermsOfPayment" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerTermsOfPaymentUNTDID": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerTermsOfPaymentUNTDID" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerToken": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerToken" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerType": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerType" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PhoneCall": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PhoneCall" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PhoneFolder": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PhoneFolder" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PhoneLine": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PhoneLine" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PhoneLineEmployee": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PhoneLineEmployee" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PhoneLog": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PhoneLog" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Procurement": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Procurement" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Production": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Production" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionDataAcquisition": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionDataAcquisition" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionDataAcquisitionReasonCode": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionDataAcquisitionReasonCode" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionDataAcquisitionStatus": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionDataAcquisitionStatus" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionDataAcquisitionWorkplace": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionDataAcquisitionWorkplace" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionDataAcquisitionWorkplaceStatus": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionDataAcquisitionWorkplaceStatus" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionDurationUnit": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionDurationUnit" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionPositionResource": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionPositionResource" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionPositionResourceGroup": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionPositionResourceGroup" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionPositionType": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionPositionType" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionPositionWarehousing": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionPositionWarehousing" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionStatus": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionStatus" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Project": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Project" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProjectDependencyType": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProjectDependencyType" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProjectStatus": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProjectStatus" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ReportTemplate": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ReportTemplate" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ReportType": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ReportType" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Resource": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Resource" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ResourceGroup": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ResourceGroup" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ShippingCarrier": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ShippingCarrier" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ShippingRate": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ShippingRate" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ShippingType": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ShippingType" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ShippingZone": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ShippingZone" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SmartPool": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SmartPool" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SmartPoolApproval": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SmartPoolApproval" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SmartPoolLinkedEntity": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SmartPoolLinkedEntity" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SmartPoolOcr": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SmartPoolOcr" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.StickyNote": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.StickyNote" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SupportSetting": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SupportSetting" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemDataType": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemDataType" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemDatabaseChangeLog": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemDatabaseChangeLog" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemDatabaseLanguage": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemDatabaseLanguage" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemDesktop": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemDesktop" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemDesktopColumn": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemDesktopColumn" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemKeyCombination": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemKeyCombination" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemMapping": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemMapping" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemMappingFileType": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemMappingFileType" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemMappingFormatName": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemMappingFormatName" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemMappingSystemColumn": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemMappingSystemColumn" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemTable": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemTable" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemTableField": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemTableField" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemVersion": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemVersion" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemView": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemView" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TextBlock": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TextBlock" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TextBlockGroup": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TextBlockGroup" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TextVariable": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TextVariable" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TimeTracking": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TimeTracking" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TimeTrackingSetting": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TimeTrackingSetting" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ToolboxButton": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ToolboxButton" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ToolboxField": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ToolboxField" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TranslationArticleInfoText": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TranslationArticleInfoText" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TranslationArticleName1": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TranslationArticleName1" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TranslationArticleName2": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TranslationArticleName2" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TranslationArticleOrderText": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TranslationArticleOrderText" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TranslationArticleUoM": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TranslationArticleUoM" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TranslationDocType": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TranslationDocType" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Warehouse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Warehouse" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseBinLocation": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseBinLocation" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseInfo": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseInfo" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseInventoryCounting": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseInventoryCounting" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseInventoryCountingPosition": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseInventoryCountingPosition" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseInventoryRevaluation": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseInventoryRevaluation" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseInventoryRevaluationPosition": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseInventoryRevaluationPosition" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseMedium": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseMedium" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseQuantity": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseQuantity" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseTransfer": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseTransfer" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseTransferPosition": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseTransferPosition" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseType": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseType" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WebshopActivityLog": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WebshopActivityLog" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WebshopCss": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WebshopCss" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WebshopIcon": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WebshopIcon" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WebshopSetting": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WebshopSetting" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WebshopUserCart": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WebshopUserCart" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Wiki": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Wiki" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WikiCategory": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WikiCategory" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WikiStatus": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WikiStatus" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WorkspaceRoleDesktop": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WorkspaceRoleDesktop" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WorkspaceRoleDesktopButton": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WorkspaceRoleDesktopButton" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WorkspaceRoleMenu": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WorkspaceRoleMenu" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WorkspaceRoleMenuButton": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WorkspaceRoleMenuButton" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WorkspaceUserColumnSetting": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WorkspaceUserColumnSetting" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WorkspaceUserFieldSetting": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WorkspaceUserFieldSetting" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.XXTable": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.XXTable" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW124_ArticlePositionQuantityOpenSum": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW124_ArticlePositionQuantityOpenSum" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW124_ArticleProductionPositionQuantityOpenSum": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW124_ArticleProductionPositionQuantityOpenSum" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW124_ArticleQuantityInventorySum": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW124_ArticleQuantityInventorySum" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW125_ArticleHistoryTable": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW125_ArticleHistoryTable" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW139_ArticleIndividualizationQuantityHistory": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW139_ArticleIndividualizationQuantityHistory" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW140_ArticleQuantityHistoryTable": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW140_ArticleQuantityHistoryTable" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW150_PartnerJoinCustomer": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW150_PartnerJoinCustomer" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW150_PartnerJoinPartnerDetail": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW150_PartnerJoinPartnerDetail" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW150_PartnerJoinSupplier": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW150_PartnerJoinSupplier" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW150_PartnerPurchasePriceListHistoryTable": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW150_PartnerPurchasePriceListHistoryTable" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW180_EmployeeVacationEntitlementHistoryTable": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW180_EmployeeVacationEntitlementHistoryTable" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW181_EmployeeVacationEntitlement": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW181_EmployeeVacationEntitlement" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW193_WarehouseQuantityHistoryTable": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW193_WarehouseQuantityHistoryTable" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW200_DocTypeSequence": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW200_DocTypeSequence" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW216_Doc_DeviceService": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW216_Doc_DeviceService" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW360_MarketplaceSellerPosition": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW360_MarketplaceSellerPosition" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW420_ProductionPosition": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW420_ProductionPosition" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW500_WarehouseInventoryList": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW500_WarehouseInventoryList" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW501_WarehouseInventoryIndividualized": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW501_WarehouseInventoryIndividualized" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW552_ProcurementPurchase": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW552_ProcurementPurchase" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW554_ProcurementProduction": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW554_ProcurementProduction" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW600_FinancePostingDraft": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW600_FinancePostingDraft" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW600_FinancePostingList": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW600_FinancePostingList" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW600_FinancePostingPositionDraft": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW600_FinancePostingPositionDraft" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW605_FinanceAccountPlan": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW605_FinanceAccountPlan" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW660_FinanceTransferPosition": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW660_FinanceTransferPosition" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW670_DueAndOverDue": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW670_DueAndOverDue" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW821_CountryPackageIntrastatCandidate": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW821_CountryPackageIntrastatCandidate" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW_Article": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW_Article" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW_Doc": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW_Doc" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW_Employee": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW_Employee" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW_Partner": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW_Partner" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DeviceService": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DeviceService" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DeviceService_Sproc_UpdateField": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DeviceService_Sproc_UpdateField" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Doc": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocApproval": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DocApproval" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocBillingAddress": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DocBillingAddress" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocCategory": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DocCategory" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocContract": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DocContract" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocContractCyclePeriod": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DocContractCyclePeriod" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocContractStatus": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DocContractStatus" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocContract_Sproc_UpdateField": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DocContract_Sproc_UpdateField" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocDeliveryAddress": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DocDeliveryAddress" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocFooterText": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DocFooterText" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocHeaderText": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DocHeaderText" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocIntrastatRequest": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DocIntrastatRequest" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPosition": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionDimensionText": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionDimensionText" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionInfoText": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionInfoText" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionIntrastatRequest": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionIntrastatRequest" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionOrderText": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionOrderText" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionStatus": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionStatus" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionType": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionType" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPositionWarehousing": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionWarehousing" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocPosition_Sproc_UpdateField": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition_Sproc_UpdateField" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocStatus": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DocStatus" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocType": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DocType" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocTypeInventoryStatus": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DocTypeInventoryStatus" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocTypePrepaymentFactor": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DocTypePrepaymentFactor" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocTypeRevenueEffective": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DocTypeRevenueEffective" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocTypeWarehousingEffective": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DocTypeWarehousingEffective" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocXml": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXml" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocXmlAssignment": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXmlAssignment" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocXmlPosition": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXmlPosition" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.DocXmlPredecessorData": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXmlPredecessorData" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Doc_Sproc_UpdateField": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc_Sproc_UpdateField" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dto.ArticleCarouselDto": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.Dto.ArticleCarouselDto" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dto.CalendarIcsImportResultDto": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.Dto.CalendarIcsImportResultDto" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dto.CalendarInvitationResultDto": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.Dto.CalendarInvitationResultDto" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dto.CalendarInviteeSelectionDto": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.Dto.CalendarInviteeSelectionDto" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dto.EmailAccountTestResultDto": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.Dto.EmailAccountTestResultDto" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dto.EmailBodyDto": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.Dto.EmailBodyDto" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dto.EmailCalendarInviteStatusDto": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.Dto.EmailCalendarInviteStatusDto" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dto.EmployeeTimeTrackingInvitationResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.Dto.EmployeeTimeTrackingInvitationResult" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dto.PartnerPortalDTO": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.Dto.PartnerPortalDTO" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dto.PartnerPortalInvitationResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.Dto.PartnerPortalInvitationResult" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dto.SmartPoolAiInsightsDto": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.Dto.SmartPoolAiInsightsDto" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dto.SmartPoolCopyStatusDto": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.Dto.SmartPoolCopyStatusDto" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Dto.SmartPoolVersionsDto": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.Dto.SmartPoolVersionsDto" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Email": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.Email" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailAccount": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailAccount" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailAttachment": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailAttachment" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailFolder": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailFolder" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailLog": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailLog" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailRuleField": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailRuleField" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailRuleIn": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailRuleIn" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailRuleOut": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailRuleOut" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailSignature": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailSignature" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailSignatureAttachment": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailSignatureAttachment" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailSpamProtectionSender": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailSpamProtectionSender" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailSpamProtectionSubject": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailSpamProtectionSubject" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailSystem": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailSystem" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailTemplate": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailTemplate" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailTemplateAttachment": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailTemplateAttachment" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmailTemplateGroup": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailTemplateGroup" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Employee": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.Employee" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeCommissionGroup": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeCommissionGroup" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeCommissionGroupName": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeCommissionGroupName" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeGroup": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeGroup" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeVacationEntitlement": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeVacationEntitlement" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeVacationRequest": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeVacationRequest" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeVacationRequestApproval": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeVacationRequestApproval" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeVacationType": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeVacationType" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.EmployeeVacationYear": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeVacationYear" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetRole": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetRole" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetRoleClaim": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetRoleClaim" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetUser": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetUser" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetUserClaim": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetUserClaim" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetUserLogin": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetUserLogin" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAspNetUserToken": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetUserToken" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAuthorizationPage": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAuthorizationPage" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAuthorizationRolePagePermission": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAuthorizationRolePagePermission" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAuthorizationRoleWebApiPermission": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAuthorizationRoleWebApiPermission" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExternalAuthorizationWebApi": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAuthorizationWebApi" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraApi": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraApi" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraCode": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraCode" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraField": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraField" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraPage": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraPage" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraPlugin": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraPlugin" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraTable": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraTable" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ExtraTableIndexType": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraTableIndexType" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FieldService": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.FieldService" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FieldServiceResource": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.FieldServiceResource" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FieldServiceResourceGroup": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.FieldServiceResourceGroup" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FieldServiceResourceSegment": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.FieldServiceResourceSegment" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FieldServiceStatus": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.FieldServiceStatus" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FieldService_Sproc_UpdateField": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.FieldService_Sproc_UpdateField" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountAssignment": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountAssignment" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountCategory": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountCategory" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountDetermination": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountDetermination" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountGroup": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountGroup" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountInternalReconciliation": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountInternalReconciliation" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountInternalReconciliationPosition": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountInternalReconciliationPosition" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountPlan": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountPlan" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountPurpose": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountPurpose" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceAccountType": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountType" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceBalanceGroup": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceBalanceGroup" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceBusinessAssessmentGroup": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceBusinessAssessmentGroup" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceClosingPosting": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceClosingPosting" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceClosingPostingPosition": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceClosingPostingPosition" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceCompanyBankAccount": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceCompanyBankAccount" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceCostBearer": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceCostBearer" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceCostCenter": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceCostCenter" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceCostType": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceCostType" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceDunning": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceDunning" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceDunningLevel": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceDunningLevel" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceDunningPosition": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceDunningPosition" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceEInvoiceTaxKeyCategory": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceEInvoiceTaxKeyCategory" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAsset": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAsset" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetClass": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetClass" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationCyclePeriod": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDepreciationCyclePeriod" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationMethod": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDepreciationMethod" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationPlan": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDepreciationPlan" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationType": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDepreciationType" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationTypeDetail": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDepreciationTypeDetail" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetDetail": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDetail" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetGroup": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetGroup" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAssetStatus": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetStatus" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAsset_DisposalPreviewResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAsset_DisposalPreviewResult" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceFixedAsset_SwitchToLinearOptionsResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAsset_SwitchToLinearOptionsResult" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceGroupArticle": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceGroupArticle" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceGroupArticleDetail": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceGroupArticleDetail" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceGroupArticleIdResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceGroupArticleIdResult" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceGroupPartner": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceGroupPartner" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItem": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItem" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItemInternalReconciliation": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItemInternalReconciliation" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItemInternalReconciliationPosition": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItemInternalReconciliationPosition" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItemOrigin": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItemOrigin" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItemStatus": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItemStatus" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpenItemType": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItemType" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpeningBalance": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpeningBalance" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceOpeningBalancePosition": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpeningBalancePosition" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePayment": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePayment" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePaymentPosition": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePaymentPosition" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePaymentPosition_Sproc_UpdateField": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePaymentPosition_Sproc_UpdateField" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePosting": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePosting" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingDraft": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingDraft" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingDraft_CheckNegativeBalanceResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingDraft_CheckNegativeBalanceResult" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingPeriod": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPeriod" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingPeriodStatus": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPeriodStatus" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingPosition": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPosition" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingPositionDraft": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionDraft" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingPositionTemplate": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionTemplate" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingSource": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingSource" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingStatus": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingStatus" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinancePostingTemplate": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingTemplate" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceProfitLossGroup": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceProfitLossGroup" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTaxKey": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTaxKey" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTaxKeyDetail": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTaxKeyDetail" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTaxKeyKind": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTaxKeyKind" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransfer": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransfer" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferBankStatement": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferBankStatement" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferCategory": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferCategory" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferCategoryAccountType": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferCategoryAccountType" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferPosition": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPosition" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferPositionAccountPlan": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionAccountPlan" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferPositionOpenItem": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionOpenItem" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferPositionTextKey": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionTextKey" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferSuggestion": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferSuggestion" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransferSuggestionField": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferSuggestionField" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FinanceTransfer_CheckNegativeBalanceResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransfer_CheckNegativeBalanceResult" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ForeignCurrencyPriceResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.ForeignCurrencyPriceResult" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FormattedSearch": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.FormattedSearch" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.FormattedSearchFireMode": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.FormattedSearchFireMode" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Helpdesk": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.Helpdesk" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskCategory": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskCategory" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskDialog": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskDialog" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskDialogProtocol": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskDialogProtocol" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskNotification": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskNotification" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskNotificationEvent": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskNotificationEvent" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskPrio": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskPrio" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskSetting": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskSetting" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskStar": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskStar" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskStatusSupporter": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskStatusSupporter" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.HelpdeskTopic": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskTopic" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.InsertTextResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.InsertTextResult" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Intercom": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.Intercom" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.IntercomGroup": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.IntercomGroup" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.IntercomPrio": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.IntercomPrio" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.IntercomRecipientStatus": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.IntercomRecipientStatus" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.IntercomSenderStatus": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.IntercomSenderStatus" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.LoggedInEmployeeCalendarDto": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.LoggedInEmployeeCalendarDto" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.LoggedInEmployeeIdDto": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.LoggedInEmployeeIdDto" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Map": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.Map" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Marketplace": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.Marketplace" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.MarketplaceSellerArticle": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.MarketplaceSellerArticle" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.MarketplaceSellerPosition": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.MarketplaceSellerPosition" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.MarketplaceSetting": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.MarketplaceSetting" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.MassEmail": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.MassEmail" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.MassEmailRecipient": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.MassEmailRecipient" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.MenuVisibilityDto": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.MenuVisibilityDto" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.OrderAddressDto": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.OrderAddressDto" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.OrderConfirmationDueState": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.OrderConfirmationDueState" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.OutputControlButton": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.OutputControlButton" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.OutputControlFormat": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.OutputControlFormat" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.OutputControlMedium": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.OutputControlMedium" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.OutputControlPrinterConfiguration": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.OutputControlPrinterConfiguration" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PackingListBox": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.PackingListBox" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PackingListBoxPosition": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.PackingListBoxPosition" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PackingListBoxType": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.PackingListBoxType" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Partner": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.Partner" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerBankAccount": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerBankAccount" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerBillingAddress": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerBillingAddress" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerCatalogNumber": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerCatalogNumber" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerCategory": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerCategory" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerCategoryName": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerCategoryName" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerContactPerson": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerContactPerson" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryContactPerson": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerContactPersonEmailCategoryContactPerson" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryDocType": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerContactPersonEmailCategoryDocType" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryName": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerContactPersonEmailCategoryName" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDeliveryAddress": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDeliveryAddress" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDetail": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDetail" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDetailBanking": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDetailBanking" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDetailOutput": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDetailOutput" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDirectDebitType": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDirectDebitType" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDiscountGroup": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDiscountGroup" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerDiscountGroupName": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDiscountGroupName" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerGroup": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerGroup" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerInfo": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerInfo" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerPasskey": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerPasskey" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerPaymentType": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerPaymentType" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerPicture": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerPicture" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerPurchasePriceList": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerPurchasePriceList" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerTermsOfDelivery": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerTermsOfDelivery" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerTermsOfPayment": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerTermsOfPayment" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerTermsOfPaymentUNTDID": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerTermsOfPaymentUNTDID" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerToken": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerToken" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PartnerType": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerType" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PhoneCall": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.PhoneCall" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PhoneFolder": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.PhoneFolder" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PhoneLine": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.PhoneLine" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PhoneLineEmployee": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.PhoneLineEmployee" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PhoneLog": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.PhoneLog" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PositionTypeIdResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.PositionTypeIdResult" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PostFinanceClosingPostingResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.PostFinanceClosingPostingResult" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PostFinanceOpeningBalanceResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.PostFinanceOpeningBalanceResult" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.PostingReversalResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.PostingReversalResult" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Procurement": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.Procurement" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Production": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.Production" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDataAcquisition": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisition" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDataAcquisitionReasonCode": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisitionReasonCode" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDataAcquisitionStatus": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisitionStatus" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDataAcquisitionWorkplace": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisitionWorkplace" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDataAcquisitionWorkplaceStatus": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisitionWorkplaceStatus" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionDurationUnit": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDurationUnit" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionPosition": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPosition" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionPositionResource": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionResource" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionPositionResourceGroup": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionResourceGroup" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionPositionType": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionType" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionPositionWarehousing": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionWarehousing" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionPosition_Sproc_UpdateField": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPosition_Sproc_UpdateField" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProductionStatus": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionStatus" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Production_Sproc_UpdateField": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.Production_Sproc_UpdateField" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Project": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.Project" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProjectDependencyType": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.ProjectDependencyType" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ProjectStatus": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.ProjectStatus" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ReportTemplate": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.ReportTemplate" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ReportType": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.ReportType" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Resource": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.Resource" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ResourceGroup": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.ResourceGroup" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SalesPersonIdResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.SalesPersonIdResult" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SaveWarehouseInventoryCountingDraftResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.SaveWarehouseInventoryCountingDraftResult" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SaveWarehouseInventoryRevaluationDraftResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.SaveWarehouseInventoryRevaluationDraftResult" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SaveWarehouseTransferDraftResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.SaveWarehouseTransferDraftResult" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ShippingCarrier": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.ShippingCarrier" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ShippingRate": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.ShippingRate" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ShippingType": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.ShippingType" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ShippingZone": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.ShippingZone" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SmartPool": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.SmartPool" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SmartPoolApproval": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.SmartPoolApproval" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SmartPoolLinkedEntity": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.SmartPoolLinkedEntity" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SmartPoolOcr": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.SmartPoolOcr" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SmartSearchResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.SmartSearchResponse" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.StatusIdResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.StatusIdResult" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.StickyNote": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.StickyNote" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SupportSetting": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.SupportSetting" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemDataType": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemDataType" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemDatabaseChangeLog": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemDatabaseChangeLog" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemDatabaseLanguage": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemDatabaseLanguage" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemDesktop": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemDesktop" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemDesktopColumn": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemDesktopColumn" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemKeyCombination": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemKeyCombination" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemMapping": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemMapping" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemMappingFileType": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemMappingFileType" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemMappingFormatName": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemMappingFormatName" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemMappingSystemColumn": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemMappingSystemColumn" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemTable": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemTable" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemTableField": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemTableField" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemVersion": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemVersion" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.SystemView": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemView" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TaxKeyIdResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.TaxKeyIdResult" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TextBlock": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.TextBlock" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TextBlockGroup": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.TextBlockGroup" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TextVariable": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.TextVariable" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TimeTracking": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.TimeTracking" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TimeTrackingSetting": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.TimeTrackingSetting" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ToolboxButton": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxButton" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.ToolboxField": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxField" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationArticleInfoText": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationArticleInfoText" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationArticleName1": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationArticleName1" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationArticleName2": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationArticleName2" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationArticleOrderText": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationArticleOrderText" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationArticleUoM": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationArticleUoM" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.TranslationDocType": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationDocType" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Warehouse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.Warehouse" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseBinLocation": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseBinLocation" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInfo": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInfo" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInventoryCounting": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryCounting" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInventoryCountingPosition": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryCountingPosition" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInventoryRevaluation": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryRevaluation" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInventoryRevaluationPosition": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryRevaluationPosition" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseInventoryRevaluation_Sproc_UpdateField": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryRevaluation_Sproc_UpdateField" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseMedium": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseMedium" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseQuantity": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseQuantity" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseTransfer": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseTransfer" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseTransferPosition": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseTransferPosition" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseTransfer_Sproc_UpdateField": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseTransfer_Sproc_UpdateField" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WarehouseType": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseType" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopActivityLog": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopActivityLog" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopCss": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopCss" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopIcon": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopIcon" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopSetting": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopSetting" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WebshopUserCart": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopUserCart" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.Wiki": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.Wiki" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WikiCategory": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.WikiCategory" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WikiStatus": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.WikiStatus" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceRoleDesktop": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceRoleDesktop" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceRoleDesktopButton": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceRoleDesktopButton" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceRoleMenu": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceRoleMenu" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceRoleMenuButton": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceRoleMenuButton" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceUserColumnSetting": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceUserColumnSetting" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.WorkspaceUserFieldSetting": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceUserFieldSetting" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.XXTable": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.XXTable" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xPROC229I_DocPositionWarehousingResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.xPROC229I_DocPositionWarehousingResult" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xPROC229U_DocPositionWarehousing_BinLocationIdResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.xPROC229U_DocPositionWarehousing_BinLocationIdResult" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xPROC229U_DocPositionWarehousing_WarehouseIdResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.xPROC229U_DocPositionWarehousing_WarehouseIdResult" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xPROC418U_Production_Calculate_QuantityPickResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.xPROC418U_Production_Calculate_QuantityPickResult" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xPROC429I_ProductionPositionWarehousingResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.xPROC429I_ProductionPositionWarehousingResult" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xPROC429U_ProductionPositionWarehousing_BinLocationIdResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.xPROC429U_ProductionPositionWarehousing_BinLocationIdResult" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xPROC429U_ProductionPositionWarehousing_WarehouseIdResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.xPROC429U_ProductionPositionWarehousing_WarehouseIdResult" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xPROC520I_WarehouseInventoryCountingPosition_NewArticleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.xPROC520I_WarehouseInventoryCountingPosition_NewArticleResult" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xPROC521I_WarehouseInventoryRevaluationPosition_ArticleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.xPROC521I_WarehouseInventoryRevaluationPosition_ArticleResult" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xPROC521U_WarehouseInventoryRevaluationPosition_NewValueResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.xPROC521U_WarehouseInventoryRevaluationPosition_NewValueResult" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xPROC522I_WarehouseTransferPosition_ArticleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.xPROC522I_WarehouseTransferPosition_ArticleResult" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xPROC635I_FinanceOpeningBalancePosition_SingleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.xPROC635I_FinanceOpeningBalancePosition_SingleResult" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW124_ArticlePositionQuantityOpenSum": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW124_ArticlePositionQuantityOpenSum" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW124_ArticleProductionPositionQuantityOpenSum": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW124_ArticleProductionPositionQuantityOpenSum" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW124_ArticleQuantityInventorySum": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW124_ArticleQuantityInventorySum" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW125_ArticleHistoryTable": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW125_ArticleHistoryTable" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW139_ArticleIndividualizationQuantityHistory": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW139_ArticleIndividualizationQuantityHistory" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW140_ArticleQuantityHistoryTable": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW140_ArticleQuantityHistoryTable" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW150_PartnerJoinCustomer": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW150_PartnerJoinCustomer" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW150_PartnerJoinPartnerDetail": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW150_PartnerJoinPartnerDetail" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW150_PartnerJoinSupplier": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW150_PartnerJoinSupplier" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW150_PartnerPurchasePriceListHistoryTable": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW150_PartnerPurchasePriceListHistoryTable" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW180_EmployeeVacationEntitlementHistoryTable": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW180_EmployeeVacationEntitlementHistoryTable" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW181_EmployeeVacationEntitlement": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW181_EmployeeVacationEntitlement" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW193_WarehouseQuantityHistoryTable": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW193_WarehouseQuantityHistoryTable" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW200_DocTypeSequence": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW200_DocTypeSequence" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW216_Doc_DeviceService": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW216_Doc_DeviceService" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW360_MarketplaceSellerPosition": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW360_MarketplaceSellerPosition" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW420_ProductionPosition": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW420_ProductionPosition" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW500_WarehouseInventoryList": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW500_WarehouseInventoryList" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW501_WarehouseInventoryIndividualized": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW501_WarehouseInventoryIndividualized" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW552_ProcurementPurchase": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW552_ProcurementPurchase" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW554_ProcurementProduction": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW554_ProcurementProduction" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW600_FinancePostingDraft": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW600_FinancePostingDraft" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW600_FinancePostingList": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW600_FinancePostingList" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW600_FinancePostingPositionDraft": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW600_FinancePostingPositionDraft" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW605_FinanceAccountPlan": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW605_FinanceAccountPlan" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW640_FinancePaymentPosition": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW640_FinancePaymentPosition" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW660_FinanceTransferPosition": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW660_FinanceTransferPosition" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW670_DueAndOverDue": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW670_DueAndOverDue" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW821_CountryPackageIntrastatCandidate": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW821_CountryPackageIntrastatCandidate" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW_Article": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW_Article" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW_Doc": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW_Doc" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW_Employee": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW_Employee" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW_Partner": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW_Partner" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Context.APIEntityResponse_Of_XERP.Shared.Models.xVIEW_ProductionPosition": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW_ProductionPosition" }, "success": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.AddToCartDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "cartId": { "type": "integer", "format": "int32", "nullable": true }, "quantity": { "type": "number", "format": "double" }, "articleId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.AddressDto": { "required": [ "city", "email", "firstName", "lastName", "position", "salutation", "tel1", "title", "zip" ], "type": "object", "properties": { "position": { "maxLength": 50, "minLength": 0, "type": "string" }, "title": { "maxLength": 50, "minLength": 0, "type": "string" }, "salutation": { "maxLength": 50, "minLength": 0, "type": "string" }, "firstName": { "maxLength": 50, "minLength": 0, "type": "string" }, "lastName": { "maxLength": 50, "minLength": 0, "type": "string" }, "street": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "extension": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "zip": { "maxLength": 10, "minLength": 0, "type": "string" }, "city": { "maxLength": 50, "minLength": 0, "type": "string" }, "tel1": { "maxLength": 30, "minLength": 0, "type": "string" }, "tel2": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "mobile": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "fax": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "email": { "maxLength": 50, "minLength": 0, "type": "string" } }, "additionalProperties": false }, "XERP.Shared.Models.AdminApiAuthType": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "adminCurrencyApis": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCurrencyApi" }, "nullable": true }, "extraApis": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraApi" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.AdminBank": { "required": [ "countryId", "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 40, "minLength": 0, "type": "string", "nullable": true }, "name": { "maxLength": 100, "minLength": 0, "type": "string" }, "street": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "zip": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "city": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "countryId": { "maxLength": 2, "minLength": 0, "type": "string" }, "tel1": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "country": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCountry" }, "financeCompanyBankAccounts": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceCompanyBankAccount" }, "nullable": true }, "financePaymentPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePaymentPosition" }, "nullable": true }, "partnerBankAccounts": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerBankAccount" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.AdminBankAccountEBankingType": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "bankAccountEBankingType": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "financeCompanyBankAccounts": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceCompanyBankAccount" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.AdminCompanySetting": { "required": [ "city", "companyCurrencyId", "companyName", "countryId", "isCashBasedTaxation", "perpetualInventoryValuePosting", "street", "zip" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "companyName": { "maxLength": 100, "minLength": 0, "type": "string" }, "name2": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "name3": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "title": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "position": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "salutation": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "firstName": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "lastName": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "street": { "maxLength": 100, "minLength": 0, "type": "string" }, "extension": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "zip": { "maxLength": 20, "minLength": 0, "type": "string" }, "city": { "maxLength": 50, "minLength": 0, "type": "string" }, "countryId": { "maxLength": 2, "minLength": 0, "type": "string" }, "tel1": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "tel2": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "mobile": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "fax": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "email": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "homepage": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "vatNumber": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "taxNumber": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "commercialRegisterNumber": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "remark": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "gln": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "eori": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "sepaCreditorNumber": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "companyCurrencyId": { "maxLength": 3, "minLength": 0, "type": "string" }, "productionWarehouseId": { "type": "integer", "format": "int32" }, "accountPlan": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "isCashBasedTaxation": { "type": "boolean" }, "perpetualInventoryValuePosting": { "type": "boolean" }, "passwordHash": { "maxLength": 256, "minLength": 0, "type": "string", "nullable": true }, "companyType": { "maxLength": 10, "minLength": 0, "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "companyCurrency": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCurrency" }, "country": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCountry" }, "productionWarehouse": { "$ref": "#/components/schemas/XERP.Shared.Models.Warehouse" } }, "additionalProperties": false }, "XERP.Shared.Models.AdminCountry": { "required": [ "country" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 2, "minLength": 0, "type": "string", "nullable": true }, "country": { "maxLength": 50, "minLength": 0, "type": "string" }, "eu": { "type": "boolean" }, "telCountry": { "type": "integer", "format": "int32", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "adminBanks": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminBank" }, "nullable": true }, "adminCompanySettings": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCompanySetting" }, "nullable": true }, "adminZips": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminZip" }, "nullable": true }, "countryPackageIntrastatArticles": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatArticle" }, "nullable": true }, "countryPackageIntrastatDeclarationPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDeclarationPosition" }, "nullable": true }, "countryPackageIntrastatDeclarations": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDeclaration" }, "nullable": true }, "countryPackageIntrastatDocPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDocPosition" }, "nullable": true }, "countryPackageIntrastatReportingEntities": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatReportingEntity" }, "nullable": true }, "docBillingAddresses": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocBillingAddress" }, "nullable": true }, "docDeliveryAddresses": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocDeliveryAddress" }, "nullable": true }, "employees": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Employee" }, "nullable": true }, "financeAccountDeterminations": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountDetermination" }, "nullable": true }, "financeTaxKeys": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTaxKey" }, "nullable": true }, "partnerBillingAddresses": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerBillingAddress" }, "nullable": true }, "partnerContactPeople": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerContactPerson" }, "nullable": true }, "partnerCountries": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Partner" }, "nullable": true }, "partnerDeliveryAddresses": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDeliveryAddress" }, "nullable": true }, "partnerPostboxCountries": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Partner" }, "nullable": true }, "shippingZoneCountries": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ShippingZoneCountry" }, "nullable": true }, "supportSettings": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.SupportSetting" }, "nullable": true }, "webshopSettings": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopSetting" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.AdminCurrency": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 3, "minLength": 0, "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "adminCompanySettings": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCompanySetting" }, "nullable": true }, "adminCurrencyApis": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCurrencyApi" }, "nullable": true }, "adminCurrencyRates": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCurrencyRate" }, "nullable": true }, "articleSalesPriceListNames": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleSalesPriceListName" }, "nullable": true }, "docXmls": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXml" }, "nullable": true }, "docs": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc" }, "nullable": true }, "financeAccountPlans": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountPlan" }, "nullable": true }, "financeCompanyBankAccounts": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceCompanyBankAccount" }, "nullable": true }, "financeDunnings": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceDunning" }, "nullable": true }, "financeOpenItems": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItem" }, "nullable": true }, "financePostingDrafts": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingDraft" }, "nullable": true }, "financePostingTemplates": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingTemplate" }, "nullable": true }, "financePostings": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePosting" }, "nullable": true }, "financeTransfers": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransfer" }, "nullable": true }, "packingListBoxes": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PackingListBox" }, "nullable": true }, "partnerBankAccounts": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerBankAccount" }, "nullable": true }, "partnerDetails": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDetail" }, "nullable": true }, "shippingRates": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ShippingRate" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.AdminCurrencyApi": { "required": [ "authTypeId", "currencyId", "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 100, "minLength": 0, "type": "string" }, "apiUrl": { "maxLength": 1000, "minLength": 0, "type": "string", "nullable": true }, "authTypeId": { "maxLength": 20, "minLength": 0, "type": "string" }, "authUser": { "maxLength": 200, "minLength": 0, "type": "string", "nullable": true }, "authSecret": { "maxLength": 4000, "minLength": 0, "type": "string", "nullable": true }, "authHeaderName": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "currencyId": { "maxLength": 3, "minLength": 0, "type": "string" }, "syncTime": { "type": "string", "format": "date-span", "nullable": true }, "lastSync": { "type": "string", "format": "date-time", "nullable": true }, "lastStatusCode": { "type": "integer", "format": "int32", "nullable": true }, "lastError": { "maxLength": 2000, "minLength": 0, "type": "string", "nullable": true }, "active": { "type": "boolean" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "authType": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminApiAuthType" }, "currency": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCurrency" } }, "additionalProperties": false }, "XERP.Shared.Models.AdminCurrencyRate": { "required": [ "foreignCurrencyId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "foreignCurrencyId": { "maxLength": 3, "minLength": 0, "type": "string" }, "rateDate": { "type": "string", "format": "date-time" }, "rate": { "type": "number", "format": "double" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "foreignCurrency": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCurrency" } }, "additionalProperties": false }, "XERP.Shared.Models.AdminDecimalPlace": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "adminProgramSettingDecimalPlacesLengths": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminProgramSetting" }, "nullable": true }, "adminProgramSettingDecimalPlacesPercentages": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminProgramSetting" }, "nullable": true }, "adminProgramSettingDecimalPlacesPrices": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminProgramSetting" }, "nullable": true }, "adminProgramSettingDecimalPlacesWeights": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminProgramSetting" }, "nullable": true }, "articleTemplates": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleTemplate" }, "nullable": true }, "articles": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Article" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.AdminEDocType": { "required": [ "eDocType" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "eDocType": { "maxLength": 30, "minLength": 0, "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "docXmls": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXml" }, "nullable": true }, "docs": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc" }, "nullable": true }, "partnerDetails": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDetail" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.AdminFederalState": { "required": [ "code", "countryId", "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "countryId": { "maxLength": 2, "minLength": 0, "type": "string" }, "code": { "maxLength": 2, "minLength": 0, "type": "string" }, "name": { "maxLength": 100, "minLength": 0, "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.AdminFiscalPeriod": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 20, "minLength": 0, "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "financePostingPeriods": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPeriod" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.AdminLanguage": { "required": [ "language" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 5, "minLength": 0, "type": "string", "nullable": true }, "language": { "maxLength": 50, "minLength": 0, "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "docXmls": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXml" }, "nullable": true }, "docs": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc" }, "nullable": true }, "emailTemplates": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailTemplate" }, "nullable": true }, "partners": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Partner" }, "nullable": true }, "translationArticleInfoTexts": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationArticleInfoText" }, "nullable": true }, "translationArticleName1s": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationArticleName1" }, "nullable": true }, "translationArticleName2s": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationArticleName2" }, "nullable": true }, "translationArticleOrderTexts": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationArticleOrderText" }, "nullable": true }, "translationArticleUoMs": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationArticleUoM" }, "nullable": true }, "translationDocTypes": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationDocType" }, "nullable": true }, "webshopSettings": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopSetting" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.AdminLocation": { "required": [ "location" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "location": { "maxLength": 20, "minLength": 0, "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "docXmls": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXml" }, "nullable": true }, "docs": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc" }, "nullable": true }, "employees": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Employee" }, "nullable": true }, "financeAccountDeterminations": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountDetermination" }, "nullable": true }, "financeFixedAssets": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAsset" }, "nullable": true }, "partners": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Partner" }, "nullable": true }, "productions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Production" }, "nullable": true }, "warehouses": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Warehouse" }, "nullable": true }, "webshopSettings": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopSetting" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.AdminMonth": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 20, "minLength": 0, "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "financePostingPeriods": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPeriod" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.AdminProgramAiLanguage": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "adminProgramAiLanguageId": { "type": "integer", "format": "int32" }, "en": { "type": "boolean" }, "de": { "type": "boolean" }, "af": { "type": "boolean" }, "ar": { "type": "boolean" }, "az": { "type": "boolean" }, "be": { "type": "boolean" }, "bg": { "type": "boolean" }, "bn": { "type": "boolean" }, "bs": { "type": "boolean" }, "cs": { "type": "boolean" }, "da": { "type": "boolean" }, "es": { "type": "boolean" }, "et": { "type": "boolean" }, "fa": { "type": "boolean" }, "fi": { "type": "boolean" }, "fr": { "type": "boolean" }, "gu": { "type": "boolean" }, "ha": { "type": "boolean" }, "he": { "type": "boolean" }, "hi": { "type": "boolean" }, "hr": { "type": "boolean" }, "hu": { "type": "boolean" }, "hy": { "type": "boolean" }, "id": { "type": "boolean" }, "_is": { "type": "boolean" }, "it": { "type": "boolean" }, "ja": { "type": "boolean" }, "jv": { "type": "boolean" }, "ka": { "type": "boolean" }, "kk": { "type": "boolean" }, "km": { "type": "boolean" }, "ko": { "type": "boolean" }, "lt": { "type": "boolean" }, "lv": { "type": "boolean" }, "ml": { "type": "boolean" }, "mn": { "type": "boolean" }, "mr": { "type": "boolean" }, "ms": { "type": "boolean" }, "my": { "type": "boolean" }, "nl": { "type": "boolean" }, "no": { "type": "boolean" }, "pa": { "type": "boolean" }, "pl": { "type": "boolean" }, "pt": { "type": "boolean" }, "ro": { "type": "boolean" }, "ru": { "type": "boolean" }, "sk": { "type": "boolean" }, "sl": { "type": "boolean" }, "sq": { "type": "boolean" }, "sr": { "type": "boolean" }, "sv": { "type": "boolean" }, "sw": { "type": "boolean" }, "ta": { "type": "boolean" }, "te": { "type": "boolean" }, "th": { "type": "boolean" }, "tl": { "type": "boolean" }, "tr": { "type": "boolean" }, "uk": { "type": "boolean" }, "ur": { "type": "boolean" }, "uz": { "type": "boolean" }, "vi": { "type": "boolean" }, "yo": { "type": "boolean" }, "zh": { "type": "boolean" }, "zu": { "type": "boolean" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.AdminProgramSetting": { "required": [ "unitOfLength", "unitOfTime", "unitOfVolume", "unitOfWeight" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "unitOfLength": { "maxLength": 3, "minLength": 0, "type": "string" }, "unitOfWeight": { "maxLength": 3, "minLength": 0, "type": "string" }, "unitOfVolume": { "maxLength": 3, "minLength": 0, "type": "string" }, "decimalPlacesPricesId": { "type": "integer", "format": "int32" }, "decimalPlacesPercentagesId": { "type": "integer", "format": "int32" }, "decimalPlacesWeightsId": { "type": "integer", "format": "int32" }, "decimalPlacesLengthsId": { "type": "integer", "format": "int32" }, "digitsGeneralLedgerAccount": { "type": "integer", "format": "int32" }, "digitsPersonalAccount": { "type": "integer", "format": "int32" }, "fileUploadLimitMb": { "type": "integer", "format": "int64", "nullable": true }, "unitOfTime": { "maxLength": 20, "minLength": 0, "type": "string" }, "failedAttemptsBeforeLockout": { "type": "integer", "format": "int32" }, "provider": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "apiKey": { "maxLength": 512, "minLength": 0, "type": "string", "nullable": true }, "endpoint": { "maxLength": 2048, "minLength": 0, "type": "string", "nullable": true }, "modelId": { "maxLength": 128, "minLength": 0, "type": "string", "nullable": true }, "useAccountDetermination": { "type": "boolean" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "decimalPlacesLengths": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminDecimalPlace" }, "decimalPlacesPercentages": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminDecimalPlace" }, "decimalPlacesPrices": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminDecimalPlace" }, "decimalPlacesWeights": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminDecimalPlace" } }, "additionalProperties": false }, "XERP.Shared.Models.AdminRoute": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 200, "minLength": 0, "type": "string", "nullable": true }, "workspaceRoleDesktopButtons": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceRoleDesktopButton" }, "nullable": true }, "workspaceRoleMenuButtons": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceRoleMenuButton" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.AdminSvg": { "required": [ "svgCode" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "svgCode": { "maxLength": 4000, "minLength": 0, "type": "string" }, "workspaceRoleDesktopButtons": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceRoleDesktopButton" }, "nullable": true }, "workspaceRoleMenuButtons": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceRoleMenuButton" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.AdminTimeZone": { "required": [ "iana", "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 100, "minLength": 0, "type": "string" }, "iana": { "maxLength": 64, "minLength": 0, "type": "string" }, "active": { "type": "boolean" }, "sortOrder": { "type": "integer", "format": "int32" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "calendarNames": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarName" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.AdminYear": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "employeeVacationRequests": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeVacationRequest" }, "nullable": true }, "financePostingPeriodCalendarYears": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPeriod" }, "nullable": true }, "financePostingPeriodFiscalYears": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPeriod" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.AdminZip": { "required": [ "city", "countryId", "zip" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "zip": { "maxLength": 10, "minLength": 0, "type": "string" }, "city": { "maxLength": 50, "minLength": 0, "type": "string" }, "countryId": { "maxLength": 2, "minLength": 0, "type": "string" }, "telCity": { "maxLength": 5, "minLength": 0, "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "country": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCountry" } }, "additionalProperties": false }, "XERP.Shared.Models.AiChatInfo": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 50, "minLength": 0, "type": "string" }, "instruction": { "maxLength": 1000, "minLength": 0, "type": "string", "nullable": true }, "info": { "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.AiChatSetting": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "info": { "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.AiEmailInfo": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 50, "minLength": 0, "type": "string" }, "instruction": { "maxLength": 1000, "minLength": 0, "type": "string", "nullable": true }, "info": { "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.AiEmbedding": { "required": [ "name", "outputLanguage", "prompt", "promptType" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 20, "minLength": 0, "type": "string" }, "prompt": { "minLength": 1, "type": "string" }, "active": { "type": "boolean" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "promptType": { "maxLength": 10, "minLength": 0, "type": "string" }, "outputLanguage": { "maxLength": 10, "minLength": 0, "type": "string" } }, "additionalProperties": false }, "XERP.Shared.Models.AiTextInfo": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 50, "minLength": 0, "type": "string" }, "instruction": { "maxLength": 1000, "minLength": 0, "type": "string", "nullable": true }, "info": { "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.AppRoleDto": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "maxLength": 256, "minLength": 0, "pattern": "^[A-Za-z]+$", "type": "string", "nullable": true }, "showHome": { "type": "boolean" }, "showSales": { "type": "boolean" }, "showPurchase": { "type": "boolean" }, "showWarehousing": { "type": "boolean" }, "showProduction": { "type": "boolean" }, "showService": { "type": "boolean" }, "showFinance": { "type": "boolean" }, "showManagement": { "type": "boolean" }, "showCrm": { "type": "boolean" }, "showIntercom": { "type": "boolean" }, "showEmail": { "type": "boolean" }, "showCalendar": { "type": "boolean" }, "showPortal": { "type": "boolean" }, "showAdministration": { "type": "boolean" }, "showHelp": { "type": "boolean" }, "showInfo": { "type": "boolean" }, "roleAllPagesPermissionDtos": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.RoleAllPagesPermissionDto" }, "nullable": true }, "roleAllWebApisPermissionDtos": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.RoleAllWebApisPermissionDto" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.AppRole_DeleteRoleRequest": { "type": "object", "properties": { "roleName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.AppRole_GetRoleAllPagesPermissionRequest": { "type": "object", "properties": { "roleName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.AppRole_GetRoleAllWebApisPermissionRequest": { "type": "object", "properties": { "roleName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.AppUser": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "userName": { "type": "string", "nullable": true }, "normalizedUserName": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "normalizedEmail": { "type": "string", "nullable": true }, "emailConfirmed": { "type": "boolean" }, "passwordHash": { "type": "string", "nullable": true }, "securityStamp": { "type": "string", "nullable": true }, "concurrencyStamp": { "type": "string", "nullable": true }, "phoneNumber": { "type": "string", "nullable": true }, "phoneNumberConfirmed": { "type": "boolean" }, "twoFactorEnabled": { "type": "boolean" }, "lockoutEnd": { "type": "string", "format": "date-time", "nullable": true }, "lockoutEnabled": { "type": "boolean" }, "accessFailedCount": { "type": "integer", "format": "int32" }, "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "active": { "type": "boolean" }, "employeeId": { "type": "integer", "format": "int32" }, "changePasswordAtNextLogin": { "type": "boolean" }, "isWebApiUserOnly": { "type": "boolean" }, "cultureCode": { "type": "string", "nullable": true }, "roleId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.AppUserDto": { "required": [ "userName" ], "type": "object", "properties": { "id": { "maxLength": 450, "minLength": 0, "type": "string", "nullable": true }, "userName": { "maxLength": 256, "minLength": 0, "type": "string" }, "oldPassword": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "password": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "confirmPassword": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "firstName": { "maxLength": 250, "minLength": 0, "type": "string", "nullable": true }, "lastName": { "maxLength": 250, "minLength": 0, "type": "string", "nullable": true }, "updatePassword": { "type": "boolean" }, "active": { "type": "boolean" }, "isLockedout": { "type": "boolean" }, "unLockCommand": { "type": "boolean" }, "employeeId": { "type": "integer", "format": "int32" }, "changePasswordAtNextLogin": { "type": "boolean" }, "isWebApiUserOnly": { "type": "boolean" }, "cultureCode": { "type": "string", "nullable": true }, "roleId": { "maxLength": 450, "minLength": 0, "type": "string", "nullable": true }, "roleName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.AppUser_DeleteUserRequest": { "type": "object", "properties": { "userName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.AppUser_GetByUserNameRequest": { "type": "object", "properties": { "userName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.AppUser_GetEmailAccountRequest": { "type": "object", "properties": { "userName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.AppUser_GetUserLinkedWithEmployeeRequest": { "type": "object", "properties": { "employeeId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.AppUser_GetUserRoleRequest": { "type": "object", "properties": { "userName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.AppUser_UpdateCultureCodeRequest": { "type": "object", "properties": { "userId": { "type": "string", "nullable": true }, "cultureCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.Archive": { "required": [ "computerFile" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "partnerId": { "type": "integer", "format": "int32", "nullable": true }, "docId": { "type": "integer", "format": "int32", "nullable": true }, "fileGuid": { "type": "string", "format": "uuid" }, "computerFile": { "type": "string", "format": "byte" }, "tags": { "type": "string", "nullable": true }, "fileName": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "contentType": { "maxLength": 75, "minLength": 0, "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "doc": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc" }, "partner": { "$ref": "#/components/schemas/XERP.Shared.Models.Partner" } }, "additionalProperties": false }, "XERP.Shared.Models.ArchiveDunning": { "required": [ "computerFile" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "partnerId": { "type": "integer", "format": "int32" }, "dunningId": { "type": "integer", "format": "int32" }, "fileGuid": { "type": "string", "format": "uuid" }, "computerFile": { "type": "string", "format": "byte" }, "tags": { "type": "string", "nullable": true }, "fileName": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "contentType": { "maxLength": 75, "minLength": 0, "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "dunning": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceDunning" }, "partner": { "$ref": "#/components/schemas/XERP.Shared.Models.Partner" } }, "additionalProperties": false }, "XERP.Shared.Models.Article": { "required": [ "individualizationTypeId", "matchcode", "name1", "procurementTypeId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "articleTypeId": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "name1": { "maxLength": 100, "minLength": 0, "type": "string" }, "name2": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "matchcode": { "maxLength": 153, "minLength": 0, "type": "string" }, "articleGroupId": { "type": "integer", "format": "int32" }, "uoMId": { "type": "integer", "format": "int32" }, "decimalPlacesQuantitiesId": { "type": "integer", "format": "int32" }, "warehousing": { "type": "boolean" }, "active": { "type": "boolean" }, "favorite": { "type": "boolean" }, "priceUnitId": { "type": "integer", "format": "int32" }, "manufacturerId": { "type": "integer", "format": "int32", "nullable": true }, "manufacturerOrderNumber": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "warehouseInfoId": { "type": "integer", "format": "int32", "nullable": true }, "shop": { "type": "boolean" }, "printing": { "type": "boolean" }, "weight": { "type": "number", "format": "double", "nullable": true }, "length": { "type": "number", "format": "double", "nullable": true }, "width": { "type": "number", "format": "double", "nullable": true }, "height": { "type": "number", "format": "double", "nullable": true }, "volume": { "type": "number", "format": "double", "nullable": true }, "content": { "type": "number", "format": "double", "nullable": true }, "contentUoMId": { "type": "integer", "format": "int32", "nullable": true }, "gtin": { "maxLength": 18, "minLength": 0, "type": "string", "nullable": true }, "salesArticle": { "type": "boolean" }, "salesFinanceGroupId": { "type": "integer", "format": "int32" }, "lotSize": { "type": "number", "format": "double" }, "minimumQuantity": { "type": "number", "format": "double" }, "deliveryTime": { "type": "integer", "format": "int32" }, "purchaseArticle": { "type": "boolean" }, "transferToPurchase": { "type": "boolean" }, "procurementFinanceGroupId": { "type": "integer", "format": "int32" }, "procurementTypeId": { "maxLength": 4, "minLength": 0, "type": "string" }, "procurementTime": { "type": "integer", "format": "int32" }, "standardSupplierId": { "type": "integer", "format": "int32", "nullable": true }, "standardWarehouseId": { "type": "integer", "format": "int32", "nullable": true }, "negativeInventoryAllowed": { "type": "boolean" }, "individualizationTypeId": { "maxLength": 6, "minLength": 0, "type": "string" }, "withMacro": { "type": "boolean" }, "withSet": { "type": "boolean" }, "withAccessory": { "type": "boolean" }, "isEndProduct": { "type": "boolean" }, "isProductionStep": { "type": "boolean" }, "isProductionTime": { "type": "boolean" }, "isPrepayment": { "type": "boolean" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "articleGroup": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleGroup" }, "articleType": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleType" }, "contentUoM": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleUoM" }, "decimalPlacesQuantities": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminDecimalPlace" }, "individualizationType": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleIndividualizationType" }, "manufacturer": { "$ref": "#/components/schemas/XERP.Shared.Models.Partner" }, "priceUnit": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticlePriceUnit" }, "procurementFinanceGroup": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceGroupArticle" }, "procurementType": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProcurementType" }, "salesFinanceGroup": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceGroupArticle" }, "standardSupplier": { "$ref": "#/components/schemas/XERP.Shared.Models.Partner" }, "standardWarehouse": { "$ref": "#/components/schemas/XERP.Shared.Models.Warehouse" }, "uoM": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleUoM" }, "warehouseInfo": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInfo" }, "articleCost": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleCost" }, "articleDimensionText": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleDimensionText" }, "articleInfoText": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleInfoText" }, "articleOrderText": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleOrderText" }, "articlePicture": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticlePicture" }, "articlePriceCalculation": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticlePriceCalculation" }, "articleQuantity": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleQuantity" }, "countryPackageIntrastatArticle": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatArticle" }, "articleAccessoryArticles": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleAccessory" }, "nullable": true }, "articleAccessoryComponents": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleAccessory" }, "nullable": true }, "articleCategories": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleCategory" }, "nullable": true }, "articleIndividualizations": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleIndividualization" }, "nullable": true }, "articleMacroArticles": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleMacro" }, "nullable": true }, "articleMacroComponents": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleMacro" }, "nullable": true }, "articleProductArticles": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProduct" }, "nullable": true }, "articleProductComponents": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProduct" }, "nullable": true }, "articleProductionStepComponentArticleComponents": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProductionStepComponent" }, "nullable": true }, "articleProductionStepComponentArticleProductionSteps": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProductionStepComponent" }, "nullable": true }, "articleProductionStepResources": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProductionStepResource" }, "nullable": true }, "articleSalesPriceLists": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleSalesPriceList" }, "nullable": true }, "articleSetArticles": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleSet" }, "nullable": true }, "articleSetComponents": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleSet" }, "nullable": true }, "docPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition" }, "nullable": true }, "docXmlPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXmlPosition" }, "nullable": true }, "fieldServiceResources": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FieldServiceResource" }, "nullable": true }, "marketplaceSellerArticles": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.MarketplaceSellerArticle" }, "nullable": true }, "partnerCatalogNumbers": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerCatalogNumber" }, "nullable": true }, "partnerPurchasePriceLists": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerPurchasePriceList" }, "nullable": true }, "procurements": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Procurement" }, "nullable": true }, "productionPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPosition" }, "nullable": true }, "productions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Production" }, "nullable": true }, "timeTrackings": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.TimeTracking" }, "nullable": true }, "translationArticleInfoTexts": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationArticleInfoText" }, "nullable": true }, "translationArticleName1s": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationArticleName1" }, "nullable": true }, "translationArticleName2s": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationArticleName2" }, "nullable": true }, "translationArticleOrderTexts": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationArticleOrderText" }, "nullable": true }, "warehouseInventoryCountingPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryCountingPosition" }, "nullable": true }, "warehouseInventoryRevaluationPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryRevaluationPosition" }, "nullable": true }, "warehouseQuantities": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseQuantity" }, "nullable": true }, "warehouseTransferPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseTransferPosition" }, "nullable": true }, "webshopArticleReviews": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopArticleReview" }, "nullable": true }, "webshopCartArticles": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopCartArticle" }, "nullable": true }, "webshopRatings": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopRating" }, "nullable": true }, "webshopSettings": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopSetting" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.ArticleAccessory": { "required": [ "articleId", "componentId", "positionTypeId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "articleId": { "maxLength": 50, "minLength": 0, "type": "string" }, "position": { "type": "integer", "format": "int32" }, "componentId": { "maxLength": 50, "minLength": 0, "type": "string" }, "quantityFormula": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "quantityFactor": { "type": "number", "format": "double" }, "synchronizeQuantity": { "type": "boolean" }, "additionalQuantity": { "type": "number", "format": "double" }, "priceFormula": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "forFree": { "type": "boolean" }, "customerSide": { "type": "boolean" }, "supplierSide": { "type": "boolean" }, "inserting": { "type": "boolean" }, "positionTypeId": { "maxLength": 15, "minLength": 0, "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "article": { "$ref": "#/components/schemas/XERP.Shared.Models.Article" }, "component": { "$ref": "#/components/schemas/XERP.Shared.Models.Article" }, "positionType": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionType" } }, "additionalProperties": false }, "XERP.Shared.Models.ArticleCategory": { "required": [ "articleId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "categoryId": { "type": "integer", "format": "int32" }, "articleId": { "maxLength": 50, "minLength": 0, "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "article": { "$ref": "#/components/schemas/XERP.Shared.Models.Article" }, "category": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleCategoryName" } }, "additionalProperties": false }, "XERP.Shared.Models.ArticleCategoryName": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 50, "minLength": 0, "type": "string" }, "parentId": { "type": "integer", "format": "int32", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "parent": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleCategoryName" }, "articleCategories": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleCategory" }, "nullable": true }, "inverseParent": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleCategoryName" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.ArticleCost": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "articleId": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "costCenterId": { "type": "integer", "format": "int32", "nullable": true }, "costBearerId": { "type": "integer", "format": "int32", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "article": { "$ref": "#/components/schemas/XERP.Shared.Models.Article" }, "costBearer": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceCostBearer" }, "costCenter": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceCostCenter" } }, "additionalProperties": false }, "XERP.Shared.Models.ArticleDimensionText": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "articleId": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "dimensionText": { "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "article": { "$ref": "#/components/schemas/XERP.Shared.Models.Article" } }, "additionalProperties": false }, "XERP.Shared.Models.ArticleEInvoiceUoM": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 3, "minLength": 0, "type": "string", "nullable": true }, "name": { "maxLength": 10, "minLength": 0, "type": "string" }, "description": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "articleUoMs": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleUoM" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.ArticleGroup": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 50, "minLength": 0, "type": "string" }, "parentId": { "type": "integer", "format": "int32", "nullable": true }, "hierarchyLevel": { "type": "integer", "format": "int32", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "parent": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleGroup" }, "articles": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Article" }, "nullable": true }, "employeeCommissionGroups": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeCommissionGroup" }, "nullable": true }, "financeAccountDeterminations": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountDetermination" }, "nullable": true }, "inverseParent": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleGroup" }, "nullable": true }, "partnerDiscountGroups": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDiscountGroup" }, "nullable": true }, "hierarchyNode": { "$ref": "#/components/schemas/Microsoft.EntityFrameworkCore.HierarchyId" }, "children": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleGroup" }, "nullable": true }, "hasChildren": { "type": "boolean" } }, "additionalProperties": false }, "XERP.Shared.Models.ArticleIndividualization": { "required": [ "articleId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "isBatch": { "type": "boolean" }, "articleId": { "maxLength": 50, "minLength": 0, "type": "string" }, "supplierIndividualizationNumber": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "warehouseInfoId": { "type": "integer", "format": "int32", "nullable": true }, "ownGuaranteeFrom": { "type": "string", "format": "date-time", "nullable": true }, "ownGuaranteeUntil": { "type": "string", "format": "date-time", "nullable": true }, "supplierGuaranteeFrom": { "type": "string", "format": "date-time", "nullable": true }, "supplierGuaranteeUntil": { "type": "string", "format": "date-time", "nullable": true }, "info": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "article": { "$ref": "#/components/schemas/XERP.Shared.Models.Article" }, "warehouseInfo": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInfo" }, "articleIndividualizationQuantities": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleIndividualizationQuantity" }, "nullable": true }, "deviceServices": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DeviceService" }, "nullable": true }, "docPositionWarehousings": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionWarehousing" }, "nullable": true }, "packingListBoxPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PackingListBoxPosition" }, "nullable": true }, "productionPositionWarehousings": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionWarehousing" }, "nullable": true }, "warehouseInventoryCountingPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryCountingPosition" }, "nullable": true }, "warehouseTransferPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseTransferPosition" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.ArticleIndividualizationQuantity": { "required": [ "articleIndividualizationId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "articleIndividualizationId": { "maxLength": 30, "minLength": 0, "type": "string" }, "warehouseId": { "type": "integer", "format": "int32", "nullable": true }, "binLocationId": { "type": "integer", "format": "int32", "nullable": true }, "warehouseMediumId": { "type": "integer", "format": "int32", "nullable": true }, "stock": { "type": "number", "format": "double" }, "packed": { "type": "number", "format": "double" }, "nowAvailable": { "type": "number", "format": "double", "nullable": true }, "inventoryCountingPosition": { "type": "integer", "format": "int32", "nullable": true }, "docPosition": { "type": "integer", "format": "int32", "nullable": true }, "productionPosition": { "type": "integer", "format": "int32", "nullable": true }, "transferPosition": { "type": "integer", "format": "int32", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "articleIndividualization": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleIndividualization" }, "warehouse": { "$ref": "#/components/schemas/XERP.Shared.Models.Warehouse" }, "warehouseMedium": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseMedium" } }, "additionalProperties": false }, "XERP.Shared.Models.ArticleIndividualizationType": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 6, "minLength": 0, "type": "string", "nullable": true }, "name": { "maxLength": 6, "minLength": 0, "type": "string" }, "articleTemplates": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleTemplate" }, "nullable": true }, "articles": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Article" }, "nullable": true }, "docPositionWarehousings": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionWarehousing" }, "nullable": true }, "productionPositionWarehousings": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionWarehousing" }, "nullable": true }, "warehouseTransferPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseTransferPosition" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.ArticleInfoText": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "articleId": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "infoText": { "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "article": { "$ref": "#/components/schemas/XERP.Shared.Models.Article" } }, "additionalProperties": false }, "XERP.Shared.Models.ArticleMacro": { "required": [ "articleId", "componentId", "positionTypeId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "articleId": { "maxLength": 50, "minLength": 0, "type": "string" }, "position": { "type": "integer", "format": "int32" }, "componentId": { "maxLength": 50, "minLength": 0, "type": "string" }, "quantityFormula": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "quantityFactor": { "type": "number", "format": "double" }, "additionalQuantity": { "type": "number", "format": "double" }, "priceFormula": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "forFree": { "type": "boolean" }, "dissolve": { "type": "boolean" }, "printComponent": { "type": "boolean" }, "positionTypeId": { "maxLength": 15, "minLength": 0, "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "article": { "$ref": "#/components/schemas/XERP.Shared.Models.Article" }, "component": { "$ref": "#/components/schemas/XERP.Shared.Models.Article" }, "positionType": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionType" } }, "additionalProperties": false }, "XERP.Shared.Models.ArticleOrderText": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "articleId": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "orderText": { "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "article": { "$ref": "#/components/schemas/XERP.Shared.Models.Article" } }, "additionalProperties": false }, "XERP.Shared.Models.ArticlePicture": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "articleId": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "picture": { "type": "string", "format": "byte", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "article": { "$ref": "#/components/schemas/XERP.Shared.Models.Article" } }, "additionalProperties": false }, "XERP.Shared.Models.ArticlePriceCalculation": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "articleId": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "procurementPrice": { "type": "number", "format": "double" }, "factor": { "type": "number", "format": "double" }, "warehouseCost": { "type": "number", "format": "double" }, "overheadCost": { "type": "number", "format": "double" }, "otherCost": { "type": "number", "format": "double" }, "changeInValue": { "type": "number", "format": "double" }, "percentageMarkup1": { "type": "number", "format": "double" }, "fixedMarkup1": { "type": "number", "format": "double" }, "percentageMarkup2": { "type": "number", "format": "double" }, "fixedMarkup2": { "type": "number", "format": "double" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "costPrice": { "type": "number", "format": "double", "nullable": true }, "intermediateCalculatedSalesPrice": { "type": "number", "format": "double", "nullable": true }, "calculatedSalesPrice": { "type": "number", "format": "double", "nullable": true }, "article": { "$ref": "#/components/schemas/XERP.Shared.Models.Article" } }, "additionalProperties": false }, "XERP.Shared.Models.ArticlePriceUnit": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "articleProductionStepResources": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProductionStepResource" }, "nullable": true }, "articleTemplates": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleTemplate" }, "nullable": true }, "articles": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Article" }, "nullable": true }, "docPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition" }, "nullable": true }, "docXmlPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXmlPosition" }, "nullable": true }, "partnerPurchasePriceLists": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerPurchasePriceList" }, "nullable": true }, "resources": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Resource" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.ArticleProcurementType": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 4, "minLength": 0, "type": "string", "nullable": true }, "name": { "maxLength": 10, "minLength": 0, "type": "string" }, "articleTemplates": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleTemplate" }, "nullable": true }, "articles": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Article" }, "nullable": true }, "procurements": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Procurement" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.ArticleProduct": { "required": [ "articleId", "componentId", "taskMode" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "articleId": { "maxLength": 50, "minLength": 0, "type": "string" }, "position": { "type": "integer", "format": "int32" }, "componentId": { "maxLength": 50, "minLength": 0, "type": "string" }, "articleProductionStepComponentTypeId": { "type": "integer", "format": "int32" }, "quantityFormula": { "maxLength": 1000, "minLength": 0, "type": "string", "nullable": true }, "quantityFactor": { "type": "number", "format": "double" }, "priceFormula": { "maxLength": 1000, "minLength": 0, "type": "string", "nullable": true }, "timeFormula": { "maxLength": 1000, "minLength": 0, "type": "string", "nullable": true }, "subPosition": { "type": "boolean" }, "info": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "dissolve": { "type": "boolean" }, "relatedPositionId": { "type": "integer", "format": "int32", "nullable": true }, "subTaskId": { "type": "integer", "format": "int32", "nullable": true }, "predecessorTaskPositionId": { "type": "integer", "format": "int32", "nullable": true }, "predecessorTaskDependencyTypeId": { "maxLength": 2, "minLength": 0, "type": "string", "nullable": true }, "taskMode": { "maxLength": 6, "minLength": 0, "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "article": { "$ref": "#/components/schemas/XERP.Shared.Models.Article" }, "articleProductionStepComponentType": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProductionStepComponentType" }, "component": { "$ref": "#/components/schemas/XERP.Shared.Models.Article" }, "predecessorTaskDependencyType": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProductDependencyType" }, "predecessorTaskPosition": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProduct" }, "relatedPosition": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProduct" }, "subTask": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProduct" }, "inversePredecessorTaskPosition": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProduct" }, "nullable": true }, "inverseRelatedPosition": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProduct" }, "nullable": true }, "inverseSubTask": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProduct" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.ArticleProductDependencyType": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 2, "minLength": 0, "type": "string", "nullable": true }, "name": { "maxLength": 30, "minLength": 0, "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "articleProducts": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProduct" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.ArticleProductionStepComponent": { "required": [ "articleProductionStepId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "articleProductionStepId": { "maxLength": 50, "minLength": 0, "type": "string" }, "articleProductionStepComponentTypeId": { "type": "integer", "format": "int32" }, "position": { "type": "integer", "format": "int32" }, "articleComponentId": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "quantityFactor": { "type": "number", "format": "double" }, "quantityFormular": { "maxLength": 1000, "minLength": 0, "type": "string", "nullable": true }, "priceFormular": { "maxLength": 1000, "minLength": 0, "type": "string", "nullable": true }, "timeFormular": { "maxLength": 1000, "minLength": 0, "type": "string", "nullable": true }, "info": { "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "articleComponent": { "$ref": "#/components/schemas/XERP.Shared.Models.Article" }, "articleProductionStep": { "$ref": "#/components/schemas/XERP.Shared.Models.Article" }, "articleProductionStepComponentType": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProductionStepComponentType" } }, "additionalProperties": false }, "XERP.Shared.Models.ArticleProductionStepComponentType": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 30, "minLength": 0, "type": "string" }, "warehousingEffective": { "type": "integer", "format": "int32" }, "revenueEffective": { "type": "integer", "format": "int32" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "revenueEffectiveNavigation": { "$ref": "#/components/schemas/XERP.Shared.Models.DocTypeRevenueEffective" }, "warehousingEffectiveNavigation": { "$ref": "#/components/schemas/XERP.Shared.Models.DocTypeWarehousingEffective" }, "articleProductionStepComponents": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProductionStepComponent" }, "nullable": true }, "articleProducts": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProduct" }, "nullable": true }, "productionPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPosition" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.ArticleProductionStepResource": { "required": [ "articleProductionStepId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "articleProductionStepId": { "maxLength": 50, "minLength": 0, "type": "string" }, "position": { "type": "integer", "format": "int32" }, "resourceGroupId": { "type": "integer", "format": "int32" }, "resourceId": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "secondsPerCycle": { "type": "number", "format": "double" }, "quantityPerCycle": { "type": "number", "format": "double" }, "priceUnitId": { "type": "integer", "format": "int32" }, "costsPerCycle": { "type": "number", "format": "double" }, "setupCost": { "type": "number", "format": "double" }, "isDefault": { "type": "boolean" }, "quantityFormular": { "maxLength": 1000, "minLength": 0, "type": "string", "nullable": true }, "priceFormular": { "maxLength": 1000, "minLength": 0, "type": "string", "nullable": true }, "timeFormular": { "maxLength": 1000, "minLength": 0, "type": "string", "nullable": true }, "info": { "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "articleProductionStep": { "$ref": "#/components/schemas/XERP.Shared.Models.Article" }, "priceUnit": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticlePriceUnit" }, "resource": { "$ref": "#/components/schemas/XERP.Shared.Models.Resource" }, "resourceGroup": { "$ref": "#/components/schemas/XERP.Shared.Models.ResourceGroup" } }, "additionalProperties": false }, "XERP.Shared.Models.ArticleQuantity": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "articleId": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "stock": { "type": "number", "format": "double", "nullable": true }, "inventoryCountingPosition": { "type": "integer", "format": "int32", "nullable": true }, "docPosition": { "type": "integer", "format": "int32", "nullable": true }, "productionPosition": { "type": "integer", "format": "int32", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "article": { "$ref": "#/components/schemas/XERP.Shared.Models.Article" } }, "additionalProperties": false }, "XERP.Shared.Models.ArticleSalesPriceList": { "required": [ "articleId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "articleId": { "maxLength": 50, "minLength": 0, "type": "string" }, "priceListId": { "type": "integer", "format": "int32" }, "validFrom": { "type": "string", "format": "date-time" }, "salesPrice": { "type": "number", "format": "double" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "article": { "$ref": "#/components/schemas/XERP.Shared.Models.Article" }, "priceList": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleSalesPriceListName" } }, "additionalProperties": false }, "XERP.Shared.Models.ArticleSalesPriceListName": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 20, "minLength": 0, "type": "string" }, "foreignCurrencyId": { "maxLength": 3, "minLength": 0, "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "foreignCurrency": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCurrency" }, "articleSalesPriceLists": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleSalesPriceList" }, "nullable": true }, "docXmls": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXml" }, "nullable": true }, "docs": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc" }, "nullable": true }, "partnerDetails": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDetail" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.ArticleSet": { "required": [ "articleId", "componentId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "articleId": { "maxLength": 50, "minLength": 0, "type": "string" }, "position": { "type": "integer", "format": "int32" }, "componentId": { "maxLength": 50, "minLength": 0, "type": "string" }, "quantityFormula": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "quantityFactor": { "type": "number", "format": "double" }, "additionalQuantity": { "type": "number", "format": "double" }, "priceFormula": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "forFree": { "type": "boolean" }, "dissolve": { "type": "boolean" }, "printComponent": { "type": "boolean" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "article": { "$ref": "#/components/schemas/XERP.Shared.Models.Article" }, "component": { "$ref": "#/components/schemas/XERP.Shared.Models.Article" } }, "additionalProperties": false }, "XERP.Shared.Models.ArticleTemplate": { "required": [ "articleTypeId", "individualizationTypeId", "name", "procurementTypeId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 50, "minLength": 0, "type": "string" }, "articleTypeId": { "maxLength": 20, "minLength": 0, "type": "string" }, "isEndProduct": { "type": "boolean" }, "isProductionStep": { "type": "boolean" }, "isProductionTime": { "type": "boolean" }, "isPrepayment": { "type": "boolean" }, "warehousing": { "type": "boolean" }, "withMacro": { "type": "boolean" }, "withSet": { "type": "boolean" }, "withAccessory": { "type": "boolean" }, "individualizationTypeId": { "maxLength": 6, "minLength": 0, "type": "string" }, "salesArticle": { "type": "boolean" }, "purchaseArticle": { "type": "boolean" }, "procurementTypeId": { "maxLength": 4, "minLength": 0, "type": "string" }, "transferToPurchase": { "type": "boolean" }, "uoMId": { "type": "integer", "format": "int32" }, "decimalPlacesQuantitiesId": { "type": "integer", "format": "int32" }, "priceUnitId": { "type": "integer", "format": "int32" }, "percentageMarkup1": { "type": "number", "format": "double" }, "fixedMarkup1": { "type": "number", "format": "double" }, "percentageMarkup2": { "type": "number", "format": "double" }, "fixedMarkup2": { "type": "number", "format": "double" }, "active": { "type": "boolean" }, "info": { "maxLength": 200, "minLength": 0, "type": "string", "nullable": true }, "autoNumbering": { "type": "boolean" }, "prefix": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "nextNumber": { "type": "integer", "format": "int32" }, "increment": { "type": "integer", "format": "int32" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "articleType": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleType" }, "decimalPlacesQuantities": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminDecimalPlace" }, "individualizationType": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleIndividualizationType" }, "priceUnit": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticlePriceUnit" }, "procurementType": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProcurementType" }, "uoM": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleUoM" } }, "additionalProperties": false }, "XERP.Shared.Models.ArticleType": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "name": { "maxLength": 20, "minLength": 0, "type": "string" }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "articleTemplates": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleTemplate" }, "nullable": true }, "articles": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Article" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.ArticleUoM": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 20, "minLength": 0, "type": "string" }, "uoMEnglish": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "eInvoiceUoMId": { "maxLength": 3, "minLength": 0, "type": "string", "nullable": true }, "productionDurationUnitId": { "maxLength": 1, "minLength": 0, "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "eInvoiceUoM": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleEInvoiceUoM" }, "productionDurationUnit": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDurationUnit" }, "articleContentUoMs": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Article" }, "nullable": true }, "articleTemplates": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleTemplate" }, "nullable": true }, "articleUoMConversionAlternativeUoMs": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleUoMConversion" }, "nullable": true }, "articleUoMConversionBaseUoMs": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleUoMConversion" }, "nullable": true }, "articleUoMs": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Article" }, "nullable": true }, "docPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition" }, "nullable": true }, "docXmlPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXmlPosition" }, "nullable": true }, "productionPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPosition" }, "nullable": true }, "translationArticleUoMs": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationArticleUoM" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.ArticleUoMConversion": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "baseUoMId": { "type": "integer", "format": "int32" }, "factor": { "type": "number", "format": "double" }, "alternativeUoMId": { "type": "integer", "format": "int32" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "alternativeUoM": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleUoM" }, "baseUoM": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleUoM" } }, "additionalProperties": false }, "XERP.Shared.Models.Article_GetComponentHierarchyRequest": { "type": "object", "properties": { "articleId": { "type": "string", "nullable": true }, "partnerType": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.Article_GetIsProductionStepArticleRequest": { "type": "object", "properties": { "articleId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.Article_SalesPriceWizardRequest": { "type": "object", "properties": { "articleGroupId": { "type": "integer", "format": "int32" }, "priceListId": { "type": "integer", "format": "int32" }, "validFrom": { "type": "string", "format": "date-time" }, "salesPrice": { "type": "number", "format": "double" }, "factor": { "type": "number", "format": "double" }, "difference": { "type": "number", "format": "double" } }, "additionalProperties": false }, "XERP.Shared.Models.Attachment": { "required": [ "info" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "entityType": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "entityId": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "info": { "maxLength": 50, "minLength": 0, "type": "string" }, "followUp": { "type": "string", "format": "date-time", "nullable": true }, "attachmentStatusId": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "attachmentStatus": { "$ref": "#/components/schemas/XERP.Shared.Models.AttachmentStatus" }, "attachmentFiles": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.AttachmentFile" }, "nullable": true }, "calendarAppointments": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarAppointment" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.AttachmentFile": { "required": [ "computerFile" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "attachmentId": { "type": "integer", "format": "int32", "nullable": true }, "fileGuid": { "type": "string", "format": "uuid" }, "computerFile": { "type": "string", "format": "byte" }, "tags": { "type": "string", "nullable": true }, "fileName": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "contentType": { "maxLength": 75, "minLength": 0, "type": "string", "nullable": true }, "link": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "attachment": { "$ref": "#/components/schemas/XERP.Shared.Models.Attachment" }, "attachmentFileEmbeddingQueue": { "$ref": "#/components/schemas/XERP.Shared.Models.AttachmentFileEmbeddingQueue" }, "attachmentFileDocumentAnalyses": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.AttachmentFileDocumentAnalysis" }, "nullable": true }, "attachmentFileEmbeddingStatuses": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.AttachmentFileEmbeddingStatus" }, "nullable": true }, "attachmentFileEmbeddings": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.AttachmentFileEmbedding" }, "nullable": true }, "attachmentFileOcrs": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.AttachmentFileOcr" }, "nullable": true }, "attachmentFilePageAnalyses": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.AttachmentFilePageAnalysis" }, "nullable": true }, "uploadedTempFileGuid": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.AttachmentFileDocumentAnalysis": { "required": [ "visionModel" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "attachmentFileId": { "type": "integer", "format": "int32" }, "visionModel": { "maxLength": 200, "minLength": 0, "type": "string" }, "documentType": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "language": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "summary": { "type": "string", "nullable": true }, "pageCount": { "type": "integer", "format": "int32" }, "keywords": { "type": "string", "nullable": true }, "extractedFields": { "type": "string", "nullable": true }, "extractedTables": { "type": "string", "nullable": true }, "extractedCharts": { "type": "string", "nullable": true }, "extractedSignatures": { "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "attachmentFile": { "$ref": "#/components/schemas/XERP.Shared.Models.AttachmentFile" } }, "additionalProperties": false }, "XERP.Shared.Models.AttachmentFileDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "attachmentId": { "type": "integer", "format": "int32", "nullable": true }, "tags": { "type": "string", "nullable": true }, "fileName": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "contentType": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "link": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.AttachmentFileDto_GetByValueRequest": { "type": "object", "properties": { "propertyName": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.AttachmentFileEmbedding": { "required": [ "chunkText", "embeddingModel", "sourceType", "visionModel" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "attachmentFileId": { "type": "integer", "format": "int32" }, "embedding": { "$ref": "#/components/schemas/Microsoft.Data.SqlTypes.SqlVector_Of_System.Single" }, "embeddingModel": { "maxLength": 100, "minLength": 0, "type": "string" }, "chunkNumber": { "type": "integer", "format": "int32" }, "chunkText": { "minLength": 1, "type": "string" }, "pageNumber": { "type": "integer", "format": "int32", "nullable": true }, "sourceType": { "maxLength": 20, "minLength": 0, "type": "string" }, "visionModel": { "maxLength": 100, "minLength": 0, "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "attachmentFile": { "$ref": "#/components/schemas/XERP.Shared.Models.AttachmentFile" } }, "additionalProperties": false }, "XERP.Shared.Models.AttachmentFileEmbeddingQueue": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "attachmentFileId": { "type": "integer", "format": "int32" }, "dateCreated": { "type": "string", "format": "date-time" }, "attachmentFile": { "$ref": "#/components/schemas/XERP.Shared.Models.AttachmentFile" } }, "additionalProperties": false }, "XERP.Shared.Models.AttachmentFileEmbeddingStatus": { "required": [ "embeddingModel", "sourceType", "status", "visionModel" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "attachmentFileId": { "type": "integer", "format": "int32" }, "embeddingModel": { "maxLength": 100, "minLength": 0, "type": "string" }, "status": { "maxLength": 50, "minLength": 0, "type": "string" }, "attemptCount": { "type": "integer", "format": "int32" }, "lastError": { "maxLength": 4000, "minLength": 0, "type": "string", "nullable": true }, "processedAt": { "type": "string", "format": "date-time", "nullable": true }, "sourceType": { "maxLength": 20, "minLength": 0, "type": "string" }, "visionModel": { "maxLength": 100, "minLength": 0, "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "attachmentFile": { "$ref": "#/components/schemas/XERP.Shared.Models.AttachmentFile" } }, "additionalProperties": false }, "XERP.Shared.Models.AttachmentFileOcr": { "required": [ "status" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "attachmentFileId": { "type": "integer", "format": "int32" }, "ocrContent": { "type": "string", "nullable": true }, "ocrContentFormat": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "ocrPlainText": { "type": "string", "nullable": true }, "ocrConfidence": { "type": "number", "format": "double", "nullable": true }, "pageCount": { "type": "integer", "format": "int32", "nullable": true }, "detectedLanguage": { "maxLength": 10, "minLength": 0, "type": "string", "nullable": true }, "ocrStructured": { "type": "string", "nullable": true }, "errorMessage": { "maxLength": 2000, "minLength": 0, "type": "string", "nullable": true }, "durationMs": { "type": "integer", "format": "int32", "nullable": true }, "status": { "maxLength": 75, "minLength": 0, "type": "string" }, "processedAt": { "type": "string", "format": "date-time", "nullable": true }, "ocrEngine": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "attachmentFile": { "$ref": "#/components/schemas/XERP.Shared.Models.AttachmentFile" } }, "additionalProperties": false }, "XERP.Shared.Models.AttachmentFilePageAnalysis": { "required": [ "visionModel" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "attachmentFileId": { "type": "integer", "format": "int32" }, "pageNumber": { "type": "integer", "format": "int32" }, "visionModel": { "maxLength": 200, "minLength": 0, "type": "string" }, "description": { "type": "string", "nullable": true }, "documentType": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "language": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "keywords": { "type": "string", "nullable": true }, "hasTables": { "type": "boolean" }, "hasCharts": { "type": "boolean" }, "hasSignatures": { "type": "boolean" }, "hasHandwriting": { "type": "boolean" }, "hasStamps": { "type": "boolean" }, "structuredData": { "type": "string", "nullable": true }, "durationMs": { "type": "integer", "format": "int64", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "attachmentFile": { "$ref": "#/components/schemas/XERP.Shared.Models.AttachmentFile" } }, "additionalProperties": false }, "XERP.Shared.Models.AttachmentStatus": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "name": { "maxLength": 20, "minLength": 0, "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Attachment" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.AuthorizationPage": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "authorizationRolePagePermissions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.AuthorizationRolePagePermission" }, "nullable": true }, "formattedSearches": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FormattedSearch" }, "nullable": true }, "toolboxButtons": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxButton" }, "nullable": true }, "toolboxFields": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxField" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.AuthorizationRolePagePermission": { "required": [ "pageId", "roleId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "roleId": { "minLength": 1, "type": "string" }, "pageId": { "maxLength": 100, "minLength": 0, "type": "string" }, "createPermission": { "type": "boolean" }, "readPermission": { "type": "boolean" }, "updatePermission": { "type": "boolean" }, "deletePermission": { "type": "boolean" }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "page": { "$ref": "#/components/schemas/XERP.Shared.Models.AuthorizationPage" } }, "additionalProperties": false }, "XERP.Shared.Models.AuthorizationRoleWebApiPermission": { "required": [ "roleId", "webApiId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "roleId": { "minLength": 1, "type": "string" }, "webApiId": { "maxLength": 100, "minLength": 0, "type": "string" }, "createPermission": { "type": "boolean" }, "readPermission": { "type": "boolean" }, "updatePermission": { "type": "boolean" }, "deletePermission": { "type": "boolean" }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "webApi": { "$ref": "#/components/schemas/XERP.Shared.Models.AuthorizationWebApi" } }, "additionalProperties": false }, "XERP.Shared.Models.AuthorizationWebApi": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "authorizationRoleWebApiPermissions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.AuthorizationRoleWebApiPermission" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.Bulletin": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "bulletinCategoryId": { "type": "integer", "format": "int32" }, "subject": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "content": { "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "bulletinCategory": { "$ref": "#/components/schemas/XERP.Shared.Models.BulletinCategory" }, "bulletinReads": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.BulletinRead" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.BulletinCategory": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 50, "minLength": 0, "type": "string" }, "parentId": { "type": "integer", "format": "int32", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "parent": { "$ref": "#/components/schemas/XERP.Shared.Models.BulletinCategory" }, "bulletins": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Bulletin" }, "nullable": true }, "inverseParent": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.BulletinCategory" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.BulletinRead": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "bulletinId": { "type": "integer", "format": "int32" }, "info": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "bulletin": { "$ref": "#/components/schemas/XERP.Shared.Models.Bulletin" } }, "additionalProperties": false }, "XERP.Shared.Models.CalendarAppointment": { "required": [ "caption" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "calendarNameId": { "type": "integer", "format": "int32" }, "appointmentTypeId": { "type": "integer", "format": "int32" }, "startDate": { "type": "string", "format": "date-time", "nullable": true }, "endDate": { "type": "string", "format": "date-time", "nullable": true }, "caption": { "maxLength": 255, "minLength": 0, "type": "string" }, "info": { "type": "string", "nullable": true }, "location": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "statusId": { "type": "integer", "format": "int32", "nullable": true }, "labelId": { "type": "integer", "format": "int32", "nullable": true }, "allDay": { "type": "boolean" }, "recurrenceInfo": { "type": "string", "nullable": true }, "guid": { "type": "string", "format": "uuid", "nullable": true }, "icsUid": { "maxLength": 45, "minLength": 0, "type": "string", "nullable": true }, "icsDtStamp": { "type": "string", "format": "date-time", "nullable": true }, "icsSequence": { "type": "integer", "format": "int32" }, "icsCreated": { "type": "string", "format": "date-time", "nullable": true }, "icsLastModified": { "type": "string", "format": "date-time", "nullable": true }, "icsOrganizer": { "maxLength": 500, "minLength": 0, "type": "string", "nullable": true }, "icsAttendees": { "type": "string", "nullable": true }, "icsCategories": { "maxLength": 500, "minLength": 0, "type": "string", "nullable": true }, "icsClass": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "icsTransparency": { "maxLength": 10, "minLength": 0, "type": "string", "nullable": true }, "icsRecurrenceRule": { "maxLength": 2000, "minLength": 0, "type": "string", "nullable": true }, "icsRecurrenceId": { "type": "string", "format": "date-time", "nullable": true }, "icsExceptionDates": { "type": "string", "nullable": true }, "icsRawEvent": { "type": "string", "nullable": true }, "entityType": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "entityId": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "attachmentId": { "type": "integer", "format": "int32", "nullable": true }, "isDone": { "type": "boolean" }, "reminderMinutesBefore": { "type": "integer", "format": "int32", "nullable": true }, "snoozeUntil": { "type": "string", "format": "date-time", "nullable": true }, "reminderDismissedAt": { "type": "string", "format": "date-time", "nullable": true }, "reminderShownAt": { "type": "string", "format": "date-time", "nullable": true }, "icsExternalUid": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "myResponseStatus": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "attachment": { "$ref": "#/components/schemas/XERP.Shared.Models.Attachment" }, "calendarName": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarName" }, "label": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarAppointmentCategory" }, "calendarAppointmentAttachments": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarAppointmentAttachment" }, "nullable": true }, "calendarAppointmentAttendees": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarAppointmentAttendee" }, "nullable": true }, "emailCalendarInvites": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailCalendarInvite" }, "nullable": true }, "isResponsePending": { "type": "boolean", "readOnly": true }, "isExternalInvitation": { "type": "boolean" }, "isReceivedInvitation": { "type": "boolean", "readOnly": true }, "requiresDeclineBeforeDeletion": { "type": "boolean", "readOnly": true }, "hasAttendees": { "type": "boolean", "readOnly": true }, "isOrganizedMeeting": { "type": "boolean", "readOnly": true }, "displayCaption": { "type": "string", "nullable": true }, "startDateLocal": { "type": "string", "format": "date-time" }, "endDateLocal": { "type": "string", "format": "date-time" }, "borderColor": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.CalendarAppointmentAttachment": { "required": [ "computerFile" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "calendarAppointmentId": { "type": "integer", "format": "int32" }, "fileGuid": { "type": "string", "format": "uuid" }, "computerFile": { "type": "string", "format": "byte" }, "fileName": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "contentType": { "maxLength": 75, "minLength": 0, "type": "string", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "calendarAppointment": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarAppointment" } }, "additionalProperties": false }, "XERP.Shared.Models.CalendarAppointmentAttendee": { "required": [ "email" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "calendarAppointmentId": { "type": "integer", "format": "int32" }, "employeeId": { "type": "integer", "format": "int32", "nullable": true }, "partnerContactPersonId": { "type": "integer", "format": "int32", "nullable": true }, "email": { "maxLength": 256, "minLength": 0, "type": "string" }, "name": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "partStat": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "lastSentSequence": { "type": "integer", "format": "int32" }, "lastMethodSent": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "dateModified": { "type": "string", "format": "date-time" }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "calendarAppointment": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarAppointment" }, "employee": { "$ref": "#/components/schemas/XERP.Shared.Models.Employee" }, "partnerContactPerson": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerContactPerson" } }, "additionalProperties": false }, "XERP.Shared.Models.CalendarAppointmentCategory": { "required": [ "appointmentCategoryColor", "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 50, "minLength": 0, "type": "string" }, "appointmentCategoryColor": { "maxLength": 9, "minLength": 0, "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "calendarAppointments": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarAppointment" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.CalendarHoliday": { "required": [ "holidayName" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "calendarNameId": { "type": "integer", "format": "int32" }, "holidayStartTime": { "type": "string", "format": "date-time" }, "holidayEndTime": { "type": "string", "format": "date-time" }, "holidayName": { "maxLength": 50, "minLength": 0, "type": "string" }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "calendarName": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarName" } }, "additionalProperties": false }, "XERP.Shared.Models.CalendarName": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 20, "minLength": 0, "type": "string" }, "timeZoneId": { "type": "integer", "format": "int32" }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "timeZone": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminTimeZone" }, "calendarAppointments": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarAppointment" }, "nullable": true }, "calendarHolidays": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarHoliday" }, "nullable": true }, "calendarWorkingDays": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarWorkingDay" }, "nullable": true }, "emailCalendarInvites": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailCalendarInvite" }, "nullable": true }, "employees": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Employee" }, "nullable": true }, "webshopSettings": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopSetting" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.CalendarWeekDay": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 20, "minLength": 0, "type": "string" }, "rowVersion": { "type": "string", "format": "byte", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.CalendarWorkingDay": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "calendarNameId": { "type": "integer", "format": "int32" }, "workingDayStart": { "type": "string", "format": "date-time" }, "workingDayEnd": { "type": "string", "format": "date-time" }, "durationHour": { "type": "number", "format": "double", "nullable": true }, "weekDay": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "calendarName": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarName" } }, "additionalProperties": false }, "XERP.Shared.Models.CalendarWorkingDay_RunWizardRequest": { "type": "object", "properties": { "calendarId": { "type": "integer", "format": "int32" }, "startDate": { "type": "string", "format": "date-time", "nullable": true }, "endDate": { "type": "string", "format": "date-time", "nullable": true }, "mondayStart": { "type": "string", "format": "time", "nullable": true }, "mondayEnd": { "type": "string", "format": "time", "nullable": true }, "tuesdayStart": { "type": "string", "format": "time", "nullable": true }, "tuesdayEnd": { "type": "string", "format": "time", "nullable": true }, "wednesdayStart": { "type": "string", "format": "time", "nullable": true }, "wednesdayEnd": { "type": "string", "format": "time", "nullable": true }, "thursdayStart": { "type": "string", "format": "time", "nullable": true }, "thursdayEnd": { "type": "string", "format": "time", "nullable": true }, "fridayStart": { "type": "string", "format": "time", "nullable": true }, "fridayEnd": { "type": "string", "format": "time", "nullable": true }, "saturdayStart": { "type": "string", "format": "time", "nullable": true }, "saturdayEnd": { "type": "string", "format": "time", "nullable": true }, "sundayStart": { "type": "string", "format": "time", "nullable": true }, "sundayEnd": { "type": "string", "format": "time", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.CashFlowDataPointModel": { "type": "object", "properties": { "dateDay": { "type": "string", "format": "date-time" }, "openValue": { "type": "number", "format": "double" }, "highValue": { "type": "number", "format": "double" }, "lowValue": { "type": "number", "format": "double" }, "closeValue": { "type": "number", "format": "double" } }, "additionalProperties": false }, "XERP.Shared.Models.ClientExceptionDto": { "type": "object", "properties": { "message": { "type": "string", "nullable": true }, "stackTrace": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.ClientLogEntryDto": { "type": "object", "properties": { "message": { "type": "string", "nullable": true }, "stackTrace": { "type": "string", "nullable": true }, "source": { "type": "string", "nullable": true }, "timestamp": { "type": "string", "format": "date-time" }, "browser": { "type": "string", "nullable": true }, "userAgent": { "type": "string", "nullable": true }, "path": { "type": "string", "nullable": true }, "level": { "type": "string", "nullable": true }, "exceptionType": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.ComponentHierarchyResult": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "articleId": { "type": "string", "nullable": true }, "name1": { "type": "string", "nullable": true }, "name2": { "type": "string", "nullable": true }, "matchcode": { "type": "string", "nullable": true }, "inserting": { "type": "boolean" }, "quantityFactor": { "type": "number", "format": "double", "nullable": true }, "positionTypeId": { "type": "string", "nullable": true }, "parentId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.CountryPackageDatevAccountNumber": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 3, "minLength": 0, "type": "string", "nullable": true }, "datevAccountNumber": { "type": "integer", "format": "int32", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "idNavigation": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTaxKey" } }, "additionalProperties": false }, "XERP.Shared.Models.CountryPackageDatevExport": { "required": [ "accountPlan", "consultantName", "initials", "keyword" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "accountPlan": { "maxLength": 20, "minLength": 0, "type": "string" }, "datevClient": { "type": "integer", "format": "int32" }, "consultantNumber": { "type": "integer", "format": "int32" }, "consultantName": { "maxLength": 9, "minLength": 0, "type": "string" }, "keyword": { "maxLength": 10, "minLength": 0, "type": "string" }, "initials": { "maxLength": 2, "minLength": 0, "type": "string" }, "financePostingPeriodId": { "type": "integer", "format": "int32" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "financePostingPeriod": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPeriod" } }, "additionalProperties": false }, "XERP.Shared.Models.CountryPackageDatevTaxKeyDetail": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "datevTaxKey": { "type": "integer", "format": "int32", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "idNavigation": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTaxKeyDetail" } }, "additionalProperties": false }, "XERP.Shared.Models.CountryPackageElsterExport": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "legalForm": { "maxLength": 10, "minLength": 0, "type": "string", "nullable": true }, "street": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "zip": { "maxLength": 10, "minLength": 0, "type": "string", "nullable": true }, "city": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "country": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "taxNumber": { "maxLength": 11, "minLength": 0, "type": "string", "nullable": true }, "vatId": { "maxLength": 15, "minLength": 0, "type": "string", "nullable": true }, "taxOffice": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "typeOfCertificate": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "certificateExpiryDate": { "type": "string", "format": "date-time", "nullable": true }, "certificatePassword": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "contactPersonFirstName": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "contactPersonLastName": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "contactPersonPhone": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "contactPersonEmail": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "bankName": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "iban": { "maxLength": 34, "minLength": 0, "type": "string", "nullable": true }, "bic": { "maxLength": 11, "minLength": 0, "type": "string", "nullable": true }, "accountHolder": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "telenumber": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "username": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.CountryPackageIntrastatArticle": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "articleId": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "countryOfOriginId": { "maxLength": 2, "minLength": 0, "type": "string", "nullable": true }, "commodityCodeId": { "type": "integer", "format": "int32", "nullable": true }, "transactionTypeId": { "maxLength": 2, "minLength": 0, "type": "string", "nullable": true }, "statisticalValueEur": { "type": "number", "format": "double", "nullable": true }, "customsDescription": { "maxLength": 200, "minLength": 0, "type": "string", "nullable": true }, "netMassKgPerUnit": { "type": "number", "format": "double", "nullable": true }, "supplementaryQuantityFactor": { "type": "number", "format": "double", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "article": { "$ref": "#/components/schemas/XERP.Shared.Models.Article" }, "commodityCode": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatCommodityCode" }, "countryOfOrigin": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCountry" }, "transactionType": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatTransactionType" } }, "additionalProperties": false }, "XERP.Shared.Models.CountryPackageIntrastatCommodityCode": { "required": [ "code", "description" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "code": { "maxLength": 8, "minLength": 0, "type": "string" }, "description": { "maxLength": 1000, "minLength": 0, "type": "string" }, "supplementaryUnitCode": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "requiresSupplementaryQuantity": { "type": "boolean" }, "validFrom": { "type": "string", "format": "date-time" }, "validTo": { "type": "string", "format": "date-time", "nullable": true }, "active": { "type": "boolean" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "countryPackageIntrastatArticles": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatArticle" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.CountryPackageIntrastatDeclaration": { "required": [ "directionId", "entityName", "entityReportingCountryId", "entityTaxNumber", "entityTaxOfficeFederalStateCode" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "reportingEntityId": { "type": "integer", "format": "int32" }, "directionId": { "maxLength": 10, "minLength": 0, "type": "string" }, "basisDocTypeId": { "maxLength": 35, "minLength": 0, "type": "string", "nullable": true }, "referenceYear": { "type": "integer", "format": "int32" }, "referenceMonth": { "type": "integer", "format": "int32" }, "statusId": { "maxLength": 12, "minLength": 0, "type": "string", "nullable": true }, "entityName": { "maxLength": 100, "minLength": 0, "type": "string" }, "entityReportingCountryId": { "maxLength": 2, "minLength": 0, "type": "string" }, "entityTaxNumber": { "maxLength": 20, "minLength": 0, "type": "string" }, "entityTaxOfficeFederalStateCode": { "maxLength": 2, "minLength": 0, "type": "string" }, "entityDifferentiationNumber": { "maxLength": 3, "minLength": 0, "type": "string", "nullable": true }, "entityVatNumber": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "clerkId": { "type": "integer", "format": "int32" }, "email": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "tel1": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "correctsDeclarationId": { "type": "integer", "format": "int32", "nullable": true }, "validatedAt": { "type": "string", "format": "date-time", "nullable": true }, "submittedAt": { "type": "string", "format": "date-time", "nullable": true }, "submissionReference": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "exportFileName": { "maxLength": 260, "minLength": 0, "type": "string", "nullable": true }, "exportFileHash": { "maxLength": 32, "type": "string", "format": "byte", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "basisDocType": { "$ref": "#/components/schemas/XERP.Shared.Models.DocType" }, "clerk": { "$ref": "#/components/schemas/XERP.Shared.Models.Employee" }, "correctsDeclaration": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDeclaration" }, "direction": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDirection" }, "entityReportingCountry": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCountry" }, "reportingEntity": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatReportingEntity" }, "status": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDeclarationStatus" }, "countryPackageIntrastatDeclarationPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDeclarationPosition" }, "nullable": true }, "inverseCorrectsDeclaration": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDeclaration" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.CountryPackageIntrastatDeclarationPosition": { "required": [ "commodityCode", "countryOfOriginId", "partnerDispatchCountryId", "regionCode", "transactionTypeId", "transportModeId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "declarationId": { "type": "integer", "format": "int32" }, "position": { "type": "integer", "format": "int32" }, "docPositionId": { "type": "integer", "format": "int32" }, "movementDate": { "type": "string", "format": "date-time" }, "transactionTypeId": { "maxLength": 2, "minLength": 0, "type": "string" }, "transportModeId": { "maxLength": 1, "minLength": 0, "type": "string" }, "partnerDispatchCountryId": { "maxLength": 2, "minLength": 0, "type": "string" }, "countryOfOriginId": { "maxLength": 2, "minLength": 0, "type": "string" }, "regionCode": { "maxLength": 2, "minLength": 0, "type": "string" }, "partnerVatNumber": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "commodityCode": { "maxLength": 8, "minLength": 0, "type": "string" }, "goodsDescription": { "maxLength": 200, "minLength": 0, "type": "string", "nullable": true }, "invoiceValueEur": { "type": "number", "format": "double", "nullable": true }, "statisticalValueEur": { "type": "number", "format": "double" }, "netMassKg": { "type": "number", "format": "double", "nullable": true }, "supplementaryQuantity": { "type": "number", "format": "double", "nullable": true }, "isManual": { "type": "boolean" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "countryOfOrigin": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCountry" }, "declaration": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDeclaration" }, "docPosition": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition" }, "transactionType": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatTransactionType" }, "transportMode": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatTransportMode" } }, "additionalProperties": false }, "XERP.Shared.Models.CountryPackageIntrastatDeclarationStatus": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 12, "minLength": 0, "type": "string", "nullable": true }, "name": { "maxLength": 30, "minLength": 0, "type": "string" }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "countryPackageIntrastatDeclarations": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDeclaration" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.CountryPackageIntrastatDeclaration_CreateForPeriodRequest": { "type": "object", "properties": { "reportingEntityId": { "type": "integer", "format": "int32" }, "basisDocTypeId": { "type": "string", "nullable": true }, "referenceYear": { "type": "integer", "format": "int32" }, "referenceMonth": { "type": "integer", "format": "int32" }, "userId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.CountryPackageIntrastatDeclaration_CreateFromPreviewRequest": { "type": "object", "properties": { "reportingEntityId": { "type": "integer", "format": "int32" }, "basisDocTypeId": { "type": "string", "nullable": true }, "referenceYear": { "type": "integer", "format": "int32" }, "referenceMonth": { "type": "integer", "format": "int32" }, "userId": { "type": "integer", "format": "int32", "nullable": true }, "positions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatPreviewPosition" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.CountryPackageIntrastatDeclaration_IdRequest": { "type": "object", "properties": { "declarationId": { "type": "integer", "format": "int32" }, "userId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.CountryPackageIntrastatDeclaration_SubmitRequest": { "type": "object", "properties": { "declarationId": { "type": "integer", "format": "int32" }, "submissionReference": { "type": "string", "nullable": true }, "userId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.CountryPackageIntrastatDirection": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 10, "minLength": 0, "type": "string", "nullable": true }, "name": { "maxLength": 30, "minLength": 0, "type": "string" }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "countryPackageIntrastatDeclarations": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDeclaration" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.CountryPackageIntrastatDocPosition": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "docPositionId": { "type": "integer", "format": "int32" }, "reportingEntityId": { "type": "integer", "format": "int32" }, "included": { "type": "boolean", "nullable": true }, "exclusionReason": { "maxLength": 300, "minLength": 0, "type": "string", "nullable": true }, "movementDate": { "type": "string", "format": "date-time", "nullable": true }, "commodityCode": { "maxLength": 8, "minLength": 0, "type": "string", "nullable": true }, "countryOfOriginId": { "maxLength": 2, "minLength": 0, "type": "string", "nullable": true }, "goodsDescription": { "maxLength": 200, "minLength": 0, "type": "string", "nullable": true }, "transactionTypeId": { "maxLength": 2, "minLength": 0, "type": "string", "nullable": true }, "transportModeId": { "maxLength": 1, "minLength": 0, "type": "string", "nullable": true }, "partnerDispatchCountryId": { "maxLength": 2, "minLength": 0, "type": "string", "nullable": true }, "regionCode": { "maxLength": 2, "minLength": 0, "type": "string", "nullable": true }, "partnerVatNumber": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "invoiceValueEur": { "type": "number", "format": "double", "nullable": true }, "statisticalValueEur": { "type": "number", "format": "double", "nullable": true }, "netMassKg": { "type": "number", "format": "double", "nullable": true }, "supplementaryQuantity": { "type": "number", "format": "double", "nullable": true }, "isManual": { "type": "boolean" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "countryOfOrigin": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCountry" }, "docPosition": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition" }, "transactionType": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatTransactionType" }, "transportMode": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatTransportMode" } }, "additionalProperties": false }, "XERP.Shared.Models.CountryPackageIntrastatPartner": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "partnerId": { "type": "integer", "format": "int32" }, "transportModeId": { "maxLength": 1, "minLength": 0, "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "partner": { "$ref": "#/components/schemas/XERP.Shared.Models.Partner" }, "transportMode": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatTransportMode" } }, "additionalProperties": false }, "XERP.Shared.Models.CountryPackageIntrastatPreviewPosition": { "type": "object", "properties": { "docPositionId": { "type": "integer", "format": "int32" }, "docId": { "type": "integer", "format": "int32" }, "articleId": { "type": "string", "nullable": true }, "movementDate": { "type": "string", "format": "date-time", "nullable": true }, "transactionTypeId": { "type": "string", "nullable": true }, "transportModeId": { "type": "string", "nullable": true }, "partnerDispatchCountryId": { "type": "string", "nullable": true }, "countryOfOriginId": { "type": "string", "nullable": true }, "regionCode": { "type": "string", "nullable": true }, "partnerVatNumber": { "type": "string", "nullable": true }, "commodityCode": { "type": "string", "nullable": true }, "goodsDescription": { "type": "string", "nullable": true }, "invoiceValueEur": { "type": "number", "format": "double", "nullable": true }, "statisticalValueEur": { "type": "number", "format": "double", "nullable": true }, "netMassKg": { "type": "number", "format": "double", "nullable": true }, "supplementaryQuantity": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.CountryPackageIntrastatReportingEntity": { "required": [ "city", "countryId", "name", "street", "taxNumber", "taxOfficeFederalStateCode", "zip" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 100, "minLength": 0, "type": "string" }, "countryId": { "maxLength": 2, "minLength": 0, "type": "string" }, "taxNumber": { "maxLength": 20, "minLength": 0, "type": "string" }, "taxOfficeFederalStateCode": { "maxLength": 2, "minLength": 0, "type": "string" }, "differentiationNumber": { "maxLength": 3, "minLength": 0, "type": "string", "nullable": true }, "arrivalMaterialNumber": { "maxLength": 5, "minLength": 0, "type": "string", "nullable": true }, "dispatchMaterialNumber": { "maxLength": 5, "minLength": 0, "type": "string", "nullable": true }, "vatNumber": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "street": { "maxLength": 100, "minLength": 0, "type": "string" }, "zip": { "maxLength": 20, "minLength": 0, "type": "string" }, "city": { "maxLength": 50, "minLength": 0, "type": "string" }, "clerkId": { "type": "integer", "format": "int32" }, "email": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "tel1": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "dispatchThreshold": { "type": "number", "format": "double", "nullable": true }, "arrivalThreshold": { "type": "number", "format": "double", "nullable": true }, "active": { "type": "boolean" }, "isDefault": { "type": "boolean" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "clerk": { "$ref": "#/components/schemas/XERP.Shared.Models.Employee" }, "country": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCountry" }, "countryPackageIntrastatDeclarations": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDeclaration" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.CountryPackageIntrastatTransactionType": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 2, "minLength": 0, "type": "string", "nullable": true }, "name": { "maxLength": 200, "minLength": 0, "type": "string" }, "validFrom": { "type": "string", "format": "date-time" }, "validTo": { "type": "string", "format": "date-time", "nullable": true }, "active": { "type": "boolean" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "countryPackageIntrastatDeclarationPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDeclarationPosition" }, "nullable": true }, "countryPackageIntrastatDocPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDocPosition" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.CountryPackageIntrastatTransportMode": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 1, "minLength": 0, "type": "string", "nullable": true }, "name": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "countryPackageIntrastatDeclarationPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDeclarationPosition" }, "nullable": true }, "countryPackageIntrastatDocPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDocPosition" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.CountryPackageOssProcedure": { "required": [ "ossProcedure" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "ossProcedure": { "maxLength": 4, "minLength": 0, "type": "string" }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "countryPackageOssProcedureAccountPlans": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageOssProcedureAccountPlan" }, "nullable": true }, "countryPackageOssProcedureDocPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageOssProcedureDocPosition" }, "nullable": true }, "countryPackageOssProcedureFinanceGroupArticleSales": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageOssProcedureFinanceGroupArticleSale" }, "nullable": true }, "countryPackageOssProcedureFinancePostings": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageOssProcedureFinancePosting" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.CountryPackageOssProcedureAccountPlan": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "ossProcedureId": { "type": "integer", "format": "int32" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "idNavigation": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountPlan" }, "ossProcedure": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageOssProcedure" } }, "additionalProperties": false }, "XERP.Shared.Models.CountryPackageOssProcedureDocPosition": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "ossProcedureId": { "type": "integer", "format": "int32" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "idNavigation": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition" }, "ossProcedure": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageOssProcedure" } }, "additionalProperties": false }, "XERP.Shared.Models.CountryPackageOssProcedureFinanceGroupArticleSale": { "required": [ "partnerTypeId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "partnerTypeId": { "maxLength": 10, "minLength": 0, "type": "string" }, "ossProcedureId": { "type": "integer", "format": "int32" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "idNavigation": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceGroupArticle" }, "ossProcedure": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageOssProcedure" }, "partnerType": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerType" } }, "additionalProperties": false }, "XERP.Shared.Models.CountryPackageOssProcedureFinancePosting": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "ossProcedureId": { "type": "integer", "format": "int32" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "idNavigation": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePosting" }, "ossProcedure": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageOssProcedure" } }, "additionalProperties": false }, "XERP.Shared.Models.CountryPackagePrivacyProcessingActivity": { "required": [ "dataSubjectCategories", "legalBasis", "name", "personalDataCategories", "purpose", "recipientCategories" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 200, "minLength": 0, "type": "string" }, "purpose": { "maxLength": 2000, "minLength": 0, "type": "string" }, "legalBasis": { "maxLength": 500, "minLength": 0, "type": "string" }, "dataSubjectCategories": { "maxLength": 2000, "minLength": 0, "type": "string" }, "personalDataCategories": { "maxLength": 2000, "minLength": 0, "type": "string" }, "recipientCategories": { "maxLength": 2000, "minLength": 0, "type": "string" }, "thirdCountryTransfer": { "type": "boolean" }, "thirdCountryDetails": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "retentionPolicy": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "technicalOrganizationalMeasures": { "maxLength": 4000, "minLength": 0, "type": "string", "nullable": true }, "systemModule": { "maxLength": 200, "minLength": 0, "type": "string", "nullable": true }, "responsibleDepartment": { "maxLength": 200, "minLength": 0, "type": "string", "nullable": true }, "responsiblePerson": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "processorInvolved": { "type": "boolean" }, "processorDetails": { "maxLength": 2000, "minLength": 0, "type": "string", "nullable": true }, "dsfaRequired": { "type": "boolean" }, "active": { "type": "boolean" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "countryPackagePrivacyProcessingActivityObjects": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackagePrivacyProcessingActivityObject" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.CountryPackagePrivacyProcessingActivityObject": { "required": [ "fieldName", "moduleName", "objectName", "objectType", "schemaName" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "countryPackagePrivacyProcessingActivityId": { "type": "integer", "format": "int32" }, "objectType": { "maxLength": 30, "minLength": 0, "type": "string" }, "schemaName": { "maxLength": 128, "minLength": 0, "type": "string" }, "objectName": { "maxLength": 128, "minLength": 0, "type": "string" }, "fieldName": { "maxLength": 128, "minLength": 0, "type": "string" }, "moduleName": { "maxLength": 200, "minLength": 0, "type": "string" }, "containsPersonalData": { "type": "boolean" }, "isPrimarySource": { "type": "boolean" }, "isExported": { "type": "boolean" }, "isVisibleInUi": { "type": "boolean" }, "info": { "maxLength": 2000, "minLength": 0, "type": "string", "nullable": true }, "active": { "type": "boolean" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "countryPackagePrivacyProcessingActivity": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackagePrivacyProcessingActivity" } }, "additionalProperties": false }, "XERP.Shared.Models.Crm": { "required": [ "subject" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "partnerId": { "type": "integer", "format": "int32" }, "contactPersonId": { "type": "integer", "format": "int32", "nullable": true }, "crmGroupId": { "type": "integer", "format": "int32" }, "subject": { "maxLength": 100, "minLength": 0, "type": "string" }, "description": { "type": "string", "nullable": true }, "statusId": { "type": "integer", "format": "int32" }, "followUp": { "type": "string", "format": "date-time", "nullable": true }, "typeId": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "employeeId": { "type": "integer", "format": "int32", "nullable": true }, "active": { "type": "boolean" }, "favorite": { "type": "boolean" }, "opportunity": { "type": "integer", "format": "int32" }, "closingProbability": { "type": "integer", "format": "int32" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "contactPerson": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerContactPerson" }, "crmGroup": { "$ref": "#/components/schemas/XERP.Shared.Models.CrmGroup" }, "employee": { "$ref": "#/components/schemas/XERP.Shared.Models.Employee" }, "partner": { "$ref": "#/components/schemas/XERP.Shared.Models.Partner" }, "status": { "$ref": "#/components/schemas/XERP.Shared.Models.CrmStatus" }, "type": { "$ref": "#/components/schemas/XERP.Shared.Models.CrmType" } }, "additionalProperties": false }, "XERP.Shared.Models.CrmActivity": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "partnerId": { "type": "integer", "format": "int32" }, "contactPersonId": { "type": "integer", "format": "int32", "nullable": true }, "subject": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "description": { "maxLength": 1000, "minLength": 0, "type": "string", "nullable": true }, "typeId": { "type": "integer", "format": "int32" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "contactPerson": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerContactPerson" }, "partner": { "$ref": "#/components/schemas/XERP.Shared.Models.Partner" }, "type": { "$ref": "#/components/schemas/XERP.Shared.Models.CrmActivityType" } }, "additionalProperties": false }, "XERP.Shared.Models.CrmActivityType": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 50, "minLength": 0, "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "crmActivities": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CrmActivity" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.CrmGroup": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 50, "minLength": 0, "type": "string" }, "parentId": { "type": "integer", "format": "int32", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "parent": { "$ref": "#/components/schemas/XERP.Shared.Models.CrmGroup" }, "crms": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Crm" }, "nullable": true }, "inverseParent": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CrmGroup" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.CrmStatus": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 20, "minLength": 0, "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "crms": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Crm" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.CrmType": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "name": { "maxLength": 20, "minLength": 0, "type": "string" }, "crms": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Crm" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.Dashboard": { "required": [ "dashboardXml", "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 50, "minLength": 0, "type": "string" }, "dashboardXml": { "minLength": 1, "type": "string" }, "rowVersion": { "type": "string", "format": "byte", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminApiAuthType": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminApiAuthType" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminBank": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminBank" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminBankAccountEBankingType": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminBankAccountEBankingType" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminCompanySetting": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCompanySetting" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminCountry": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCountry" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminCurrency": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCurrency" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminCurrencyApi": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCurrencyApi" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminCurrencyRate": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCurrencyRate" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminDecimalPlace": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminDecimalPlace" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminEDocType": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminEDocType" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminFederalState": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminFederalState" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminFiscalPeriod": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminFiscalPeriod" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminLanguage": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminLanguage" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminLocation": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminLocation" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminMonth": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminMonth" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminProgramAiLanguage": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminProgramAiLanguage" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminProgramSetting": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminProgramSetting" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminRoute": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminRoute" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminSvg": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminSvg" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminTimeZone": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminTimeZone" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminYear": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminYear" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AdminZip": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminZip" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AiChatInfo": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.AiChatInfo" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AiChatSetting": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.AiChatSetting" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AiEmailInfo": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.AiEmailInfo" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AiEmbedding": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.AiEmbedding" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AiTextInfo": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.AiTextInfo" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AppUser": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.AppUser" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Archive": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.Archive" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArchiveDunning": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.ArchiveDunning" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Article": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.Article" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleAccessory": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleAccessory" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleCategory": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleCategory" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleCategoryName": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleCategoryName" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleCost": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleCost" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleDimensionText": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleDimensionText" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleEInvoiceUoM": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleEInvoiceUoM" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleGroup": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleGroup" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleIndividualization": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleIndividualization" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleIndividualizationQuantity": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleIndividualizationQuantity" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleIndividualizationType": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleIndividualizationType" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleInfoText": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleInfoText" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleMacro": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleMacro" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleOrderText": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleOrderText" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticlePicture": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticlePicture" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticlePriceCalculation": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticlePriceCalculation" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticlePriceUnit": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticlePriceUnit" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleProcurementType": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProcurementType" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleProduct": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProduct" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleProductDependencyType": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProductDependencyType" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleProductionStepComponent": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProductionStepComponent" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleProductionStepComponentType": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProductionStepComponentType" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleProductionStepResource": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProductionStepResource" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleQuantity": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleQuantity" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleSalesPriceList": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleSalesPriceList" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleSalesPriceListName": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleSalesPriceListName" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleSet": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleSet" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleTemplate": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleTemplate" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleType": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleType" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleUoM": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleUoM" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ArticleUoMConversion": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleUoMConversion" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Attachment": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.Attachment" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AttachmentFile": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.AttachmentFile" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AttachmentStatus": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.AttachmentStatus" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AuthorizationPage": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.AuthorizationPage" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.AuthorizationWebApi": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.AuthorizationWebApi" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Bulletin": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.Bulletin" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.BulletinCategory": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.BulletinCategory" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.BulletinRead": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.BulletinRead" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CalendarAppointment": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarAppointment" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CalendarAppointmentAttachment": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarAppointmentAttachment" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CalendarAppointmentCategory": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarAppointmentCategory" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CalendarHoliday": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarHoliday" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CalendarName": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarName" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CalendarWeekDay": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarWeekDay" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CalendarWorkingDay": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarWorkingDay" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageDatevExport": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageDatevExport" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageElsterExport": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageElsterExport" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatArticle": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatArticle" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatCommodityCode": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatCommodityCode" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatDeclaration": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDeclaration" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatDeclarationPosition": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDeclarationPosition" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatDeclarationStatus": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDeclarationStatus" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatDirection": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDirection" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatDocPosition": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDocPosition" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatPartner": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatPartner" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatReportingEntity": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatReportingEntity" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatTransactionType": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatTransactionType" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackageIntrastatTransportMode": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatTransportMode" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackagePrivacyProcessingActivity": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackagePrivacyProcessingActivity" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CountryPackagePrivacyProcessingActivityObject": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackagePrivacyProcessingActivityObject" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Crm": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.Crm" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CrmActivity": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.CrmActivity" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CrmActivityType": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.CrmActivityType" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CrmGroup": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.CrmGroup" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CrmStatus": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.CrmStatus" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.CrmType": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.CrmType" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Dashboard": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.Dashboard" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DeviceService": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.DeviceService" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Doc": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocApproval": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.DocApproval" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocBillingAddress": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.DocBillingAddress" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocCategory": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.DocCategory" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocContract": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.DocContract" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocContractCyclePeriod": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.DocContractCyclePeriod" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocContractStatus": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.DocContractStatus" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocDeliveryAddress": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.DocDeliveryAddress" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocFooterText": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.DocFooterText" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocHeaderText": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.DocHeaderText" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocPosition": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocPositionDimensionText": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionDimensionText" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocPositionInfoText": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionInfoText" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocPositionOrderText": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionOrderText" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocPositionStatus": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionStatus" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocPositionType": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionType" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocPositionWarehousing": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionWarehousing" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocStatus": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.DocStatus" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocType": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.DocType" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocTypeInventoryStatus": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.DocTypeInventoryStatus" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocTypePrepaymentFactor": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.DocTypePrepaymentFactor" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocTypeRevenueEffective": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.DocTypeRevenueEffective" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocTypeWarehousingEffective": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.DocTypeWarehousingEffective" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocXml": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXml" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocXmlAssignment": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXmlAssignment" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.DocXmlPosition": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXmlPosition" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Email": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.Email" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailAccount": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailAccount" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailAttachment": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailAttachment" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailFolder": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailFolder" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailLog": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailLog" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailRuleField": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailRuleField" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailRuleIn": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailRuleIn" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailRuleOut": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailRuleOut" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailSignature": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailSignature" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailSignatureAttachment": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailSignatureAttachment" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailSpamProtectionSender": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailSpamProtectionSender" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailSpamProtectionSubject": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailSpamProtectionSubject" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailSystem": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailSystem" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailTemplate": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailTemplate" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailTemplateAttachment": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailTemplateAttachment" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmailTemplateGroup": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailTemplateGroup" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Employee": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.Employee" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmployeeCommissionGroup": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeCommissionGroup" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmployeeCommissionGroupName": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeCommissionGroupName" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmployeeGroup": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeGroup" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmployeeVacationEntitlement": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeVacationEntitlement" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmployeeVacationRequest": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeVacationRequest" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmployeeVacationRequestApproval": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeVacationRequestApproval" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmployeeVacationType": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeVacationType" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.EmployeeVacationYear": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeVacationYear" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAspNetRole": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetRole" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAspNetRoleClaim": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetRoleClaim" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAspNetUser": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetUser" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAspNetUserClaim": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetUserClaim" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAspNetUserLogin": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetUserLogin" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAspNetUserToken": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetUserToken" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAuthorizationPage": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAuthorizationPage" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAuthorizationRolePagePermission": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAuthorizationRolePagePermission" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAuthorizationRoleWebApiPermission": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAuthorizationRoleWebApiPermission" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExternalAuthorizationWebApi": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAuthorizationWebApi" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExtraApi": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraApi" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExtraCode": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraCode" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExtraField": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraField" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExtraPage": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraPage" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExtraPlugin": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraPlugin" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExtraTable": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraTable" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ExtraTableIndexType": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraTableIndexType" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FieldService": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.FieldService" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FieldServiceResource": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.FieldServiceResource" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FieldServiceResourceGroup": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.FieldServiceResourceGroup" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FieldServiceResourceSegment": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.FieldServiceResourceSegment" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FieldServiceStatus": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.FieldServiceStatus" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceAccountAssignment": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountAssignment" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceAccountCategory": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountCategory" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceAccountDetermination": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountDetermination" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceAccountGroup": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountGroup" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceAccountInternalReconciliation": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountInternalReconciliation" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceAccountInternalReconciliationPosition": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountInternalReconciliationPosition" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceAccountPlan": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountPlan" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceAccountPurpose": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountPurpose" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceAccountType": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountType" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceBalanceGroup": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceBalanceGroup" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceBusinessAssessmentGroup": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceBusinessAssessmentGroup" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceClosingPosting": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceClosingPosting" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceClosingPostingPosition": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceClosingPostingPosition" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceCompanyBankAccount": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceCompanyBankAccount" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceCostBearer": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceCostBearer" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceCostCenter": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceCostCenter" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceCostType": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceCostType" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceDunning": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceDunning" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceDunningLevel": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceDunningLevel" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceDunningPosition": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceDunningPosition" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceEInvoiceTaxKeyCategory": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceEInvoiceTaxKeyCategory" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAsset": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAsset" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAssetClass": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetClass" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationCyclePeriod": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDepreciationCyclePeriod" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationMethod": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDepreciationMethod" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationPlan": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDepreciationPlan" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationType": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDepreciationType" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAssetDepreciationTypeDetail": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDepreciationTypeDetail" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAssetDetail": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDetail" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAssetGroup": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetGroup" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceFixedAssetStatus": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetStatus" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceGroupArticle": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceGroupArticle" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceGroupArticleDetail": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceGroupArticleDetail" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceGroupPartner": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceGroupPartner" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceOpenItem": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItem" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceOpenItemInternalReconciliation": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItemInternalReconciliation" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceOpenItemInternalReconciliationPosition": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItemInternalReconciliationPosition" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceOpenItemOrigin": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItemOrigin" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceOpenItemStatus": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItemStatus" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceOpenItemType": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItemType" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceOpeningBalance": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpeningBalance" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceOpeningBalancePosition": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpeningBalancePosition" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePayment": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePayment" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePaymentPosition": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePaymentPosition" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePosting": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePosting" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePostingDraft": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingDraft" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePostingPeriod": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPeriod" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePostingPeriodStatus": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPeriodStatus" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePostingPosition": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPosition" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePostingPositionDraft": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionDraft" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePostingPositionTemplate": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionTemplate" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePostingSource": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingSource" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePostingStatus": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingStatus" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinancePostingTemplate": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingTemplate" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceProfitLossGroup": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceProfitLossGroup" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTaxKey": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTaxKey" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTaxKeyDetail": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTaxKeyDetail" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTaxKeyKind": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTaxKeyKind" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransfer": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransfer" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransferBankStatement": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferBankStatement" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransferCategory": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferCategory" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransferCategoryAccountType": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferCategoryAccountType" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransferPosition": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPosition" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransferPositionAccountPlan": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionAccountPlan" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransferPositionOpenItem": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionOpenItem" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransferPositionTextKey": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionTextKey" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransferSuggestion": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferSuggestion" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FinanceTransferSuggestionField": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferSuggestionField" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FormattedSearch": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.FormattedSearch" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.FormattedSearchFireMode": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.FormattedSearchFireMode" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Helpdesk": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.Helpdesk" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskCategory": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskCategory" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskDialog": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskDialog" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskDialogProtocol": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskDialogProtocol" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskNotification": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskNotification" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskNotificationEvent": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskNotificationEvent" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskPrio": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskPrio" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskSetting": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskSetting" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskStar": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskStar" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskStatusSupporter": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskStatusSupporter" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.HelpdeskTopic": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskTopic" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Intercom": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.Intercom" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.IntercomGroup": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.IntercomGroup" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.IntercomPrio": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.IntercomPrio" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.IntercomRecipientStatus": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.IntercomRecipientStatus" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.IntercomSenderStatus": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.IntercomSenderStatus" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Map": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.Map" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Marketplace": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.Marketplace" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.MarketplaceSellerArticle": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.MarketplaceSellerArticle" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.MarketplaceSellerPosition": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.MarketplaceSellerPosition" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.MarketplaceSetting": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.MarketplaceSetting" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.MassEmail": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.MassEmail" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.MassEmailRecipient": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.MassEmailRecipient" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.OutputControlButton": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.OutputControlButton" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.OutputControlFormat": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.OutputControlFormat" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.OutputControlMedium": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.OutputControlMedium" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.OutputControlPrinterConfiguration": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.OutputControlPrinterConfiguration" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PackingListBox": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.PackingListBox" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PackingListBoxPosition": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.PackingListBoxPosition" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PackingListBoxType": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.PackingListBoxType" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Partner": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.Partner" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerBankAccount": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerBankAccount" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerBillingAddress": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerBillingAddress" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerCatalogNumber": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerCatalogNumber" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerCategory": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerCategory" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerCategoryName": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerCategoryName" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerContactPerson": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerContactPerson" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryContactPerson": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerContactPersonEmailCategoryContactPerson" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryDocType": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerContactPersonEmailCategoryDocType" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerContactPersonEmailCategoryName": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerContactPersonEmailCategoryName" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerDeliveryAddress": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDeliveryAddress" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerDetail": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDetail" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerDetailBanking": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDetailBanking" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerDetailOutput": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDetailOutput" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerDirectDebitType": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDirectDebitType" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerDiscountGroup": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDiscountGroup" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerDiscountGroupName": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDiscountGroupName" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerGroup": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerGroup" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerInfo": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerInfo" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerPasskey": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerPasskey" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerPaymentType": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerPaymentType" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerPicture": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerPicture" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerPurchasePriceList": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerPurchasePriceList" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerTermsOfDelivery": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerTermsOfDelivery" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerTermsOfPayment": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerTermsOfPayment" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerTermsOfPaymentUNTDID": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerTermsOfPaymentUNTDID" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerToken": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerToken" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PartnerType": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerType" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PhoneCall": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.PhoneCall" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PhoneFolder": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.PhoneFolder" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PhoneLine": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.PhoneLine" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PhoneLineEmployee": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.PhoneLineEmployee" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.PhoneLog": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.PhoneLog" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Procurement": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.Procurement" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Production": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.Production" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionDataAcquisition": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisition" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionDataAcquisitionReasonCode": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisitionReasonCode" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionDataAcquisitionStatus": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisitionStatus" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionDataAcquisitionWorkplace": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisitionWorkplace" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionDataAcquisitionWorkplaceStatus": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisitionWorkplaceStatus" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionDurationUnit": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDurationUnit" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionPositionResource": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionResource" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionPositionResourceGroup": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionResourceGroup" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionPositionType": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionType" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionPositionWarehousing": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionWarehousing" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProductionStatus": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionStatus" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Project": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.Project" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProjectDependencyType": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.ProjectDependencyType" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ProjectStatus": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.ProjectStatus" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ReportTemplate": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.ReportTemplate" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ReportType": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.ReportType" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Resource": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.Resource" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ResourceGroup": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.ResourceGroup" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ShippingCarrier": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.ShippingCarrier" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ShippingRate": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.ShippingRate" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ShippingType": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.ShippingType" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ShippingZone": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.ShippingZone" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SmartPool": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.SmartPool" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SmartPoolApproval": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.SmartPoolApproval" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SmartPoolLinkedEntity": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.SmartPoolLinkedEntity" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SmartPoolOcr": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.SmartPoolOcr" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.StickyNote": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.StickyNote" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SupportSetting": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.SupportSetting" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemDataType": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemDataType" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemDatabaseChangeLog": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemDatabaseChangeLog" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemDatabaseLanguage": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemDatabaseLanguage" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemDesktop": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemDesktop" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemDesktopColumn": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemDesktopColumn" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemKeyCombination": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemKeyCombination" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemMapping": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemMapping" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemMappingFileType": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemMappingFileType" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemMappingFormatName": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemMappingFormatName" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemMappingSystemColumn": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemMappingSystemColumn" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemTable": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemTable" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemTableField": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemTableField" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemVersion": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemVersion" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.SystemView": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemView" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TextBlock": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.TextBlock" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TextBlockGroup": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.TextBlockGroup" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TextVariable": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.TextVariable" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TimeTracking": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.TimeTracking" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TimeTrackingSetting": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.TimeTrackingSetting" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ToolboxButton": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxButton" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.ToolboxField": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxField" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TranslationArticleInfoText": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationArticleInfoText" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TranslationArticleName1": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationArticleName1" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TranslationArticleName2": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationArticleName2" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TranslationArticleOrderText": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationArticleOrderText" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TranslationArticleUoM": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationArticleUoM" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.TranslationDocType": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationDocType" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Warehouse": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.Warehouse" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseBinLocation": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseBinLocation" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseInfo": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInfo" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseInventoryCounting": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryCounting" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseInventoryCountingPosition": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryCountingPosition" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseInventoryRevaluation": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryRevaluation" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseInventoryRevaluationPosition": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryRevaluationPosition" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseMedium": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseMedium" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseQuantity": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseQuantity" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseTransfer": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseTransfer" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseTransferPosition": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseTransferPosition" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WarehouseType": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseType" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WebshopActivityLog": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopActivityLog" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WebshopCss": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopCss" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WebshopIcon": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopIcon" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WebshopSetting": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopSetting" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WebshopUserCart": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopUserCart" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.Wiki": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.Wiki" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WikiCategory": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.WikiCategory" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WikiStatus": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.WikiStatus" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WorkspaceRoleDesktop": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceRoleDesktop" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WorkspaceRoleDesktopButton": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceRoleDesktopButton" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WorkspaceRoleMenu": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceRoleMenu" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WorkspaceRoleMenuButton": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceRoleMenuButton" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WorkspaceUserColumnSetting": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceUserColumnSetting" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.WorkspaceUserFieldSetting": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceUserFieldSetting" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.XXTable": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.XXTable" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW124_ArticlePositionQuantityOpenSum": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW124_ArticlePositionQuantityOpenSum" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW124_ArticleProductionPositionQuantityOpenSum": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW124_ArticleProductionPositionQuantityOpenSum" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW124_ArticleQuantityInventorySum": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW124_ArticleQuantityInventorySum" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW125_ArticleHistoryTable": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW125_ArticleHistoryTable" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW139_ArticleIndividualizationQuantityHistory": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW139_ArticleIndividualizationQuantityHistory" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW140_ArticleQuantityHistoryTable": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW140_ArticleQuantityHistoryTable" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW150_PartnerJoinCustomer": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW150_PartnerJoinCustomer" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW150_PartnerJoinPartnerDetail": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW150_PartnerJoinPartnerDetail" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW150_PartnerJoinSupplier": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW150_PartnerJoinSupplier" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW150_PartnerPurchasePriceListHistoryTable": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW150_PartnerPurchasePriceListHistoryTable" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW180_EmployeeVacationEntitlementHistoryTable": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW180_EmployeeVacationEntitlementHistoryTable" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW181_EmployeeVacationEntitlement": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW181_EmployeeVacationEntitlement" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW193_WarehouseQuantityHistoryTable": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW193_WarehouseQuantityHistoryTable" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW200_DocTypeSequence": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW200_DocTypeSequence" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW216_Doc_DeviceService": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW216_Doc_DeviceService" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW360_MarketplaceSellerPosition": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW360_MarketplaceSellerPosition" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW420_ProductionPosition": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW420_ProductionPosition" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW500_WarehouseInventoryList": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW500_WarehouseInventoryList" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW501_WarehouseInventoryIndividualized": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW501_WarehouseInventoryIndividualized" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW552_ProcurementPurchase": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW552_ProcurementPurchase" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW554_ProcurementProduction": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW554_ProcurementProduction" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW600_FinancePostingDraft": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW600_FinancePostingDraft" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW600_FinancePostingList": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW600_FinancePostingList" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW600_FinancePostingPositionDraft": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW600_FinancePostingPositionDraft" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW605_FinanceAccountPlan": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW605_FinanceAccountPlan" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW660_FinanceTransferPosition": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW660_FinanceTransferPosition" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW670_DueAndOverDue": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW670_DueAndOverDue" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW821_CountryPackageIntrastatCandidate": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW821_CountryPackageIntrastatCandidate" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW_Article": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW_Article" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW_Doc": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW_Doc" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW_Employee": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW_Employee" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DataGraphWithXXFields_Of_XERP.Shared.Models.xVIEW_Partner": { "type": "object", "properties": { "mainModel": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW_Partner" }, "leftModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "rightModel": { "$ref": "#/components/schemas/XERP.Shared.Models.UpdateXXFieldsDataRequest" }, "toolboxFields": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest" } }, "additionalProperties": false }, "XERP.Shared.Models.DbTableDefault": { "type": "object", "properties": { "tableName": { "type": "string", "nullable": true }, "fieldName": { "type": "string", "nullable": true }, "defaultValue": { "type": "string", "nullable": true }, "isPrimaryKey": { "type": "boolean" }, "isUnique": { "type": "boolean" } }, "additionalProperties": false }, "XERP.Shared.Models.DeviceService": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "docId": { "type": "integer", "format": "int32" }, "serviceManagerId": { "type": "integer", "format": "int32", "nullable": true }, "deviceSerialNumberId": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "deviceSerialNumber": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleIndividualization" }, "doc": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc" }, "serviceManager": { "$ref": "#/components/schemas/XERP.Shared.Models.Employee" } }, "additionalProperties": false }, "XERP.Shared.Models.DeviceService_Sproc_UpdateField": { "type": "object", "properties": { "docId": { "type": "integer", "format": "int32" }, "fieldName": { "type": "string", "nullable": true }, "fieldValue": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.Doc": { "required": [ "docCategoryId", "docNumber", "docTypeId", "statusId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "docCategoryId": { "maxLength": 17, "minLength": 0, "type": "string" }, "docTypeId": { "maxLength": 35, "minLength": 0, "type": "string" }, "docNumber": { "maxLength": 20, "minLength": 0, "type": "string" }, "inventoryStatusId": { "maxLength": 10, "minLength": 0, "type": "string", "nullable": true }, "warehousingEffective": { "type": "integer", "format": "int32" }, "revenueEffective": { "type": "integer", "format": "int32" }, "partnerId": { "type": "integer", "format": "int32", "nullable": true }, "partnerDetailId": { "type": "integer", "format": "int32", "nullable": true }, "statusId": { "maxLength": 12, "minLength": 0, "type": "string" }, "transferable": { "type": "boolean" }, "draft": { "type": "boolean" }, "docDate": { "type": "string", "format": "date-time" }, "postingDate": { "type": "string", "format": "date-time", "nullable": true }, "postingPeriodId": { "type": "integer", "format": "int32", "nullable": true }, "shippingDate": { "type": "string", "format": "date-time" }, "deliveryDate": { "type": "string", "format": "date-time" }, "partnerContactPersonId": { "type": "integer", "format": "int32", "nullable": true }, "clerkId": { "type": "integer", "format": "int32" }, "salesPersonId": { "type": "integer", "format": "int32", "nullable": true }, "ourReference": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "yourDoc": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "yourDocDate": { "type": "string", "format": "date-time", "nullable": true }, "internalRemark": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "subject": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "version": { "type": "integer", "format": "int32", "nullable": true }, "divergentInvoiceRecipientId": { "type": "integer", "format": "int32", "nullable": true }, "termsOfDeliveryId": { "type": "integer", "format": "int32", "nullable": true }, "euWork": { "type": "boolean" }, "languageId": { "maxLength": 5, "minLength": 0, "type": "string", "nullable": true }, "reportTemplateId": { "type": "integer", "format": "int32" }, "approvalRequired": { "type": "boolean" }, "eDocTypeId": { "type": "integer", "format": "int32" }, "termsOfPaymentId": { "type": "integer", "format": "int32", "nullable": true }, "projectId": { "type": "integer", "format": "int32", "nullable": true }, "priceListId": { "type": "integer", "format": "int32", "nullable": true }, "docDiscountPercent": { "type": "number", "format": "double" }, "downPaymentRequest": { "type": "number", "format": "double" }, "downPaymentSum": { "type": "number", "format": "double" }, "balanceDue": { "type": "number", "format": "double", "nullable": true }, "foreignCurrencyId": { "maxLength": 3, "minLength": 0, "type": "string", "nullable": true }, "rate": { "type": "number", "format": "double", "nullable": true }, "locationId": { "type": "integer", "format": "int32" }, "standardWarehouseId": { "type": "integer", "format": "int32", "nullable": true }, "docContractId": { "type": "integer", "format": "int32", "nullable": true }, "docXmlId": { "type": "integer", "format": "int32", "nullable": true }, "archived": { "type": "boolean" }, "outputControlFormatId": { "type": "integer", "format": "int32" }, "blocked": { "type": "boolean" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "clerk": { "$ref": "#/components/schemas/XERP.Shared.Models.Employee" }, "divergentInvoiceRecipient": { "$ref": "#/components/schemas/XERP.Shared.Models.Partner" }, "docCategory": { "$ref": "#/components/schemas/XERP.Shared.Models.DocCategory" }, "docContract": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc" }, "docType": { "$ref": "#/components/schemas/XERP.Shared.Models.DocType" }, "docXml": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXml" }, "eDocType": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminEDocType" }, "foreignCurrency": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCurrency" }, "inventoryStatus": { "$ref": "#/components/schemas/XERP.Shared.Models.DocTypeInventoryStatus" }, "language": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminLanguage" }, "location": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminLocation" }, "outputControlFormat": { "$ref": "#/components/schemas/XERP.Shared.Models.OutputControlFormat" }, "partner": { "$ref": "#/components/schemas/XERP.Shared.Models.Partner" }, "partnerContactPerson": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerContactPerson" }, "partnerDetail": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDetail" }, "postingPeriod": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPeriod" }, "priceList": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleSalesPriceListName" }, "project": { "$ref": "#/components/schemas/XERP.Shared.Models.Project" }, "revenueEffectiveNavigation": { "$ref": "#/components/schemas/XERP.Shared.Models.DocTypeRevenueEffective" }, "salesPerson": { "$ref": "#/components/schemas/XERP.Shared.Models.Employee" }, "standardWarehouse": { "$ref": "#/components/schemas/XERP.Shared.Models.Warehouse" }, "status": { "$ref": "#/components/schemas/XERP.Shared.Models.DocStatus" }, "termsOfDelivery": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerTermsOfDelivery" }, "termsOfPayment": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerTermsOfPayment" }, "warehousingEffectiveNavigation": { "$ref": "#/components/schemas/XERP.Shared.Models.DocTypeWarehousingEffective" }, "deviceService": { "$ref": "#/components/schemas/XERP.Shared.Models.DeviceService" }, "docBillingAddress": { "$ref": "#/components/schemas/XERP.Shared.Models.DocBillingAddress" }, "docContractNavigation": { "$ref": "#/components/schemas/XERP.Shared.Models.DocContract" }, "docDeliveryAddress": { "$ref": "#/components/schemas/XERP.Shared.Models.DocDeliveryAddress" }, "docFooterText": { "$ref": "#/components/schemas/XERP.Shared.Models.DocFooterText" }, "docHeaderText": { "$ref": "#/components/schemas/XERP.Shared.Models.DocHeaderText" }, "fieldService": { "$ref": "#/components/schemas/XERP.Shared.Models.FieldService" }, "archives": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Archive" }, "nullable": true }, "docApprovals": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocApproval" }, "nullable": true }, "docPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition" }, "nullable": true }, "docXmlDocContracts": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXml" }, "nullable": true }, "docXmlDocs": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXml" }, "nullable": true }, "inverseDocContract": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc" }, "nullable": true }, "packingListBoxDeliveryNoteDocs": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PackingListBox" }, "nullable": true }, "packingListBoxPickingListDocs": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PackingListBox" }, "nullable": true }, "timeTrackings": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.TimeTracking" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.DocApproval": { "required": [ "blocked" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "docId": { "type": "integer", "format": "int32" }, "info": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "blocked": { "type": "boolean" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "doc": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc" }, "status": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "XERP.Shared.Models.DocBillingAddress": { "required": [ "city", "countryId", "matchcode", "name1", "street", "zip" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "docId": { "type": "integer", "format": "int32" }, "partnerBillingAddressId": { "type": "integer", "format": "int32", "nullable": true }, "matchcode": { "maxLength": 100, "minLength": 0, "type": "string" }, "name1": { "maxLength": 100, "minLength": 0, "type": "string" }, "name2": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "name3": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "position": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "title": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "salutation": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "firstName": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "lastName": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "street": { "maxLength": 100, "minLength": 0, "type": "string" }, "extension": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "zip": { "maxLength": 20, "minLength": 0, "type": "string" }, "city": { "maxLength": 50, "minLength": 0, "type": "string" }, "countryId": { "maxLength": 2, "minLength": 0, "type": "string" }, "tel1": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "tel2": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "mobile": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "fax": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "email": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "homepage": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "keyword": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "vatNumber": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "taxNumber": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "eInvoiceRoutingId": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "country": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCountry" }, "doc": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc" }, "partnerBillingAddress": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerBillingAddress" } }, "additionalProperties": false }, "XERP.Shared.Models.DocCategory": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 17, "minLength": 0, "type": "string", "nullable": true }, "name": { "maxLength": 20, "minLength": 0, "type": "string" }, "docTypes": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocType" }, "nullable": true }, "docXmls": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXml" }, "nullable": true }, "docs": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.DocContract": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "docId": { "type": "integer", "format": "int32" }, "contractNumber": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "subject": { "maxLength": 200, "minLength": 0, "type": "string", "nullable": true }, "targetDocTypeId": { "maxLength": 35, "minLength": 0, "type": "string", "nullable": true }, "startDate": { "type": "string", "format": "date-time" }, "cyclePeriodId": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "nextAppointment": { "type": "string", "format": "date-time", "nullable": true }, "leadTimeDays": { "type": "integer", "format": "int32" }, "nextExecutionDate": { "type": "string", "format": "date-time", "nullable": true }, "endDate": { "type": "string", "format": "date-time" }, "statusId": { "maxLength": 10, "minLength": 0, "type": "string", "nullable": true }, "payableInAdvance": { "type": "boolean" }, "cycleQuantity": { "type": "integer", "format": "int32" }, "executedCycles": { "type": "integer", "format": "int32" }, "pendingCycles": { "type": "integer", "format": "int32" }, "possibleTerminationDate": { "type": "string", "format": "date-time", "nullable": true }, "terminatedOnDate": { "type": "string", "format": "date-time", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "cyclePeriod": { "$ref": "#/components/schemas/XERP.Shared.Models.DocContractCyclePeriod" }, "doc": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc" }, "status": { "$ref": "#/components/schemas/XERP.Shared.Models.DocContractStatus" }, "targetDocType": { "$ref": "#/components/schemas/XERP.Shared.Models.DocType" } }, "additionalProperties": false }, "XERP.Shared.Models.DocContractCyclePeriod": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "docContracts": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocContract" }, "nullable": true }, "webshopCartArticles": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopCartArticle" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.DocContractStatus": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 10, "minLength": 0, "type": "string", "nullable": true }, "name": { "maxLength": 20, "minLength": 0, "type": "string" }, "docContracts": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocContract" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.DocContract_Sproc_UpdateField": { "type": "object", "properties": { "docId": { "type": "integer", "format": "int32" }, "fieldName": { "type": "string", "nullable": true }, "fieldValue": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.DocDeliveryAddress": { "required": [ "city", "countryId", "matchcode", "name1", "street", "zip" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "docId": { "type": "integer", "format": "int32" }, "partnerDeliveryAddressId": { "type": "integer", "format": "int32", "nullable": true }, "matchcode": { "maxLength": 100, "minLength": 0, "type": "string" }, "name1": { "maxLength": 100, "minLength": 0, "type": "string" }, "name2": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "name3": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "position": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "title": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "salutation": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "firstName": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "lastName": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "street": { "maxLength": 100, "minLength": 0, "type": "string" }, "extension": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "zip": { "maxLength": 20, "minLength": 0, "type": "string" }, "city": { "maxLength": 50, "minLength": 0, "type": "string" }, "countryId": { "maxLength": 2, "minLength": 0, "type": "string" }, "tel1": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "tel2": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "mobile": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "fax": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "email": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "homepage": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "keyword": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "vatNumber": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "taxNumber": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "shippingZoneId": { "type": "integer", "format": "int32", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "country": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCountry" }, "doc": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc" }, "partnerDeliveryAddress": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDeliveryAddress" }, "shippingZone": { "$ref": "#/components/schemas/XERP.Shared.Models.ShippingZone" } }, "additionalProperties": false }, "XERP.Shared.Models.DocFooterText": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "docId": { "type": "integer", "format": "int32" }, "footer": { "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "doc": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc" } }, "additionalProperties": false }, "XERP.Shared.Models.DocHeaderText": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "docId": { "type": "integer", "format": "int32" }, "header": { "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "doc": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc" } }, "additionalProperties": false }, "XERP.Shared.Models.DocIntrastatRequest": { "type": "object", "properties": { "docId": { "type": "integer", "format": "int32" }, "partnerDispatchCountryId": { "type": "string", "nullable": true }, "transportModeId": { "type": "string", "nullable": true }, "reportingEntityId": { "type": "integer", "format": "int32", "nullable": true }, "fieldName": { "type": "string", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "hasSnapshot": { "type": "boolean" }, "isReadOnly": { "type": "boolean" } }, "additionalProperties": false }, "XERP.Shared.Models.DocPosition": { "required": [ "positionTypeId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "docId": { "type": "integer", "format": "int32" }, "rowNumber": { "type": "integer", "format": "int32" }, "positionTypeId": { "maxLength": 15, "minLength": 0, "type": "string" }, "positionNumber": { "type": "integer", "format": "int32" }, "parentPositionId": { "type": "integer", "format": "int32", "nullable": true }, "childPositionNumber": { "type": "integer", "format": "int32", "nullable": true }, "statusId": { "maxLength": 12, "minLength": 0, "type": "string", "nullable": true }, "articleId": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "name1": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "name2": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "quantity": { "type": "number", "format": "double" }, "quantityOpen": { "type": "number", "format": "double" }, "uoMId": { "type": "integer", "format": "int32", "nullable": true }, "shippingDate": { "type": "string", "format": "date-time" }, "deliveryDate": { "type": "string", "format": "date-time" }, "price": { "type": "number", "format": "double" }, "priceUnitId": { "type": "integer", "format": "int32" }, "predecessorId": { "type": "integer", "format": "int32", "nullable": true }, "quantityTransferred": { "type": "number", "format": "double", "nullable": true }, "level": { "type": "integer", "format": "int32", "nullable": true }, "positionLabel": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "catalogNumberId": { "type": "integer", "format": "int32", "nullable": true }, "dissolve": { "type": "boolean" }, "positionWeight": { "type": "number", "format": "double", "nullable": true }, "relatedPositionId": { "type": "integer", "format": "int32", "nullable": true }, "projectId": { "type": "integer", "format": "int32", "nullable": true }, "start": { "type": "string", "format": "date-time", "nullable": true }, "stop": { "type": "string", "format": "date-time", "nullable": true }, "articleCostPrice": { "type": "number", "format": "double" }, "costPriceFactor": { "type": "integer", "format": "int32" }, "costPriceTotal": { "type": "number", "format": "double" }, "discountPercent": { "type": "number", "format": "double" }, "quantityDiscountPercent": { "type": "number", "format": "double" }, "docDiscountPercent": { "type": "number", "format": "double" }, "discountedPrice": { "type": "number", "format": "double" }, "prepaymentFactor": { "type": "integer", "format": "int32" }, "totalPrice": { "type": "number", "format": "double" }, "revenueEffective": { "type": "integer", "format": "int32", "nullable": true }, "revenue": { "type": "number", "format": "double" }, "salesPersonId": { "type": "integer", "format": "int32", "nullable": true }, "commissionPercent": { "type": "number", "format": "double" }, "commissionAmount": { "type": "number", "format": "double" }, "profitFactor": { "type": "integer", "format": "int32" }, "profitAmount": { "type": "number", "format": "double" }, "profitPercent": { "type": "number", "format": "double" }, "financeGroupArticleId": { "type": "integer", "format": "int32", "nullable": true }, "financeGroupPartnerDetailId": { "type": "integer", "format": "int32", "nullable": true }, "taxKeyId": { "maxLength": 3, "minLength": 0, "type": "string", "nullable": true }, "taxFactor": { "type": "integer", "format": "int32" }, "taxPercent": { "type": "number", "format": "double" }, "tax": { "type": "number", "format": "double" }, "accountId": { "type": "integer", "format": "int32", "nullable": true }, "costCenterId": { "type": "integer", "format": "int32", "nullable": true }, "costBearerId": { "type": "integer", "format": "int32", "nullable": true }, "foreignCurrencyPrice": { "type": "number", "format": "double", "nullable": true }, "warehousing": { "type": "boolean" }, "warehousingEffective": { "type": "integer", "format": "int32", "nullable": true }, "warehousingQuantity": { "type": "number", "format": "double" }, "pending": { "type": "boolean" }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "account": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountPlan" }, "article": { "$ref": "#/components/schemas/XERP.Shared.Models.Article" }, "catalogNumber": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerCatalogNumber" }, "costBearer": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceCostBearer" }, "costCenter": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceCostCenter" }, "doc": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc" }, "financeGroupArticle": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceGroupArticle" }, "financeGroupPartnerDetail": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceGroupPartner" }, "parentPosition": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition" }, "positionType": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionType" }, "predecessor": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition" }, "priceUnit": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticlePriceUnit" }, "project": { "$ref": "#/components/schemas/XERP.Shared.Models.Project" }, "relatedPosition": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition" }, "revenueEffectiveNavigation": { "$ref": "#/components/schemas/XERP.Shared.Models.DocTypeRevenueEffective" }, "salesPerson": { "$ref": "#/components/schemas/XERP.Shared.Models.Employee" }, "status": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionStatus" }, "taxKey": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTaxKey" }, "uoM": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleUoM" }, "warehousingEffectiveNavigation": { "$ref": "#/components/schemas/XERP.Shared.Models.DocTypeWarehousingEffective" }, "countryPackageIntrastatDocPosition": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDocPosition" }, "countryPackageOssProcedureDocPosition": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageOssProcedureDocPosition" }, "docPositionDimensionText": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionDimensionText" }, "docPositionInfoText": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionInfoText" }, "docPositionOrderText": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionOrderText" }, "docPositionPicture": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionPicture" }, "marketplaceSellerPositionSalesPosition": { "$ref": "#/components/schemas/XERP.Shared.Models.MarketplaceSellerPosition" }, "countryPackageIntrastatDeclarationPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDeclarationPosition" }, "nullable": true }, "docPositionWarehousings": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionWarehousing" }, "nullable": true }, "docXmlPositionPredecessors": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXmlPosition" }, "nullable": true }, "docXmlPositionRelatedPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXmlPosition" }, "nullable": true }, "fieldServiceResources": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FieldServiceResource" }, "nullable": true }, "inverseParentPosition": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition" }, "nullable": true }, "inversePredecessor": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition" }, "nullable": true }, "inverseRelatedPosition": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition" }, "nullable": true }, "marketplaceSellerPositionPurchasePositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.MarketplaceSellerPosition" }, "nullable": true }, "packingListBoxPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PackingListBoxPosition" }, "nullable": true }, "procurementOrderConfirmationPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Procurement" }, "nullable": true }, "procurementPurchaseOrderPos": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Procurement" }, "nullable": true }, "productions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Production" }, "nullable": true }, "timeTrackings": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.TimeTracking" }, "nullable": true }, "articleQuantityStock": { "type": "number", "format": "double", "nullable": true }, "articleQuantityConfirmed": { "type": "number", "format": "double", "nullable": true }, "articleQuantityPacked": { "type": "number", "format": "double", "nullable": true }, "articleQuantityOrdered": { "type": "number", "format": "double", "nullable": true }, "articleQuantityAnnounced": { "type": "number", "format": "double", "nullable": true }, "articleQuantityMinimumStock": { "type": "number", "format": "double", "nullable": true }, "articleQuantityAvailable": { "type": "number", "format": "double", "nullable": true }, "decimalPlacesQuantitiesId": { "type": "integer", "format": "int32" }, "isValid": { "type": "boolean" } }, "additionalProperties": false }, "XERP.Shared.Models.DocPositionDimensionText": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "docPositionId": { "type": "integer", "format": "int32" }, "dimensionText": { "type": "string", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "docPosition": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition" } }, "additionalProperties": false }, "XERP.Shared.Models.DocPositionInfoText": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "docPositionId": { "type": "integer", "format": "int32" }, "infoText": { "type": "string", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "docPosition": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition" } }, "additionalProperties": false }, "XERP.Shared.Models.DocPositionIntrastatRequest": { "type": "object", "properties": { "docPositionId": { "type": "integer", "format": "int32" }, "reportingEntityId": { "type": "integer", "format": "int32", "nullable": true }, "fieldName": { "type": "string", "nullable": true }, "countryOfOriginId": { "type": "string", "nullable": true }, "transactionTypeId": { "type": "string", "nullable": true }, "transportModeId": { "type": "string", "nullable": true }, "partnerDispatchCountryId": { "type": "string", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "hasSnapshot": { "type": "boolean" }, "isReadOnly": { "type": "boolean" } }, "additionalProperties": false }, "XERP.Shared.Models.DocPositionOrderText": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "docPositionId": { "type": "integer", "format": "int32" }, "orderText": { "type": "string", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "docPosition": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition" } }, "additionalProperties": false }, "XERP.Shared.Models.DocPositionPicture": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "docPositionId": { "type": "integer", "format": "int32" }, "picture": { "type": "string", "format": "byte", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "docPosition": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition" } }, "additionalProperties": false }, "XERP.Shared.Models.DocPositionStatus": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 12, "minLength": 0, "type": "string", "nullable": true }, "name": { "maxLength": 20, "minLength": 0, "type": "string" }, "docPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition" }, "nullable": true }, "docXmlPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXmlPosition" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.DocPositionType": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 15, "minLength": 0, "type": "string", "nullable": true }, "name": { "maxLength": 15, "minLength": 0, "type": "string" }, "switchable": { "type": "boolean" }, "articleAccessories": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleAccessory" }, "nullable": true }, "articleMacros": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleMacro" }, "nullable": true }, "docPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition" }, "nullable": true }, "docXmlPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXmlPosition" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.DocPositionWarehousing": { "required": [ "individualizationTypeId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "docPositionId": { "type": "integer", "format": "int32" }, "warehouseId": { "type": "integer", "format": "int32", "nullable": true }, "binLocationId": { "type": "integer", "format": "int32", "nullable": true }, "individualizationTypeId": { "maxLength": 6, "minLength": 0, "type": "string" }, "individualizationNumberId": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "quantity": { "type": "number", "format": "double" }, "warehousingEffective": { "type": "integer", "format": "int32" }, "warehousingQuantity": { "type": "number", "format": "double", "nullable": true }, "warehouseMediumId": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "binLocation": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseBinLocation" }, "docPosition": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition" }, "individualizationNumber": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleIndividualization" }, "individualizationType": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleIndividualizationType" }, "warehouse": { "$ref": "#/components/schemas/XERP.Shared.Models.Warehouse" }, "warehouseMedium": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseMedium" }, "warehousingEffectiveNavigation": { "$ref": "#/components/schemas/XERP.Shared.Models.DocTypeWarehousingEffective" } }, "additionalProperties": false }, "XERP.Shared.Models.DocPositionWarehousing_DeleteRequest": { "type": "object", "properties": { "warehousingId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.DocPositionWarehousing_DocIdRequest": { "type": "object", "properties": { "docId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.DocPositionWarehousing_GetAllFromViewByValueRequest": { "type": "object", "properties": { "propertyName": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.DocPositionWarehousing_InsertRequest": { "type": "object", "properties": { "docPositionId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.DocPositionWarehousing_UpdateBinLocationIdRequest": { "type": "object", "properties": { "warehousingId": { "type": "integer", "format": "int32" }, "binLocationId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.DocPositionWarehousing_UpdateIndividualizationNumberIdRequest": { "type": "object", "properties": { "warehousingId": { "type": "integer", "format": "int32" }, "individualizationNumberId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.DocPositionWarehousing_UpdateQuantityRequest": { "type": "object", "properties": { "warehousingId": { "type": "integer", "format": "int32" }, "quantity": { "type": "number", "format": "double" } }, "additionalProperties": false }, "XERP.Shared.Models.DocPositionWarehousing_UpdateWarehouseIdRequest": { "type": "object", "properties": { "warehousingId": { "type": "integer", "format": "int32" }, "warehouseId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.DocPositionWarehousing_UpdateWarehouseMediumIdRequest": { "type": "object", "properties": { "warehousingId": { "type": "integer", "format": "int32" }, "warehouseMediumId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.DocPosition_CloseManuallyRequest": { "type": "object", "properties": { "docPositionId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.DocPosition_GetWithQuantitiesRequest": { "type": "object", "properties": { "docId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.DocPosition_SprocDeleteRequest": { "type": "object", "properties": { "docPositionId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.DocPosition_SprocFinanceGroupArticleIdRequest": { "type": "object", "properties": { "docPositionId": { "type": "integer", "format": "int32" }, "financeGroupArticleId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.DocPosition_SprocForeignCurrencyPriceRequest": { "type": "object", "properties": { "docPositionId": { "type": "integer", "format": "int32" }, "foreignCurrencyPrice": { "type": "number", "format": "double" } }, "additionalProperties": false }, "XERP.Shared.Models.DocPosition_SprocInsertArticleRequest": { "type": "object", "properties": { "docId": { "type": "integer", "format": "int32" }, "articleId": { "type": "string", "nullable": true }, "componentIds": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.DocPosition_SprocInsertTextRequest": { "type": "object", "properties": { "docId": { "type": "integer", "format": "int32" }, "textId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.DocPosition_SprocPositionTypeIdRequest": { "type": "object", "properties": { "docPositionId": { "type": "integer", "format": "int32" }, "positionTypeId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.DocPosition_SprocSalesPersonIdRequest": { "type": "object", "properties": { "docPositionId": { "type": "integer", "format": "int32" }, "salesPersonId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.DocPosition_SprocStatusIdRequest": { "type": "object", "properties": { "docPositionId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.DocPosition_SprocTaxKeyIdRequest": { "type": "object", "properties": { "docPositionId": { "type": "integer", "format": "int32" }, "taxKeyId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.DocPosition_SprocUpdatePurchasePriceListRequest": { "type": "object", "properties": { "docPositionId": { "type": "integer", "format": "int32" }, "price": { "type": "number", "format": "double" }, "discountPercent": { "type": "number", "format": "double" } }, "additionalProperties": false }, "XERP.Shared.Models.DocPosition_SprocUpdateRequest": { "type": "object", "properties": { "docPositionId": { "type": "integer", "format": "int32" }, "quantity": { "type": "number", "format": "double" }, "price": { "type": "number", "format": "double" }, "discountPercent": { "type": "number", "format": "double" } }, "additionalProperties": false }, "XERP.Shared.Models.DocPosition_SprocUpdateTransferRequest": { "type": "object", "properties": { "docPositionId": { "type": "integer", "format": "int32" }, "quantity": { "type": "number", "format": "double" } }, "additionalProperties": false }, "XERP.Shared.Models.DocPosition_Sproc_UpdateField": { "type": "object", "properties": { "docPositionId": { "type": "integer", "format": "int32" }, "fieldName": { "type": "string", "nullable": true }, "fieldValue": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.DocPosition_UpdateSalesPriceListRequest": { "type": "object", "properties": { "docId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.DocPostingErrorMessage": { "type": "object", "properties": { "positionNumber": { "type": "integer", "format": "int32", "nullable": true }, "text": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.DocStatus": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 12, "minLength": 0, "type": "string", "nullable": true }, "name": { "maxLength": 20, "minLength": 0, "type": "string" }, "docXmls": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXml" }, "nullable": true }, "docs": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.DocType": { "required": [ "docCategoryId", "docNumberPrefix", "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 35, "minLength": 0, "type": "string", "nullable": true }, "name": { "maxLength": 50, "minLength": 0, "type": "string" }, "array": { "type": "integer", "format": "int32" }, "docCategoryId": { "maxLength": 17, "minLength": 0, "type": "string" }, "docNumberPrefix": { "maxLength": 3, "minLength": 0, "type": "string" }, "inventoryStatusId": { "maxLength": 10, "minLength": 0, "type": "string", "nullable": true }, "warehousingEffective": { "type": "integer", "format": "int32" }, "prepaymentFalseArticleFactor": { "type": "integer", "format": "int32" }, "prepaymentTrueArticleFactor": { "type": "integer", "format": "int32" }, "revenueEffective": { "type": "integer", "format": "int32" }, "lastNumber": { "type": "integer", "format": "int32" }, "nextNumber": { "type": "integer", "format": "int32" }, "projectMandatory": { "type": "boolean" }, "quantityDiscountRecalculation": { "type": "boolean" }, "isOrderConfirmation": { "type": "boolean" }, "isDelivery": { "type": "boolean" }, "draft": { "type": "boolean" }, "defaultOutputControlFormatId": { "type": "integer", "format": "int32" }, "defaultReportTemplateId": { "type": "integer", "format": "int32" }, "defaultEmailTemplateId": { "type": "integer", "format": "int32" }, "active": { "type": "boolean" }, "isContract": { "type": "boolean" }, "isFieldService": { "type": "boolean" }, "defaultSuccessorId": { "maxLength": 35, "minLength": 0, "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "defaultEmailTemplate": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailTemplate" }, "defaultOutputControlFormat": { "$ref": "#/components/schemas/XERP.Shared.Models.OutputControlFormat" }, "defaultReportTemplate": { "$ref": "#/components/schemas/XERP.Shared.Models.ReportTemplate" }, "defaultSuccessor": { "$ref": "#/components/schemas/XERP.Shared.Models.DocType" }, "docCategory": { "$ref": "#/components/schemas/XERP.Shared.Models.DocCategory" }, "inventoryStatus": { "$ref": "#/components/schemas/XERP.Shared.Models.DocTypeInventoryStatus" }, "prepaymentFalseArticleFactorNavigation": { "$ref": "#/components/schemas/XERP.Shared.Models.DocTypePrepaymentFactor" }, "prepaymentTrueArticleFactorNavigation": { "$ref": "#/components/schemas/XERP.Shared.Models.DocTypePrepaymentFactor" }, "revenueEffectiveNavigation": { "$ref": "#/components/schemas/XERP.Shared.Models.DocTypeRevenueEffective" }, "warehousingEffectiveNavigation": { "$ref": "#/components/schemas/XERP.Shared.Models.DocTypeWarehousingEffective" }, "countryPackageIntrastatDeclarations": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDeclaration" }, "nullable": true }, "docContracts": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocContract" }, "nullable": true }, "docXmlAssignments": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXmlAssignment" }, "nullable": true }, "docXmls": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXml" }, "nullable": true }, "docs": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc" }, "nullable": true }, "emailTemplates": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailTemplate" }, "nullable": true }, "financeOpenItems": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItem" }, "nullable": true }, "inverseDefaultSuccessor": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocType" }, "nullable": true }, "partnerContactPersonEmailCategoryDocTypes": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerContactPersonEmailCategoryDocType" }, "nullable": true }, "partnerDetailOutputs": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDetailOutput" }, "nullable": true }, "reportTemplates": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ReportTemplate" }, "nullable": true }, "timeTrackingSettings": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.TimeTrackingSetting" }, "nullable": true }, "translationDocTypes": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.TranslationDocType" }, "nullable": true }, "webshopCartArticles": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopCartArticle" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.DocTypeInventoryStatus": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 10, "minLength": 0, "type": "string", "nullable": true }, "name": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "docType": { "$ref": "#/components/schemas/XERP.Shared.Models.DocType" }, "docXmls": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXml" }, "nullable": true }, "docs": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.DocTypePrepaymentFactor": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "docTypePrepaymentFalseArticleFactorNavigations": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocType" }, "nullable": true }, "docTypePrepaymentTrueArticleFactorNavigations": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocType" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.DocTypeRevenueEffective": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 15, "minLength": 0, "type": "string" }, "articleProductionStepComponentTypes": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProductionStepComponentType" }, "nullable": true }, "docPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition" }, "nullable": true }, "docTypes": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocType" }, "nullable": true }, "docXmls": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXml" }, "nullable": true }, "docs": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.DocTypeWarehousingEffective": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 10, "minLength": 0, "type": "string" }, "articleProductionStepComponentTypes": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProductionStepComponentType" }, "nullable": true }, "docPositionWarehousings": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionWarehousing" }, "nullable": true }, "docPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition" }, "nullable": true }, "docTypes": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocType" }, "nullable": true }, "docXmls": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXml" }, "nullable": true }, "docs": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc" }, "nullable": true }, "productionPositionWarehousings": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionWarehousing" }, "nullable": true }, "productionPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPosition" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.DocType_GetAdminDocTypesWithDocCreatedRequest": { "type": "object", "properties": { "docCategoryId": { "type": "string", "nullable": true }, "docTypeId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.DocXml": { "required": [ "computerFile", "docCategoryId", "statusId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "fileGuid": { "type": "string", "format": "uuid" }, "computerFile": { "type": "string", "format": "byte" }, "routingInfo": { "maxLength": 200, "minLength": 0, "type": "string", "nullable": true }, "fileInfo": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "syntaxInfo": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "codeInfo": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "sellerNameInfo": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "sellerStreetInfo": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "sellerZipInfo": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "sellerCityInfo": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "sellerCountryInfo": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "sellerTaxInfo": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "sellerVatIdInfo": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "sellerContactPersonInfo": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "sellerEmailInfo": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "sellerPhoneInfo": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "buyerNameInfo": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "buyerStreetInfo": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "buyerZipInfo": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "buyerCityInfo": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "buyerCountryInfo": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "buyerTaxInfo": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "buyerVatIdInfo": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "buyerContactPersonInfo": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "buyerEmailInfo": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "buyerPhoneInfo": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "block": { "type": "boolean" }, "remark": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "peppolParticipantId": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "peppolProcessId": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "peppolDocTypeId": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "senderAccessPointUrl": { "maxLength": 200, "minLength": 0, "type": "string", "nullable": true }, "receiverAccessPointUrl": { "maxLength": 200, "minLength": 0, "type": "string", "nullable": true }, "peppolTransmissionStatus": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "peppolTransmissionDate": { "type": "string", "format": "date-time", "nullable": true }, "peppolResponseCode": { "maxLength": 10, "minLength": 0, "type": "string", "nullable": true }, "peppolResponseMessage": { "maxLength": 500, "minLength": 0, "type": "string", "nullable": true }, "docId": { "type": "integer", "format": "int32", "nullable": true }, "content": { "type": "string", "nullable": true }, "docCategoryId": { "maxLength": 17, "minLength": 0, "type": "string" }, "docTypeId": { "maxLength": 35, "minLength": 0, "type": "string", "nullable": true }, "docNumber": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "inventoryStatusId": { "maxLength": 10, "minLength": 0, "type": "string", "nullable": true }, "warehousingEffective": { "type": "integer", "format": "int32" }, "revenueEffective": { "type": "integer", "format": "int32" }, "partnerId": { "type": "integer", "format": "int32", "nullable": true }, "partnerDetailId": { "type": "integer", "format": "int32", "nullable": true }, "statusId": { "maxLength": 12, "minLength": 0, "type": "string" }, "transferable": { "type": "boolean" }, "draft": { "type": "boolean" }, "docDate": { "type": "string", "format": "date-time", "nullable": true }, "postingDate": { "type": "string", "format": "date-time", "nullable": true }, "postingPeriodId": { "type": "integer", "format": "int32", "nullable": true }, "shippingDate": { "type": "string", "format": "date-time" }, "deliveryDate": { "type": "string", "format": "date-time" }, "partnerContactPersonId": { "type": "integer", "format": "int32", "nullable": true }, "clerkId": { "type": "integer", "format": "int32", "nullable": true }, "salesPersonId": { "type": "integer", "format": "int32", "nullable": true }, "ourReference": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "yourDoc": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "yourDocDate": { "type": "string", "format": "date-time", "nullable": true }, "internalRemark": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "subject": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "version": { "type": "integer", "format": "int32", "nullable": true }, "vatNumber": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "divergentInvoiceRecipientId": { "type": "integer", "format": "int32", "nullable": true }, "termsOfDeliveryId": { "type": "integer", "format": "int32", "nullable": true }, "euWork": { "type": "boolean" }, "languageId": { "maxLength": 5, "minLength": 0, "type": "string", "nullable": true }, "approvalRequired": { "type": "boolean" }, "eDocTypeId": { "type": "integer", "format": "int32" }, "termsOfPaymentInfo": { "maxLength": 200, "minLength": 0, "type": "string", "nullable": true }, "termsOfPaymentId": { "type": "integer", "format": "int32", "nullable": true }, "projectId": { "type": "integer", "format": "int32", "nullable": true }, "priceListId": { "type": "integer", "format": "int32", "nullable": true }, "docDiscountPercent": { "type": "number", "format": "double", "nullable": true }, "costPriceSum": { "type": "number", "format": "double", "nullable": true }, "profitSum": { "type": "number", "format": "double", "nullable": true }, "profitPercent": { "type": "number", "format": "double", "nullable": true }, "commissionSum": { "type": "number", "format": "double", "nullable": true }, "profitAfterCommissionSum": { "type": "number", "format": "double", "nullable": true }, "profitAfterCommissionPercent": { "type": "number", "format": "double", "nullable": true }, "totalPriceSum": { "type": "number", "format": "double", "nullable": true }, "taxSum": { "type": "number", "format": "double", "nullable": true }, "totalPriceSumGross": { "type": "number", "format": "double", "nullable": true }, "calculatedTotalPriceSumGross": { "type": "number", "format": "double", "nullable": true }, "totalPriceSumGrossDifference": { "type": "number", "format": "double", "nullable": true }, "downPaymentSum": { "type": "number", "format": "double", "nullable": true }, "downPaymentPercent": { "type": "number", "format": "double", "nullable": true }, "balanceDue": { "type": "number", "format": "double", "nullable": true }, "foreignCurrencyId": { "maxLength": 3, "minLength": 0, "type": "string", "nullable": true }, "rate": { "type": "number", "format": "double", "nullable": true }, "locationId": { "type": "integer", "format": "int32" }, "standardWarehouseId": { "type": "integer", "format": "int32", "nullable": true }, "docContractId": { "type": "integer", "format": "int32", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "clerk": { "$ref": "#/components/schemas/XERP.Shared.Models.Employee" }, "divergentInvoiceRecipient": { "$ref": "#/components/schemas/XERP.Shared.Models.Partner" }, "doc": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc" }, "docCategory": { "$ref": "#/components/schemas/XERP.Shared.Models.DocCategory" }, "docContract": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc" }, "docType": { "$ref": "#/components/schemas/XERP.Shared.Models.DocType" }, "eDocType": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminEDocType" }, "foreignCurrency": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCurrency" }, "inventoryStatus": { "$ref": "#/components/schemas/XERP.Shared.Models.DocTypeInventoryStatus" }, "language": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminLanguage" }, "location": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminLocation" }, "partner": { "$ref": "#/components/schemas/XERP.Shared.Models.Partner" }, "partnerContactPerson": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerContactPerson" }, "partnerDetail": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDetail" }, "postingPeriod": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPeriod" }, "priceList": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleSalesPriceListName" }, "project": { "$ref": "#/components/schemas/XERP.Shared.Models.Project" }, "revenueEffectiveNavigation": { "$ref": "#/components/schemas/XERP.Shared.Models.DocTypeRevenueEffective" }, "salesPerson": { "$ref": "#/components/schemas/XERP.Shared.Models.Employee" }, "standardWarehouse": { "$ref": "#/components/schemas/XERP.Shared.Models.Warehouse" }, "status": { "$ref": "#/components/schemas/XERP.Shared.Models.DocStatus" }, "termsOfDelivery": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerTermsOfDelivery" }, "termsOfPayment": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerTermsOfPayment" }, "warehousingEffectiveNavigation": { "$ref": "#/components/schemas/XERP.Shared.Models.DocTypeWarehousingEffective" }, "docXmlPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXmlPosition" }, "nullable": true }, "docs": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.DocXmlAssignment": { "required": [ "description", "docTypeId", "docXmlType" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "docXmlType": { "maxLength": 30, "minLength": 0, "type": "string" }, "docTypeId": { "maxLength": 35, "minLength": 0, "type": "string" }, "description": { "maxLength": 600, "minLength": 0, "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "docType": { "$ref": "#/components/schemas/XERP.Shared.Models.DocType" } }, "additionalProperties": false }, "XERP.Shared.Models.DocXmlPosition": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "docXmlId": { "type": "integer", "format": "int32" }, "rowNumber": { "type": "integer", "format": "int32" }, "positionTypeId": { "maxLength": 15, "minLength": 0, "type": "string", "nullable": true }, "positionNumber": { "type": "integer", "format": "int32", "nullable": true }, "parentPositionId": { "type": "integer", "format": "int32", "nullable": true }, "childPositionNumber": { "type": "integer", "format": "int32", "nullable": true }, "statusId": { "maxLength": 12, "minLength": 0, "type": "string", "nullable": true }, "articleId": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "name1": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "name2": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "quantity": { "type": "number", "format": "double" }, "quantityOpen": { "type": "number", "format": "double" }, "uoMId": { "type": "integer", "format": "int32", "nullable": true }, "shippingDate": { "type": "string", "format": "date-time" }, "deliveryDate": { "type": "string", "format": "date-time" }, "price": { "type": "number", "format": "double" }, "totalPrice": { "type": "number", "format": "double" }, "predecessorId": { "type": "integer", "format": "int32", "nullable": true }, "quantityTransferred": { "type": "number", "format": "double", "nullable": true }, "level": { "type": "integer", "format": "int32", "nullable": true }, "positionLabel": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "catalogNumberId": { "type": "integer", "format": "int32", "nullable": true }, "dissolve": { "type": "boolean" }, "positionWeight": { "type": "number", "format": "double", "nullable": true }, "relatedPositionId": { "type": "integer", "format": "int32", "nullable": true }, "projectId": { "type": "integer", "format": "int32", "nullable": true }, "start": { "type": "string", "format": "date-time", "nullable": true }, "stop": { "type": "string", "format": "date-time", "nullable": true }, "priceUnitId": { "type": "integer", "format": "int32" }, "costPriceTotal": { "type": "number", "format": "double" }, "discountPercent": { "type": "number", "format": "double" }, "quantityDiscountPercent": { "type": "number", "format": "double" }, "docDiscountPercent": { "type": "number", "format": "double" }, "discountedPrice": { "type": "number", "format": "double" }, "revenueEffective": { "type": "integer", "format": "int32", "nullable": true }, "revenue": { "type": "number", "format": "double" }, "salesPersonId": { "type": "integer", "format": "int32", "nullable": true }, "commissionPercent": { "type": "number", "format": "double" }, "commissionAmount": { "type": "number", "format": "double" }, "profitAmount": { "type": "number", "format": "double" }, "profitPercent": { "type": "number", "format": "double", "nullable": true }, "financeGroupArticleId": { "type": "integer", "format": "int32", "nullable": true }, "financeGroupPartnerDetailId": { "type": "integer", "format": "int32", "nullable": true }, "taxKeyId": { "maxLength": 3, "minLength": 0, "type": "string", "nullable": true }, "taxPercent": { "type": "number", "format": "double" }, "tax": { "type": "number", "format": "double" }, "accountId": { "type": "integer", "format": "int32", "nullable": true }, "costCenterId": { "type": "integer", "format": "int32", "nullable": true }, "costBearerId": { "type": "integer", "format": "int32", "nullable": true }, "warehousing": { "type": "boolean" }, "warehousingEffective": { "type": "integer", "format": "int32", "nullable": true }, "warehousingQuantity": { "type": "number", "format": "double", "nullable": true }, "pending": { "type": "boolean" }, "xmlArticle": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "xmlUoM": { "maxLength": 10, "minLength": 0, "type": "string", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "account": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountPlan" }, "article": { "$ref": "#/components/schemas/XERP.Shared.Models.Article" }, "catalogNumber": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerCatalogNumber" }, "costBearer": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceCostBearer" }, "costCenter": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceCostCenter" }, "docXml": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXml" }, "financeGroupArticle": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceGroupArticle" }, "financeGroupPartnerDetail": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceGroupPartner" }, "parentPosition": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXmlPosition" }, "positionType": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionType" }, "predecessor": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition" }, "priceUnit": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticlePriceUnit" }, "project": { "$ref": "#/components/schemas/XERP.Shared.Models.Project" }, "relatedPosition": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition" }, "salesPerson": { "$ref": "#/components/schemas/XERP.Shared.Models.Employee" }, "status": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionStatus" }, "taxKey": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTaxKey" }, "uoM": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleUoM" }, "inverseParentPosition": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXmlPosition" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.DocXmlPositionSaveDto": { "type": "object", "properties": { "docXmlPositionId": { "type": "integer", "format": "int32" }, "articleId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.DocXmlPosition_GetWithQuantitiesRequest": { "type": "object", "properties": { "docId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.DocXmlPosition_SprocFinanceGroupArticleIdRequest": { "type": "object", "properties": { "docXmlPositionId": { "type": "integer", "format": "int32" }, "financeGroupArticleId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.DocXmlPosition_SprocInsertTextRequest": { "type": "object", "properties": { "docId": { "type": "integer", "format": "int32" }, "textId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.DocXmlPosition_SprocPositionTypeIdRequest": { "type": "object", "properties": { "docXmlPositionId": { "type": "integer", "format": "int32" }, "positionTypeId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.DocXmlPosition_SprocSalesPersonIdRequest": { "type": "object", "properties": { "docXmlPositionId": { "type": "integer", "format": "int32" }, "salesPersonId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.DocXmlPosition_SprocStatusIdRequest": { "type": "object", "properties": { "docXmlPositionId": { "type": "integer", "format": "int32" }, "statusId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.DocXmlPosition_SprocTaxKeyIdRequest": { "type": "object", "properties": { "docXmlPositionId": { "type": "integer", "format": "int32" }, "taxKeyId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.DocXmlPosition_SprocUpdateTransferRequest": { "type": "object", "properties": { "docXmlPositionId": { "type": "integer", "format": "int32" }, "quantity": { "type": "number", "format": "double" } }, "additionalProperties": false }, "XERP.Shared.Models.DocXmlPredecessorCandidate": { "type": "object", "properties": { "docXmlPositionId": { "type": "integer", "format": "int32" }, "docPositionId": { "type": "integer", "format": "int32" }, "docId": { "type": "integer", "format": "int32" }, "docNumber": { "type": "string", "nullable": true }, "docDate": { "type": "string", "format": "date-time" }, "docTypeId": { "type": "string", "nullable": true }, "docTypeName": { "type": "string", "nullable": true }, "positionNumber": { "type": "integer", "format": "int32" }, "articleId": { "type": "string", "nullable": true }, "matchcode": { "type": "string", "nullable": true }, "name1": { "type": "string", "nullable": true }, "name2": { "type": "string", "nullable": true }, "quantity": { "type": "number", "format": "double" }, "quantityOpen": { "type": "number", "format": "double" } }, "additionalProperties": false }, "XERP.Shared.Models.DocXmlPredecessorData": { "type": "object", "properties": { "positions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXmlPredecessorPosition" }, "nullable": true }, "candidates": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXmlPredecessorCandidate" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.DocXmlPredecessorPosition": { "type": "object", "properties": { "docXmlPositionId": { "type": "integer", "format": "int32" }, "rowNumber": { "type": "integer", "format": "int32" }, "positionNumber": { "type": "integer", "format": "int32", "nullable": true }, "articleId": { "type": "string", "nullable": true }, "matchcode": { "type": "string", "nullable": true }, "name1": { "type": "string", "nullable": true }, "name2": { "type": "string", "nullable": true }, "quantity": { "type": "number", "format": "double" }, "price": { "type": "number", "format": "double" }, "predecessorId": { "type": "integer", "format": "int32", "nullable": true }, "quantityTransferred": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.DocXml_ApplyPredecessorLinksRequest": { "type": "object", "properties": { "docXmlId": { "type": "integer", "format": "int32" }, "loggedInEmployee": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.DocXml_CreateNewDocRequest": { "type": "object", "properties": { "docXmlId": { "type": "integer", "format": "int32" }, "loggedInEmployee": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.DocXml_ImportRequest": { "type": "object", "properties": { "docXmlId": { "type": "integer", "format": "int32" }, "loggedInEmployee": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.DocXml_MatchPartnerRequest": { "type": "object", "properties": { "docXmlId": { "type": "integer", "format": "int32" }, "partnerId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.DocXml_SavePredecessorLinkRequest": { "type": "object", "properties": { "docXmlPositionId": { "type": "integer", "format": "int32" }, "predecessorDocPositionId": { "type": "integer", "format": "int32", "nullable": true }, "quantityTransferred": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.Doc_CopyDocPositionsRequest": { "type": "object", "properties": { "sourceDocId": { "type": "integer", "format": "int32" }, "targetDocId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.Doc_CreateNewDocRequest": { "type": "object", "properties": { "docCategoryId": { "type": "string", "nullable": true }, "docTypeId": { "type": "string", "nullable": true }, "partnerDetailId": { "type": "integer", "format": "int32" }, "employeeId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.Doc_CreateTargetDocRequest": { "type": "object", "properties": { "docCategoryId": { "type": "string", "nullable": true }, "docTypeId": { "type": "string", "nullable": true }, "partnerId": { "type": "integer", "format": "int32" }, "sourceDocId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.Doc_DivergentInvoiceRecipientIdRequest": { "type": "object", "properties": { "docId": { "type": "integer", "format": "int32" }, "employeeId": { "type": "integer", "format": "int32" }, "divergentInvoiceRecipientId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.Doc_DocIdRequest": { "type": "object", "properties": { "docId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.Doc_PostDocRequest": { "type": "object", "properties": { "docId": { "type": "integer", "format": "int32" }, "createdBy": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.Doc_SetFirstDocNumberRequest": { "type": "object", "properties": { "docTypeId": { "type": "string", "nullable": true }, "firstDocNumber": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.Doc_Sproc_UpdateField": { "type": "object", "properties": { "docId": { "type": "integer", "format": "int32" }, "fieldName": { "type": "string", "nullable": true }, "fieldValue": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.Doc_TransferFromPreviousDocRequest": { "type": "object", "properties": { "docId": { "type": "integer", "format": "int32" }, "previousDocPositionIds": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.Doc_TransferSaleToPurchaseDocRequest": { "type": "object", "properties": { "docId": { "type": "integer", "format": "int32" }, "docTypeId": { "type": "string", "nullable": true }, "partnerId": { "type": "integer", "format": "int32" }, "docPositionIds": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.Doc_TransferToNextDocRequest": { "type": "object", "properties": { "fromDocId": { "type": "integer", "format": "int32" }, "toDocTypeId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.Dto.ArticleCarouselDto": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name1": { "type": "string", "nullable": true }, "name2": { "type": "string", "nullable": true }, "picture": { "type": "string", "nullable": true }, "articleGroupId": { "type": "integer", "format": "int32" }, "quantity": { "type": "integer", "format": "int32" }, "price": { "type": "number", "format": "double" }, "weight": { "type": "number", "format": "double", "nullable": true }, "length": { "type": "number", "format": "double", "nullable": true }, "width": { "type": "number", "format": "double", "nullable": true }, "height": { "type": "number", "format": "double", "nullable": true }, "volume": { "type": "number", "format": "double", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time", "nullable": true }, "lotSize": { "type": "number", "format": "double" }, "minimumQuantity": { "type": "number", "format": "double" }, "deliveryTime": { "type": "integer", "format": "int32" }, "nowAvailable": { "type": "number", "format": "double", "nullable": true }, "shop": { "type": "boolean" }, "salesPrice": { "type": "number", "format": "double", "nullable": true }, "infoText": { "type": "string", "nullable": true }, "categories": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "partnerShopItem": { "type": "boolean" } }, "additionalProperties": false }, "XERP.Shared.Models.Dto.CalendarAttachmentDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "fileName": { "type": "string", "nullable": true }, "contentType": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.Dto.CalendarAttendeeTrackingDto": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "partStat": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.Dto.CalendarCancelInviteesDto": { "type": "object", "properties": { "appointmentId": { "type": "integer", "format": "int32" }, "removedEmployeeIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "removedPartnerContactPersonIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "emailAccountId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.Dto.CalendarIcsImportRequestDto": { "type": "object", "properties": { "icsContent": { "type": "string", "nullable": true }, "calendarNameId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.Dto.CalendarIcsImportResultDto": { "type": "object", "properties": { "importedCount": { "type": "integer", "format": "int32" }, "updatedCount": { "type": "integer", "format": "int32" }, "skippedCount": { "type": "integer", "format": "int32" }, "cancelledCount": { "type": "integer", "format": "int32" }, "errors": { "type": "array", "items": { "type": "string" }, "nullable": true }, "calendarAppointmentIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "totalProcessed": { "type": "integer", "format": "int32", "readOnly": true } }, "additionalProperties": false }, "XERP.Shared.Models.Dto.CalendarInvitationDto": { "type": "object", "properties": { "appointmentId": { "type": "integer", "format": "int32" }, "employeeIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "partnerContactPersonIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "customMessage": { "type": "string", "nullable": true }, "emailAccountId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.Dto.CalendarInvitationResultDto": { "type": "object", "properties": { "successCount": { "type": "integer", "format": "int32" }, "failedCount": { "type": "integer", "format": "int32" }, "failures": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Dto.InvitationFailure" }, "nullable": true }, "allSuccessful": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "XERP.Shared.Models.Dto.CalendarInviteeSelectionDto": { "type": "object", "properties": { "employeeIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "partnerContactPersonIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "displayEntries": { "type": "array", "items": { "type": "string" }, "nullable": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true } }, "additionalProperties": false }, "XERP.Shared.Models.Dto.CartItemDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "articleId": { "type": "string", "nullable": true }, "quantity": { "type": "integer", "format": "int32" }, "name1": { "type": "string", "nullable": true }, "name2": { "type": "string", "nullable": true }, "articlePicture": { "type": "string", "nullable": true }, "calculatedSalesPrice": { "type": "number", "format": "double" }, "totalPrice": { "type": "number", "format": "double" } }, "additionalProperties": false }, "XERP.Shared.Models.Dto.CategoryNameDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "parentId": { "type": "integer", "format": "int32", "nullable": true }, "hasChildren": { "type": "boolean" }, "expanded": { "type": "boolean" } }, "additionalProperties": false }, "XERP.Shared.Models.Dto.EmailAccountTestResultDto": { "type": "object", "properties": { "smtpSuccess": { "type": "boolean" }, "smtpMessage": { "type": "string", "nullable": true }, "pop3Success": { "type": "boolean" }, "pop3Message": { "type": "string", "nullable": true }, "smtpSkipped": { "type": "boolean" }, "pop3Skipped": { "type": "boolean" }, "overallSuccess": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "XERP.Shared.Models.Dto.EmailBodyDto": { "type": "object", "properties": { "body": { "type": "string", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.Dto.EmailBodyUpdateDto": { "type": "object", "properties": { "emailId": { "type": "integer", "format": "int32" }, "body": { "type": "string", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.Dto.EmailCalendarInviteStatusDto": { "type": "object", "properties": { "emailId": { "type": "integer", "format": "int32" }, "hasCalendarInvite": { "type": "boolean" }, "canProcess": { "type": "boolean" }, "calendarAppointmentId": { "type": "integer", "format": "int32", "nullable": true }, "calendarNameId": { "type": "integer", "format": "int32", "nullable": true }, "calendarName": { "type": "string", "nullable": true }, "icsUid": { "type": "string", "nullable": true }, "method": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "errorMessage": { "type": "string", "nullable": true }, "processedDateTime": { "type": "string", "format": "date-time", "nullable": true }, "responseStatus": { "type": "string", "nullable": true }, "canRespond": { "type": "boolean" }, "isCancellation": { "type": "boolean" }, "meetingStartDateTime": { "type": "string", "format": "date-time", "nullable": true }, "meetingEndDateTime": { "type": "string", "format": "date-time", "nullable": true }, "meetingLocation": { "type": "string", "nullable": true }, "isAllDay": { "type": "boolean" } }, "additionalProperties": false }, "XERP.Shared.Models.Dto.EmailUpdateDto": { "type": "object", "properties": { "email": { "$ref": "#/components/schemas/XERP.Shared.Models.Email" }, "includeBody": { "type": "boolean" } }, "additionalProperties": false }, "XERP.Shared.Models.Dto.EmployeeTimeTrackingInvitationRequest": { "type": "object", "properties": { "employeeId": { "type": "integer", "format": "int32" }, "isTimeTracking": { "type": "boolean" } }, "additionalProperties": false }, "XERP.Shared.Models.Dto.EmployeeTimeTrackingInvitationResult": { "type": "object", "properties": { "invitationSent": { "type": "boolean" }, "timeTrackingAccessEnabled": { "type": "boolean" }, "isTimeTracking": { "type": "boolean" }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "expiresAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.Dto.FieldServiceDTO": { "type": "object", "properties": { "taskId": { "type": "integer", "format": "int32" }, "documentNumber": { "type": "string", "nullable": true }, "duration": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "parentId": { "type": "integer", "format": "int32", "nullable": true }, "startDate": { "type": "string", "format": "date-time", "nullable": true }, "endDate": { "type": "string", "format": "date-time", "nullable": true }, "progress": { "type": "integer", "format": "int32", "nullable": true }, "manual": { "type": "string", "nullable": true }, "manualBool": { "type": "boolean", "nullable": true }, "taskType": { "type": "string", "nullable": true }, "bgcolorCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.Dto.InvitationFailure": { "type": "object", "properties": { "email": { "type": "string", "nullable": true }, "errorMessage": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.Dto.PartnerPortalDTO": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name1": { "type": "string", "nullable": true }, "name2": { "type": "string", "nullable": true }, "partnerGroupId": { "type": "integer", "format": "int32" }, "languageId": { "type": "string", "nullable": true }, "discountGroupNameId": { "type": "integer", "format": "int32", "nullable": true }, "priceListSalesId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.Dto.PartnerPortalInvitationRequest": { "type": "object", "properties": { "partnerId": { "type": "integer", "format": "int32" }, "isWebshop": { "type": "boolean" }, "isMarketplace": { "type": "boolean" }, "isHelpdesk": { "type": "boolean" } }, "additionalProperties": false }, "XERP.Shared.Models.Dto.PartnerPortalInvitationResult": { "type": "object", "properties": { "invitationSent": { "type": "boolean" }, "portalAccessEnabled": { "type": "boolean" }, "isWebshop": { "type": "boolean" }, "isMarketplace": { "type": "boolean" }, "isHelpdesk": { "type": "boolean" }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "portalTypes": { "type": "array", "items": { "type": "string" }, "nullable": true }, "expiresAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "XERP.Shared.Models.Dto.SmartPoolAiChunkDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "chunkNumber": { "type": "integer", "format": "int32" }, "pageNumber": { "type": "integer", "format": "int32", "nullable": true }, "chunkText": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.Dto.SmartPoolAiInsightsDto": { "type": "object", "properties": { "status": { "type": "string", "nullable": true }, "processedAt": { "type": "string", "format": "date-time", "nullable": true }, "embeddingModel": { "type": "string", "nullable": true }, "visionModel": { "type": "string", "nullable": true }, "chunkCount": { "type": "integer", "format": "int32" }, "chunks": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Dto.SmartPoolAiChunkDto" }, "nullable": true }, "keywords": { "type": "array", "items": { "type": "string" }, "nullable": true }, "references": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Dto.SmartPoolAiReferenceDto" }, "nullable": true }, "similarDocuments": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Dto.SmartPoolSimilarDocumentDto" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.Dto.SmartPoolAiReferenceDto": { "type": "object", "properties": { "entityType": { "type": "string", "nullable": true }, "entityId": { "type": "string", "nullable": true }, "entityDisplay": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.Dto.SmartPoolCopyStatusDto": { "type": "object", "properties": { "canCopy": { "type": "boolean" }, "currentVersion": { "type": "integer", "format": "int32" }, "highestVersion": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.Dto.SmartPoolSimilarDocumentDto": { "type": "object", "properties": { "smartPoolId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "fileName": { "type": "string", "nullable": true }, "similarity": { "type": "number", "format": "float" } }, "additionalProperties": false }, "XERP.Shared.Models.Dto.SmartPoolVersionsDto": { "type": "object", "properties": { "predecessors": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW_SmartPool" }, "nullable": true }, "successors": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW_SmartPool" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.Dto.UserCartDto": { "type": "object", "properties": { "totalPrice": { "type": "number", "format": "double" }, "cartItems": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Dto.CartItemDto" }, "nullable": true }, "userAddress": { "$ref": "#/components/schemas/XERP.Shared.Models.OrderAddressDto" } }, "additionalProperties": false }, "XERP.Shared.Models.Email": { "required": [ "senderEmail" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "emailAccountId": { "type": "integer", "format": "int32" }, "emailFolderId": { "type": "integer", "format": "int32" }, "receivedDateTime": { "type": "string", "format": "date-time", "nullable": true }, "senderName": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "senderEmail": { "maxLength": 255, "minLength": 0, "type": "string" }, "receiver": { "maxLength": 1000, "minLength": 0, "type": "string", "nullable": true }, "cc": { "maxLength": 1000, "minLength": 0, "type": "string", "nullable": true }, "bcc": { "maxLength": 1000, "minLength": 0, "type": "string", "nullable": true }, "subject": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "bodyHtml": { "type": "string", "nullable": true }, "bodyHtmlSent": { "type": "string", "nullable": true }, "bodyText": { "type": "string", "nullable": true }, "mimeRaw": { "type": "string", "format": "byte", "nullable": true }, "remark": { "type": "string", "nullable": true }, "pop3Ident": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "imapIdent": { "type": "integer", "format": "int32", "nullable": true }, "seen": { "type": "boolean" }, "entryDateTime": { "type": "string", "format": "date-time", "nullable": true }, "isSent": { "type": "boolean" }, "sentDateTime": { "type": "string", "format": "date-time", "nullable": true }, "numOfSendingTries": { "type": "integer", "format": "int32" }, "prioHigh": { "type": "boolean" }, "followUp": { "type": "string", "format": "date-time", "nullable": true }, "done": { "type": "boolean" }, "messageId": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "answeredParentId": { "type": "integer", "format": "int32", "nullable": true }, "forwardedParentId": { "type": "integer", "format": "int32", "nullable": true }, "importance": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "tag": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "isEditable": { "type": "boolean" }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "answeredParent": { "$ref": "#/components/schemas/XERP.Shared.Models.Email" }, "emailAccount": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailAccount" }, "emailFolder": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailFolder" }, "forwardedParent": { "$ref": "#/components/schemas/XERP.Shared.Models.Email" }, "emailAttachments": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailAttachment" }, "nullable": true }, "emailBodyImages": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailBodyImage" }, "nullable": true }, "emailCalendarInvites": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailCalendarInvite" }, "nullable": true }, "emailLogs": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailLog" }, "nullable": true }, "inverseAnsweredParent": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Email" }, "nullable": true }, "inverseForwardedParent": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Email" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.EmailAccount": { "required": [ "emailAddress", "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 50, "minLength": 0, "type": "string" }, "emailAddress": { "maxLength": 256, "minLength": 0, "type": "string" }, "smtpServerName": { "maxLength": 256, "minLength": 0, "type": "string", "nullable": true }, "smtpPort": { "type": "integer", "format": "int32", "nullable": true }, "smtpUser": { "maxLength": 256, "minLength": 0, "type": "string", "nullable": true }, "smtpPassword": { "maxLength": 256, "minLength": 0, "type": "string", "nullable": true }, "isSSL": { "type": "boolean" }, "pop3ServerName": { "maxLength": 256, "minLength": 0, "type": "string", "nullable": true }, "pop3Port": { "type": "integer", "format": "int32", "nullable": true }, "pop3User": { "maxLength": 256, "minLength": 0, "type": "string", "nullable": true }, "pop3Password": { "maxLength": 256, "minLength": 0, "type": "string", "nullable": true }, "sendInterval": { "type": "integer", "format": "int32" }, "nextSendDateTime": { "type": "string", "format": "date-time" }, "sendRetry": { "type": "integer", "format": "int32" }, "receiveInterval": { "type": "integer", "format": "int32" }, "nextReceiveDateTime": { "type": "string", "format": "date-time" }, "receiveRetry": { "type": "integer", "format": "int32" }, "signature": { "type": "string", "nullable": true }, "deleteMailsFromServer": { "type": "boolean" }, "inboxFolderId": { "type": "integer", "format": "int32", "nullable": true }, "moveUnknownSenderToFolderId": { "type": "integer", "format": "int32", "nullable": true }, "spamFolderId": { "type": "integer", "format": "int32", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "inboxFolder": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailFolder" }, "moveUnknownSenderToFolder": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailFolder" }, "spamFolder": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailFolder" }, "emails": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Email" }, "nullable": true }, "employeeEmailReceiverXerps": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Employee" }, "nullable": true }, "employeeEmailSenderXerps": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Employee" }, "nullable": true }, "helpdeskSettings": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskSetting" }, "nullable": true }, "massEmails": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.MassEmail" }, "nullable": true }, "webshopSettings": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopSetting" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.EmailAttachment": { "required": [ "computerFile" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "emailId": { "type": "integer", "format": "int32" }, "fileGuid": { "type": "string", "format": "uuid" }, "computerFile": { "type": "string", "format": "byte" }, "fileName": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "contentType": { "maxLength": 75, "minLength": 0, "type": "string", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "email": { "$ref": "#/components/schemas/XERP.Shared.Models.Email" } }, "additionalProperties": false }, "XERP.Shared.Models.EmailBodyImage": { "required": [ "imageData", "mimeType" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "emailId": { "type": "integer", "format": "int32" }, "imageIndex": { "type": "integer", "format": "int32" }, "mimeType": { "maxLength": 100, "minLength": 0, "type": "string" }, "imageData": { "type": "string", "format": "byte" }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "email": { "$ref": "#/components/schemas/XERP.Shared.Models.Email" } }, "additionalProperties": false }, "XERP.Shared.Models.EmailCalendarInvite": { "required": [ "method", "status" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "emailId": { "type": "integer", "format": "int32" }, "calendarAppointmentId": { "type": "integer", "format": "int32", "nullable": true }, "calendarNameId": { "type": "integer", "format": "int32", "nullable": true }, "icsUid": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "method": { "maxLength": 20, "minLength": 0, "type": "string" }, "status": { "maxLength": 20, "minLength": 0, "type": "string" }, "errorMessage": { "type": "string", "nullable": true }, "processedDateTime": { "type": "string", "format": "date-time" }, "responseStatus": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "calendarAppointment": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarAppointment" }, "calendarName": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarName" }, "email": { "$ref": "#/components/schemas/XERP.Shared.Models.Email" } }, "additionalProperties": false }, "XERP.Shared.Models.EmailFolder": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 50, "minLength": 0, "type": "string" }, "parentId": { "type": "integer", "format": "int32", "nullable": true }, "groupFolder": { "type": "boolean" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "parent": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailFolder" }, "emailAccountInboxFolders": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailAccount" }, "nullable": true }, "emailAccountMoveUnknownSenderToFolders": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailAccount" }, "nullable": true }, "emailAccountSpamFolders": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailAccount" }, "nullable": true }, "emailRuleIns": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailRuleIn" }, "nullable": true }, "emailRuleOuts": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailRuleOut" }, "nullable": true }, "emails": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Email" }, "nullable": true }, "inverseParent": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailFolder" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.EmailFolderCountDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "parentId": { "type": "integer", "format": "int32", "nullable": true }, "emailCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.EmailLog": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "emailId": { "type": "integer", "format": "int32", "nullable": true }, "date": { "type": "string", "format": "date-time", "nullable": true }, "logEntry": { "type": "string", "nullable": true }, "success": { "type": "boolean" }, "email": { "$ref": "#/components/schemas/XERP.Shared.Models.Email" } }, "additionalProperties": false }, "XERP.Shared.Models.EmailRuleField": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 14, "minLength": 0, "type": "string", "nullable": true }, "name": { "maxLength": 20, "minLength": 0, "type": "string" }, "emailRuleIns": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailRuleIn" }, "nullable": true }, "emailRuleOuts": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailRuleOut" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.EmailRuleIn": { "required": [ "emailRuleFieldId", "name", "substring" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 100, "minLength": 0, "type": "string" }, "emailRuleFieldId": { "maxLength": 14, "minLength": 0, "type": "string" }, "substring": { "maxLength": 100, "minLength": 0, "type": "string" }, "targetFolderId": { "type": "integer", "format": "int32" }, "sortOrder": { "type": "integer", "format": "int32" }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "emailRuleField": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailRuleField" }, "targetFolder": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailFolder" } }, "additionalProperties": false }, "XERP.Shared.Models.EmailRuleOut": { "required": [ "emailRuleFieldId", "name", "substring" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 100, "minLength": 0, "type": "string" }, "emailRuleFieldId": { "maxLength": 14, "minLength": 0, "type": "string" }, "substring": { "maxLength": 100, "minLength": 0, "type": "string" }, "targetFolderId": { "type": "integer", "format": "int32" }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "emailRuleField": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailRuleField" }, "targetFolder": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailFolder" } }, "additionalProperties": false }, "XERP.Shared.Models.EmailSignature": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 200, "minLength": 0, "type": "string" }, "signature": { "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "emailSignatureAttachments": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailSignatureAttachment" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.EmailSignatureAttachment": { "required": [ "computerFile" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "emailSignatureId": { "type": "integer", "format": "int32" }, "fileGuid": { "type": "string", "format": "uuid" }, "computerFile": { "type": "string", "format": "byte" }, "fileName": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "contentType": { "maxLength": 75, "minLength": 0, "type": "string", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "emailSignature": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailSignature" } }, "additionalProperties": false }, "XERP.Shared.Models.EmailSpamProtectionSender": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.EmailSpamProtectionSubject": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.EmailSystem": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "sendWithInternalEmailSystem": { "type": "boolean" }, "receiveWithInternalEmailSystem": { "type": "boolean" }, "minutesCheckInbox": { "type": "integer", "format": "int32" }, "timeout": { "type": "integer", "format": "int32" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.EmailTemplate": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 50, "minLength": 0, "type": "string" }, "emailTemplateGroupId": { "type": "integer", "format": "int32" }, "docTypeId": { "maxLength": 35, "minLength": 0, "type": "string", "nullable": true }, "languageId": { "maxLength": 5, "minLength": 0, "type": "string", "nullable": true }, "subject": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "mailTo": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "mailCc": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "mailBcc": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "body": { "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "docType": { "$ref": "#/components/schemas/XERP.Shared.Models.DocType" }, "emailTemplateGroup": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailTemplateGroup" }, "language": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminLanguage" }, "docTypes": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocType" }, "nullable": true }, "emailTemplateAttachments": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailTemplateAttachment" }, "nullable": true }, "financeDunnings": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceDunning" }, "nullable": true }, "helpdeskNotifications": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskNotification" }, "nullable": true }, "partnerDetailOutputs": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDetailOutput" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.EmailTemplateAttachment": { "required": [ "computerFile" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "emailTemplateId": { "type": "integer", "format": "int32" }, "fileGuid": { "type": "string", "format": "uuid" }, "computerFile": { "type": "string", "format": "byte" }, "fileName": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "contentType": { "maxLength": 75, "minLength": 0, "type": "string", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "emailTemplate": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailTemplate" } }, "additionalProperties": false }, "XERP.Shared.Models.EmailTemplateGroup": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 50, "minLength": 0, "type": "string" }, "parentId": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "parent": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailTemplateGroup" }, "emailTemplates": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailTemplate" }, "nullable": true }, "inverseParent": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailTemplateGroup" }, "nullable": true }, "children": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailTemplateGroup" }, "nullable": true }, "hasChildren": { "type": "boolean" } }, "additionalProperties": false }, "XERP.Shared.Models.Employee": { "required": [ "email", "firstName", "lastName", "matchcode" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "title": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "salutation": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "firstName": { "maxLength": 100, "minLength": 0, "type": "string" }, "lastName": { "maxLength": 100, "minLength": 0, "type": "string" }, "street": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "zip": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "city": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "countryId": { "maxLength": 2, "minLength": 0, "type": "string", "nullable": true }, "position": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "matchcode": { "maxLength": 50, "minLength": 0, "type": "string" }, "tel1": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "tel2": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "mobile": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "fax": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "email": { "maxLength": 100, "minLength": 0, "type": "string" }, "normalizedEmail": { "maxLength": 256, "minLength": 0, "type": "string", "nullable": true }, "emailConfirmed": { "type": "boolean" }, "passwordHash": { "maxLength": 256, "minLength": 0, "type": "string", "nullable": true }, "changePasswordAtNextLogin": { "type": "boolean" }, "securityStamp": { "maxLength": 256, "minLength": 0, "type": "string", "nullable": true }, "concurrencyStamp": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "twoFactorEnabled": { "type": "boolean" }, "lockoutEnd": { "type": "string", "format": "date-time", "nullable": true }, "lockoutEnabled": { "type": "boolean" }, "accessFailedCount": { "type": "integer", "format": "int32", "nullable": true }, "remark": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "info": { "maxLength": 1000, "minLength": 0, "type": "string", "nullable": true }, "active": { "type": "boolean" }, "salesperson": { "type": "boolean" }, "technician": { "type": "boolean" }, "crmEmployee": { "type": "boolean" }, "favorite": { "type": "boolean" }, "commissionGroupId": { "type": "integer", "format": "int32", "nullable": true }, "employeeGroupId": { "type": "integer", "format": "int32" }, "keyword": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "userId": { "type": "string", "nullable": true }, "emailSenderXerpId": { "type": "integer", "format": "int32", "nullable": true }, "emailReceiverXerpId": { "type": "integer", "format": "int32", "nullable": true }, "superiorId": { "type": "integer", "format": "int32", "nullable": true }, "locationId": { "type": "integer", "format": "int32" }, "calendarNameId": { "type": "integer", "format": "int32", "nullable": true }, "calendarColor": { "maxLength": 9, "minLength": 0, "type": "string", "nullable": true }, "calendarReminderMinutes": { "type": "integer", "format": "int32", "nullable": true }, "isTimeTracking": { "type": "boolean" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "calendarName": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarName" }, "commissionGroup": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeCommissionGroupName" }, "country": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCountry" }, "emailReceiverXerp": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailAccount" }, "emailSenderXerp": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailAccount" }, "employeeGroup": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeGroup" }, "location": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminLocation" }, "superior": { "$ref": "#/components/schemas/XERP.Shared.Models.Employee" }, "calendarAppointmentAttendees": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarAppointmentAttendee" }, "nullable": true }, "countryPackageIntrastatDeclarations": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatDeclaration" }, "nullable": true }, "countryPackageIntrastatReportingEntities": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatReportingEntity" }, "nullable": true }, "crms": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Crm" }, "nullable": true }, "deviceServices": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DeviceService" }, "nullable": true }, "docClerks": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc" }, "nullable": true }, "docPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition" }, "nullable": true }, "docSalesPeople": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc" }, "nullable": true }, "docXmlClerks": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXml" }, "nullable": true }, "docXmlPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXmlPosition" }, "nullable": true }, "docXmlSalesPeople": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXml" }, "nullable": true }, "employeePasskeys": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeePasskey" }, "nullable": true }, "employeeTokens": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeToken" }, "nullable": true }, "employeeVacationEntitlements": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeVacationEntitlement" }, "nullable": true }, "employeeVacationRequestApprovedBies": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeVacationRequest" }, "nullable": true }, "employeeVacationRequestEmployees": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeVacationRequest" }, "nullable": true }, "fieldServices": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FieldService" }, "nullable": true }, "financeClosingPostings": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceClosingPosting" }, "nullable": true }, "financeOpeningBalances": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpeningBalance" }, "nullable": true }, "helpdeskDialogProtocols": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskDialogProtocol" }, "nullable": true }, "helpdeskDialogs": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskDialog" }, "nullable": true }, "helpdesks": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Helpdesk" }, "nullable": true }, "intercomRecipients": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Intercom" }, "nullable": true }, "intercomSenders": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Intercom" }, "nullable": true }, "inverseSuperior": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Employee" }, "nullable": true }, "partnerDetailEmployees": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDetail" }, "nullable": true }, "partnerDetailSalesPeople": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDetail" }, "nullable": true }, "phoneCalls": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PhoneCall" }, "nullable": true }, "phoneLineEmployees": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PhoneLineEmployee" }, "nullable": true }, "productionDataAcquisitionWorkplaceSessions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisitionWorkplaceSession" }, "nullable": true }, "productionDataAcquisitionWorkplaces": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisitionWorkplace" }, "nullable": true }, "productionDataAcquisitions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisition" }, "nullable": true }, "productionPositionTimerStates": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionTimerState" }, "nullable": true }, "productions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Production" }, "nullable": true }, "projects": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Project" }, "nullable": true }, "timeTrackings": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.TimeTracking" }, "nullable": true }, "warehouseInventoryCountings": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryCounting" }, "nullable": true }, "warehouseInventoryRevaluations": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryRevaluation" }, "nullable": true }, "warehouseTransfers": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseTransfer" }, "nullable": true }, "wikis": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Wiki" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.EmployeeCalendarColorDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "calendarColor": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.EmployeeCommissionGroup": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "commissionGroupId": { "type": "integer", "format": "int32" }, "articleGroupId": { "type": "integer", "format": "int32", "nullable": true }, "partnerGroupId": { "type": "integer", "format": "int32", "nullable": true }, "commissionPercent": { "type": "number", "format": "double" }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "articleGroup": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleGroup" }, "commissionGroup": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeCommissionGroupName" }, "partnerGroup": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerGroup" } }, "additionalProperties": false }, "XERP.Shared.Models.EmployeeCommissionGroupName": { "required": [ "commissionGroupName" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "commissionGroupName": { "maxLength": 100, "minLength": 0, "type": "string" }, "perArticleGroup": { "type": "boolean" }, "perPartnerGroup": { "type": "boolean" }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "employeeCommissionGroups": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeCommissionGroup" }, "nullable": true }, "employees": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Employee" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.EmployeeGroup": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 50, "minLength": 0, "type": "string" }, "parentId": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "parent": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeGroup" }, "employees": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Employee" }, "nullable": true }, "inverseParent": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeGroup" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.EmployeePasskey": { "required": [ "credentialId", "data" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "credentialId": { "maxLength": 512, "type": "string", "format": "byte" }, "employeeId": { "type": "integer", "format": "int32" }, "name": { "maxLength": 256, "minLength": 0, "type": "string", "nullable": true }, "data": { "minLength": 1, "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "employee": { "$ref": "#/components/schemas/XERP.Shared.Models.Employee" } }, "additionalProperties": false }, "XERP.Shared.Models.EmployeeToken": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "employeeId": { "type": "integer", "format": "int32" }, "loginProvider": { "maxLength": 128, "minLength": 0, "type": "string", "nullable": true }, "name": { "maxLength": 128, "minLength": 0, "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true }, "tokenHash": { "maxLength": 256, "minLength": 0, "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": true }, "expiresAt": { "type": "string", "format": "date-time", "nullable": true }, "lastActivityAt": { "type": "string", "format": "date-time", "nullable": true }, "deviceInfo": { "maxLength": 512, "minLength": 0, "type": "string", "nullable": true }, "ipAddress": { "maxLength": 45, "minLength": 0, "type": "string", "nullable": true }, "isRememberMeSession": { "type": "boolean", "nullable": true }, "employee": { "$ref": "#/components/schemas/XERP.Shared.Models.Employee" } }, "additionalProperties": false }, "XERP.Shared.Models.EmployeeVacationEntitlement": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "yearId": { "type": "integer", "format": "int32" }, "employeeId": { "type": "integer", "format": "int32" }, "entitlement": { "type": "number", "format": "double" }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "employee": { "$ref": "#/components/schemas/XERP.Shared.Models.Employee" }, "year": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeVacationYear" } }, "additionalProperties": false }, "XERP.Shared.Models.EmployeeVacationRequest": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "yearId": { "type": "integer", "format": "int32" }, "employeeId": { "type": "integer", "format": "int32" }, "vacationStart": { "type": "string", "format": "date-time" }, "vacationEnd": { "type": "string", "format": "date-time" }, "vacationDays": { "type": "number", "format": "double", "nullable": true }, "vacationTypeId": { "type": "integer", "format": "int32" }, "approved": { "type": "boolean" }, "approvedById": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "approvedBy": { "$ref": "#/components/schemas/XERP.Shared.Models.Employee" }, "employee": { "$ref": "#/components/schemas/XERP.Shared.Models.Employee" }, "vacationType": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeVacationType" }, "year": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminYear" }, "employeeVacationRequestApprovals": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeVacationRequestApproval" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.EmployeeVacationRequestApproval": { "required": [ "blocked" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "employeeVacationRequestId": { "type": "integer", "format": "int32" }, "info": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "blocked": { "type": "boolean" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "employeeVacationRequest": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeVacationRequest" }, "status": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "XERP.Shared.Models.EmployeeVacationType": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 20, "minLength": 0, "type": "string" }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "employeeVacationRequests": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeVacationRequest" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.EmployeeVacationYear": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "employeeVacationEntitlements": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeVacationEntitlement" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.ExternalAspNetRole": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "string", "nullable": true }, "name": { "maxLength": 256, "minLength": 0, "type": "string", "nullable": true }, "normalizedName": { "maxLength": 256, "minLength": 0, "type": "string", "nullable": true }, "concurrencyStamp": { "type": "string", "nullable": true }, "externalAspNetRoleClaims": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetRoleClaim" }, "nullable": true }, "externalAuthorizationRolePagePermissions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAuthorizationRolePagePermission" }, "nullable": true }, "externalAuthorizationRoleWebApiPermissions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAuthorizationRoleWebApiPermission" }, "nullable": true }, "users": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetUser" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.ExternalAspNetRoleClaim": { "required": [ "roleId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "roleId": { "maxLength": 450, "minLength": 0, "type": "string" }, "claimType": { "type": "string", "nullable": true }, "claimValue": { "type": "string", "nullable": true }, "role": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetRole" } }, "additionalProperties": false }, "XERP.Shared.Models.ExternalAspNetUser": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "string", "nullable": true }, "userName": { "maxLength": 256, "minLength": 0, "type": "string", "nullable": true }, "normalizedUserName": { "maxLength": 256, "minLength": 0, "type": "string", "nullable": true }, "email": { "maxLength": 256, "minLength": 0, "type": "string", "nullable": true }, "normalizedEmail": { "maxLength": 256, "minLength": 0, "type": "string", "nullable": true }, "emailConfirmed": { "type": "boolean" }, "passwordHash": { "type": "string", "nullable": true }, "securityStamp": { "type": "string", "nullable": true }, "concurrencyStamp": { "type": "string", "nullable": true }, "phoneNumber": { "type": "string", "nullable": true }, "phoneNumberConfirmed": { "type": "boolean" }, "twoFactorEnabled": { "type": "boolean" }, "lockoutEnd": { "type": "string", "format": "date-time", "nullable": true }, "lockoutEnabled": { "type": "boolean" }, "accessFailedCount": { "type": "integer", "format": "int32" }, "lastName": { "maxLength": 250, "minLength": 0, "type": "string", "nullable": true }, "firstName": { "maxLength": 250, "minLength": 0, "type": "string", "nullable": true }, "active": { "type": "boolean" }, "partnerId": { "type": "integer", "format": "int32", "nullable": true }, "partner": { "$ref": "#/components/schemas/XERP.Shared.Models.Partner" }, "externalAspNetUserClaims": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetUserClaim" }, "nullable": true }, "externalAspNetUserLogins": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetUserLogin" }, "nullable": true }, "externalAspNetUserTokens": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetUserToken" }, "nullable": true }, "roles": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetRole" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.ExternalAspNetUserClaim": { "required": [ "userId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "userId": { "maxLength": 450, "minLength": 0, "type": "string" }, "claimType": { "type": "string", "nullable": true }, "claimValue": { "type": "string", "nullable": true }, "user": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetUser" } }, "additionalProperties": false }, "XERP.Shared.Models.ExternalAspNetUserLogin": { "required": [ "userId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "loginProvider": { "type": "string", "nullable": true }, "providerKey": { "type": "string", "nullable": true }, "providerDisplayName": { "type": "string", "nullable": true }, "userId": { "maxLength": 450, "minLength": 0, "type": "string" }, "user": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetUser" } }, "additionalProperties": false }, "XERP.Shared.Models.ExternalAspNetUserToken": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "userId": { "type": "string", "nullable": true }, "loginProvider": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true }, "user": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetUser" } }, "additionalProperties": false }, "XERP.Shared.Models.ExternalAuthorizationPage": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 100, "minLength": 0, "type": "string" }, "description": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "externalAuthorizationRolePagePermissions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAuthorizationRolePagePermission" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.ExternalAuthorizationRolePagePermission": { "required": [ "roleId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "roleId": { "minLength": 1, "type": "string" }, "pageId": { "type": "integer", "format": "int32" }, "createPermission": { "type": "boolean" }, "readPermission": { "type": "boolean" }, "updatePermission": { "type": "boolean" }, "deletePermission": { "type": "boolean" }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "page": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAuthorizationPage" }, "role": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetRole" } }, "additionalProperties": false }, "XERP.Shared.Models.ExternalAuthorizationRoleWebApiPermission": { "required": [ "roleId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "roleId": { "minLength": 1, "type": "string" }, "webApiId": { "type": "integer", "format": "int32" }, "createPermission": { "type": "boolean" }, "readPermission": { "type": "boolean" }, "updatePermission": { "type": "boolean" }, "deletePermission": { "type": "boolean" }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "role": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetRole" }, "webApi": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAuthorizationWebApi" } }, "additionalProperties": false }, "XERP.Shared.Models.ExternalAuthorizationWebApi": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 100, "minLength": 0, "type": "string" }, "description": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "externalAuthorizationRoleWebApiPermissions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAuthorizationRoleWebApiPermission" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.ExtraApi": { "required": [ "authType", "httpMethod", "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 100, "minLength": 0, "type": "string" }, "info": { "maxLength": 500, "minLength": 0, "type": "string", "nullable": true }, "baseUrl": { "maxLength": 500, "minLength": 0, "type": "string", "nullable": true }, "relativePath": { "maxLength": 500, "minLength": 0, "type": "string", "nullable": true }, "httpMethod": { "maxLength": 7, "minLength": 0, "type": "string" }, "authType": { "maxLength": 20, "minLength": 0, "type": "string" }, "authUser": { "maxLength": 200, "minLength": 0, "type": "string", "nullable": true }, "authSecret": { "maxLength": 4000, "minLength": 0, "type": "string", "nullable": true }, "authHeaderName": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "timeoutSeconds": { "type": "integer", "format": "int32" }, "active": { "type": "boolean" }, "lastSync": { "type": "string", "format": "date-time", "nullable": true }, "lastStatusCode": { "type": "integer", "format": "int32", "nullable": true }, "lastError": { "maxLength": 2000, "minLength": 0, "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "authTypeNavigation": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminApiAuthType" }, "httpMethodNavigation": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraApiHttpMethod" }, "extraApiEntities": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraApiEntity" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.ExtraApiEntity": { "required": [ "directionId", "operationId", "targetTableId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "apiId": { "type": "integer", "format": "int32" }, "directionId": { "maxLength": 6, "minLength": 0, "type": "string" }, "targetTableId": { "maxLength": 50, "minLength": 0, "type": "string" }, "operationId": { "maxLength": 6, "minLength": 0, "type": "string" }, "active": { "type": "boolean" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "api": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraApi" }, "direction": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraApiEntityDirection" }, "operation": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraApiEntityOperation" }, "targetTable": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemTable" } }, "additionalProperties": false }, "XERP.Shared.Models.ExtraApiEntityDirection": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 6, "minLength": 0, "type": "string", "nullable": true }, "extraApiEntities": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraApiEntity" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.ExtraApiEntityOperation": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 6, "minLength": 0, "type": "string", "nullable": true }, "extraApiEntities": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraApiEntity" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.ExtraApiHttpMethod": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 7, "minLength": 0, "type": "string", "nullable": true }, "extraApis": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraApi" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.ExtraCode": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "name": { "maxLength": 50, "minLength": 0, "type": "string" }, "code": { "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.ExtraField": { "required": [ "name", "systemDataTypeId", "systemTableId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "name": { "maxLength": 50, "minLength": 0, "type": "string" }, "systemDataTypeId": { "maxLength": 20, "minLength": 0, "type": "string" }, "systemTableId": { "maxLength": 50, "minLength": 0, "type": "string" }, "length": { "type": "integer", "format": "int32", "nullable": true }, "mandatory": { "type": "boolean" }, "foreignKeyTableId": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "foreignKeyIdField": { "maxLength": 128, "minLength": 0, "type": "string", "nullable": true }, "foreignKeyNameField": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "isUnique": { "type": "boolean" }, "intDefault": { "type": "integer", "format": "int32", "nullable": true }, "decimalDefault": { "type": "number", "format": "double", "nullable": true }, "bitDefault": { "type": "boolean", "nullable": true }, "nVarcharDefault": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "dateTimeDefault": { "type": "string", "format": "date-time", "nullable": true }, "position": { "type": "integer", "format": "int32", "nullable": true }, "leftSide": { "type": "boolean" }, "isDefault": { "type": "boolean" }, "dateDefault": { "type": "string", "format": "date-time", "nullable": true }, "dateTimeOffsetDefault": { "type": "string", "format": "date-time", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "foreignKeyTable": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemTable" }, "systemDataType": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemDataType" }, "systemTable": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemTable" } }, "additionalProperties": false }, "XERP.Shared.Models.ExtraPage": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "name": { "maxLength": 50, "minLength": 0, "type": "string" }, "razorPage": { "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.ExtraPlugin": { "required": [ "developerId", "name", "version" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "name": { "maxLength": 50, "minLength": 0, "type": "string" }, "version": { "maxLength": 20, "minLength": 0, "type": "string" }, "developerId": { "maxLength": 20, "minLength": 0, "type": "string" }, "license": { "maxLength": 256, "minLength": 0, "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.ExtraTable": { "required": [ "indexTypeId", "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "nameUnique": { "type": "boolean" }, "id": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "name": { "maxLength": 50, "minLength": 0, "type": "string" }, "moduleName": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "indexTypeId": { "maxLength": 10, "minLength": 0, "type": "string" }, "characterLimit": { "type": "integer", "format": "int32" }, "attachmentEnabled": { "type": "boolean" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "indexType": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraTableIndexType" } }, "additionalProperties": false }, "XERP.Shared.Models.ExtraTableIndexType": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 10, "minLength": 0, "type": "string", "nullable": true }, "name": { "maxLength": 10, "minLength": 0, "type": "string" }, "extraTables": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraTable" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FieldService": { "required": [ "fieldServiceStatusId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "docId": { "type": "integer", "format": "int32" }, "fieldServiceStatusId": { "maxLength": 12, "minLength": 0, "type": "string" }, "fieldServiceManagerId": { "type": "integer", "format": "int32", "nullable": true }, "plannedDuration": { "type": "number", "format": "double", "nullable": true }, "fieldServiceStart": { "type": "string", "format": "date-time", "nullable": true }, "fieldServiceEnd": { "type": "string", "format": "date-time", "nullable": true }, "durationHour": { "type": "number", "format": "double", "nullable": true }, "progress": { "type": "integer", "format": "int32", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "doc": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc" }, "fieldServiceManager": { "$ref": "#/components/schemas/XERP.Shared.Models.Employee" }, "fieldServiceStatus": { "$ref": "#/components/schemas/XERP.Shared.Models.FieldServiceStatus" }, "fieldServiceResourceSegments": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FieldServiceResourceSegment" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FieldServiceResource": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "docPositionId": { "type": "integer", "format": "int32" }, "resourceId": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "duration": { "type": "string", "format": "date-span", "nullable": true }, "resourceStart": { "type": "string", "format": "date-time", "nullable": true }, "resourceEnd": { "type": "string", "format": "date-time", "nullable": true }, "unit": { "type": "number", "format": "double", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "docPosition": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition" }, "resource": { "$ref": "#/components/schemas/XERP.Shared.Models.Article" }, "fieldServiceResourceSegments": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FieldServiceResourceSegment" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FieldServiceResourceGroup": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 50, "minLength": 0, "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FieldServiceResourceSegment": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "fieldServiceDocId": { "type": "integer", "format": "int32" }, "fieldServiceResourceId": { "type": "integer", "format": "int32" }, "segmentStartTime": { "type": "string", "format": "date-time", "nullable": true }, "segmentEndTime": { "type": "string", "format": "date-time", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "fieldServiceDoc": { "$ref": "#/components/schemas/XERP.Shared.Models.FieldService" }, "fieldServiceResource": { "$ref": "#/components/schemas/XERP.Shared.Models.FieldServiceResource" } }, "additionalProperties": false }, "XERP.Shared.Models.FieldServiceStatus": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 12, "minLength": 0, "type": "string", "nullable": true }, "name": { "maxLength": 20, "minLength": 0, "type": "string" }, "fieldServices": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FieldService" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FieldService_Sproc_UpdateField": { "type": "object", "properties": { "docId": { "type": "integer", "format": "int32" }, "fieldName": { "type": "string", "nullable": true }, "fieldValue": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceAccountAssignment": { "required": [ "accountAssignment" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "accountAssignment": { "maxLength": 10, "minLength": 0, "type": "string" }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "financeAccountGroups": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountGroup" }, "nullable": true }, "financeAccountPlans": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountPlan" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceAccountCategory": { "required": [ "category" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "category": { "maxLength": 50, "minLength": 0, "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "financeAccountPlans": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountPlan" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceAccountDetermination": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 100, "minLength": 0, "type": "string" }, "sortOrder": { "type": "integer", "format": "int32" }, "countryId": { "maxLength": 2, "minLength": 0, "type": "string", "nullable": true }, "partnerGroupId": { "type": "integer", "format": "int32", "nullable": true }, "articleGroupId": { "type": "integer", "format": "int32", "nullable": true }, "locationId": { "type": "integer", "format": "int32", "nullable": true }, "accountId": { "type": "integer", "format": "int32", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "account": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountPlan" }, "articleGroup": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleGroup" }, "country": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCountry" }, "location": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminLocation" }, "partnerGroup": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerGroup" } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceAccountGroup": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 255, "minLength": 0, "type": "string" }, "level": { "type": "integer", "format": "int32" }, "parentId": { "type": "integer", "format": "int32", "nullable": true }, "accountAssignmentId": { "type": "integer", "format": "int32", "nullable": true }, "sortOrder": { "type": "integer", "format": "int32" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "accountAssignment": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountAssignment" }, "parent": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountGroup" }, "financeAccountPlans": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountPlan" }, "nullable": true }, "inverseParent": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountGroup" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceAccountInternalReconciliation": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "account": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountPlan" }, "financeAccountInternalReconciliationPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountInternalReconciliationPosition" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceAccountInternalReconciliationPosition": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "reconciliationId": { "type": "integer", "format": "int32" }, "reconciliationPosition": { "type": "integer", "format": "int32" }, "postingPositionId": { "type": "integer", "format": "int32" }, "amount": { "type": "number", "format": "double" }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "postingPosition": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPosition" }, "reconciliation": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountInternalReconciliation" } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceAccountInternalReconciliationPosition_GetReconciliationPositionsRequest": { "type": "object", "properties": { "reconciliationId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceAccountInternalReconciliationPostingDto": { "type": "object", "properties": { "internalReconciliation": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountInternalReconciliation" }, "internalReconciliationPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW621_FinanceAccountReconciliationPosition" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceAccountInternalReconciliation_GetAttachmentCountRequest": { "type": "object", "properties": { "financeAccountInternalReconciliationId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceAccountInternalReconciliation_ReconciliationCancellationRequest": { "type": "object", "properties": { "reconciliationId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceAccountPlan": { "required": [ "accountNumber", "matchcode", "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "accountNumberAndName": { "type": "string", "nullable": true, "readOnly": true }, "id": { "type": "integer", "format": "int32" }, "accountNumber": { "maxLength": 20, "minLength": 0, "type": "string" }, "name": { "maxLength": 200, "minLength": 0, "type": "string" }, "matchcode": { "maxLength": 220, "minLength": 0, "type": "string" }, "accountGroupId": { "type": "integer", "format": "int32" }, "taxKeyId": { "maxLength": 3, "minLength": 0, "type": "string", "nullable": true }, "accountTypeId": { "type": "integer", "format": "int32" }, "purposeId": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "assignmentId": { "type": "integer", "format": "int32" }, "foreignCurrencyId": { "maxLength": 3, "minLength": 0, "type": "string", "nullable": true }, "balance": { "type": "number", "format": "double" }, "foreignCurrencyBalance": { "type": "number", "format": "double", "nullable": true }, "balanceTransfer": { "type": "boolean" }, "taxCodeFix": { "type": "boolean" }, "assetAccount": { "type": "boolean" }, "indirect": { "type": "boolean" }, "costing": { "type": "boolean" }, "costTypeId": { "type": "integer", "format": "int32", "nullable": true }, "accountCategoryId": { "type": "integer", "format": "int32", "nullable": true }, "costCenterId": { "type": "integer", "format": "int32", "nullable": true }, "costBearerId": { "type": "integer", "format": "int32", "nullable": true }, "debitSide": { "type": "boolean" }, "active": { "type": "boolean" }, "favorite": { "type": "boolean" }, "parentId": { "type": "integer", "format": "int32", "nullable": true }, "balanceGroupId": { "type": "integer", "format": "int32", "nullable": true }, "profitLossGroupId": { "type": "integer", "format": "int32", "nullable": true }, "businessAssessmentGroupId": { "type": "integer", "format": "int32", "nullable": true }, "datevAccount": { "type": "integer", "format": "int32", "nullable": true }, "datevAutomaticAccount": { "type": "boolean" }, "assetClassId": { "type": "integer", "format": "int32", "nullable": true }, "warnOnNegativeBalance": { "type": "boolean" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "accountCategory": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountCategory" }, "accountGroup": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountGroup" }, "accountType": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountType" }, "assetClass": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetClass" }, "assignment": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountAssignment" }, "balanceGroup": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceBalanceGroup" }, "businessAssessmentGroup": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceBusinessAssessmentGroup" }, "costBearer": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceCostBearer" }, "costCenter": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceCostCenter" }, "costType": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceCostType" }, "foreignCurrency": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCurrency" }, "parent": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountPlan" }, "profitLossGroup": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceProfitLossGroup" }, "purpose": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountPurpose" }, "taxKey": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTaxKey" }, "countryPackageOssProcedureAccountPlan": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageOssProcedureAccountPlan" }, "docPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition" }, "nullable": true }, "docXmlPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXmlPosition" }, "nullable": true }, "financeAccountDeterminations": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountDetermination" }, "nullable": true }, "financeAccountInternalReconciliations": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountInternalReconciliation" }, "nullable": true }, "financeClosingPostingClosingAccounts": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceClosingPosting" }, "nullable": true }, "financeClosingPostingOpeningAccounts": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceClosingPosting" }, "nullable": true }, "financeClosingPostingPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceClosingPostingPosition" }, "nullable": true }, "financeCompanyBankAccountGeneralLedgerAccounts": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceCompanyBankAccount" }, "nullable": true }, "financeCompanyBankAccountInterimAccounts": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceCompanyBankAccount" }, "nullable": true }, "financeFixedAssetAssetAccounts": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAsset" }, "nullable": true }, "financeFixedAssetDepreciationAccounts": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAsset" }, "nullable": true }, "financeFixedAssetDepreciationPlanAssetAccounts": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDepreciationPlan" }, "nullable": true }, "financeFixedAssetDepreciationPlanDepreciationAccounts": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDepreciationPlan" }, "nullable": true }, "financeGroupArticleDetailCostOfSalesAccounts": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceGroupArticleDetail" }, "nullable": true }, "financeGroupArticleDetailRevenueExpenditureAccounts": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceGroupArticleDetail" }, "nullable": true }, "financeGroupArticleDetailStockAccounts": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceGroupArticleDetail" }, "nullable": true }, "financeGroupPartners": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceGroupPartner" }, "nullable": true }, "financeOpenItems": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItem" }, "nullable": true }, "financeOpeningBalancePositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpeningBalancePosition" }, "nullable": true }, "financeOpeningBalances": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpeningBalance" }, "nullable": true }, "financePostingPositionAccounts": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPosition" }, "nullable": true }, "financePostingPositionContraAccounts": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPosition" }, "nullable": true }, "financePostingPositionDraftAccounts": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionDraft" }, "nullable": true }, "financePostingPositionDraftContraAccounts": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionDraft" }, "nullable": true }, "financePostingPositionTemplateAccounts": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionTemplate" }, "nullable": true }, "financePostingPositionTemplateContraAccounts": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionTemplate" }, "nullable": true }, "financeTaxKeyDetailCashDiscountAccounts": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTaxKeyDetail" }, "nullable": true }, "financeTaxKeyDetailNotDueAccounts": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTaxKeyDetail" }, "nullable": true }, "financeTaxKeyDetailTaxAccounts": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTaxKeyDetail" }, "nullable": true }, "financeTransferCategories": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferCategory" }, "nullable": true }, "financeTransferGeneralLedgerAccounts": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransfer" }, "nullable": true }, "financeTransferInterimAccounts": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransfer" }, "nullable": true }, "financeTransferPositionAccountPlans": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionAccountPlan" }, "nullable": true }, "financeTransferPositionOpenItems": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionOpenItem" }, "nullable": true }, "financeTransferPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPosition" }, "nullable": true }, "financeTransferSuggestions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferSuggestion" }, "nullable": true }, "inverseParent": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountPlan" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceAccountPurpose": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "name": { "maxLength": 50, "minLength": 0, "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "financeAccountPlans": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountPlan" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceAccountType": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 30, "minLength": 0, "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "financeAccountPlans": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountPlan" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceBalanceGroup": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 255, "minLength": 0, "type": "string" }, "level": { "type": "integer", "format": "int32" }, "parentId": { "type": "integer", "format": "int32", "nullable": true }, "sortOrder": { "type": "integer", "format": "int32" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "parent": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceBalanceGroup" }, "financeAccountPlans": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountPlan" }, "nullable": true }, "inverseParent": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceBalanceGroup" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceBusinessAssessmentGroup": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 255, "minLength": 0, "type": "string" }, "level": { "type": "integer", "format": "int32" }, "parentId": { "type": "integer", "format": "int32", "nullable": true }, "sortOrder": { "type": "integer", "format": "int32" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "parent": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceBusinessAssessmentGroup" }, "financeAccountPlans": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountPlan" }, "nullable": true }, "inverseParent": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceBusinessAssessmentGroup" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceClosingPosting": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "info": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "accountantId": { "type": "integer", "format": "int32" }, "closingAccountId": { "type": "integer", "format": "int32" }, "openingAccountId": { "type": "integer", "format": "int32" }, "receiptNumber": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "receiptDate": { "type": "string", "format": "date-time" }, "closingPostingPeriodId": { "type": "integer", "format": "int32" }, "openingPostingPeriodId": { "type": "integer", "format": "int32" }, "closingDate": { "type": "string", "format": "date-time" }, "openingDate": { "type": "string", "format": "date-time" }, "draft": { "type": "boolean" }, "totalAmount": { "type": "number", "format": "double" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "accountant": { "$ref": "#/components/schemas/XERP.Shared.Models.Employee" }, "closingAccount": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountPlan" }, "closingPostingPeriod": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPeriod" }, "openingAccount": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountPlan" }, "openingPostingPeriod": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPeriod" }, "financeClosingPostingPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceClosingPostingPosition" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceClosingPostingPosition": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "closingPostingId": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "amount": { "type": "number", "format": "double" }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "account": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountPlan" }, "closingPosting": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceClosingPosting" } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceClosingPostingPosition_DeleteRequest": { "type": "object", "properties": { "financeClosingPostingPositionId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceClosingPostingPosition_GetAllFromViewByValueRequest": { "type": "object", "properties": { "propertyName": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceClosingPostingPosition_SaveDraftRequest": { "type": "object", "properties": { "financeClosingPostingId": { "type": "integer", "format": "int32" }, "createdBy": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceClosingPosting_CreateNewRequest": { "type": "object", "properties": { "accountantId": { "type": "integer", "format": "int32" }, "closingAccountId": { "type": "integer", "format": "int32" }, "openingAccountId": { "type": "integer", "format": "int32" }, "closingPeriodId": { "type": "integer", "format": "int32" }, "openingPeriodId": { "type": "integer", "format": "int32" }, "closingDate": { "type": "string", "format": "date-time" }, "openingDate": { "type": "string", "format": "date-time" }, "createdById": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceClosingPosting_DeleteRequest": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceClosingPosting_UpdateInfoRequest": { "type": "object", "properties": { "financeClosingPostingId": { "type": "integer", "format": "int32" }, "info": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceClosingPosting_UpdateReceiptDateRequest": { "type": "object", "properties": { "financeClosingPostingId": { "type": "integer", "format": "int32" }, "receiptDate": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceClosingPosting_UpdateReceiptNumberRequest": { "type": "object", "properties": { "financeClosingPostingId": { "type": "integer", "format": "int32" }, "receiptNumber": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceCompanyBankAccount": { "required": [ "accountOwner", "name", "type" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 34, "minLength": 0, "type": "string", "nullable": true }, "type": { "maxLength": 10, "minLength": 0, "type": "string" }, "bankId": { "maxLength": 40, "minLength": 0, "type": "string", "nullable": true }, "name": { "maxLength": 40, "minLength": 0, "type": "string" }, "accountOwner": { "maxLength": 40, "minLength": 0, "type": "string" }, "foreignCurrencyId": { "maxLength": 3, "minLength": 0, "type": "string", "nullable": true }, "generalLedgerAccountId": { "type": "integer", "format": "int32", "nullable": true }, "interimAccountId": { "type": "integer", "format": "int32", "nullable": true }, "eBankingTypeId": { "type": "integer", "format": "int32", "nullable": true }, "systemMappingFormatNameId": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "bank": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminBank" }, "eBankingType": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminBankAccountEBankingType" }, "foreignCurrency": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCurrency" }, "generalLedgerAccount": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountPlan" }, "interimAccount": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountPlan" }, "systemMappingFormatName": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemMappingFormatName" }, "financePayments": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePayment" }, "nullable": true }, "financeTransfers": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransfer" }, "nullable": true }, "partnerTermsOfPayments": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerTermsOfPayment" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceCostBearer": { "required": [ "costBearer" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "costBearer": { "maxLength": 50, "minLength": 0, "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "articleCosts": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleCost" }, "nullable": true }, "docPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition" }, "nullable": true }, "docXmlPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXmlPosition" }, "nullable": true }, "financeAccountPlans": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountPlan" }, "nullable": true }, "financeFixedAssetDepreciationPlans": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDepreciationPlan" }, "nullable": true }, "financeFixedAssets": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAsset" }, "nullable": true }, "financeGroupArticleDetails": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceGroupArticleDetail" }, "nullable": true }, "financeOpenItems": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItem" }, "nullable": true }, "financePostingPositionDrafts": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionDraft" }, "nullable": true }, "financePostingPositionTemplates": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionTemplate" }, "nullable": true }, "financePostingPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPosition" }, "nullable": true }, "financeTransferPositionAccountPlans": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionAccountPlan" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceCostCenter": { "required": [ "costCenter" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "costCenter": { "maxLength": 50, "minLength": 0, "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "articleCosts": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleCost" }, "nullable": true }, "docPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition" }, "nullable": true }, "docXmlPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXmlPosition" }, "nullable": true }, "financeAccountPlans": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountPlan" }, "nullable": true }, "financeFixedAssetDepreciationPlans": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDepreciationPlan" }, "nullable": true }, "financeFixedAssets": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAsset" }, "nullable": true }, "financeGroupArticleDetails": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceGroupArticleDetail" }, "nullable": true }, "financeOpenItems": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItem" }, "nullable": true }, "financePostingPositionDrafts": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionDraft" }, "nullable": true }, "financePostingPositionTemplates": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionTemplate" }, "nullable": true }, "financePostingPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPosition" }, "nullable": true }, "financeTransferPositionAccountPlans": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionAccountPlan" }, "nullable": true }, "partnerDetails": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDetail" }, "nullable": true }, "productionDataAcquisitionWorkplaces": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisitionWorkplace" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceCostType": { "required": [ "costType" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "costType": { "maxLength": 50, "minLength": 0, "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "financeAccountPlans": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountPlan" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceDunning": { "required": [ "dunningText" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "partnerId": { "type": "integer", "format": "int32" }, "dunningDate": { "type": "string", "format": "date-time" }, "dunningLevelId": { "type": "integer", "format": "int32" }, "info": { "maxLength": 200, "minLength": 0, "type": "string", "nullable": true }, "dunningText": { "minLength": 1, "type": "string" }, "goodwillDays": { "type": "integer", "format": "int32" }, "openAmountSum": { "type": "number", "format": "double" }, "fee": { "type": "number", "format": "double" }, "interest": { "type": "number", "format": "double" }, "totalDue": { "type": "number", "format": "double", "nullable": true }, "foreignCurrencyId": { "maxLength": 3, "minLength": 0, "type": "string", "nullable": true }, "outputControlFormatId": { "type": "integer", "format": "int32" }, "emailTemplateId": { "type": "integer", "format": "int32" }, "reportTemplateId": { "type": "integer", "format": "int32" }, "archived": { "type": "boolean" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "dunningLevel": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceDunningLevel" }, "emailTemplate": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailTemplate" }, "foreignCurrency": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCurrency" }, "outputControlFormat": { "$ref": "#/components/schemas/XERP.Shared.Models.OutputControlFormat" }, "partner": { "$ref": "#/components/schemas/XERP.Shared.Models.Partner" }, "reportTemplate": { "$ref": "#/components/schemas/XERP.Shared.Models.ReportTemplate" }, "archiveDunnings": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArchiveDunning" }, "nullable": true }, "financeDunningPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceDunningPosition" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceDunningLevel": { "required": [ "dunningText" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "info": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "dunningText": { "minLength": 1, "type": "string" }, "goodwillDays": { "type": "integer", "format": "int32" }, "fee": { "type": "number", "format": "double" }, "interest": { "type": "number", "format": "double" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "financeDunningPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceDunningPosition" }, "nullable": true }, "financeDunnings": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceDunning" }, "nullable": true }, "financeOpenItems": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItem" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceDunningPosition": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "dunningId": { "type": "integer", "format": "int32", "nullable": true }, "partnerId": { "type": "integer", "format": "int32" }, "partnerDetailId": { "type": "integer", "format": "int32" }, "date": { "type": "string", "format": "date-time" }, "openItemId": { "type": "integer", "format": "int32" }, "openAmount": { "type": "number", "format": "double" }, "dunningLevelId": { "type": "integer", "format": "int32", "nullable": true }, "goodwillDays": { "type": "integer", "format": "int32" }, "fee": { "type": "number", "format": "double" }, "interest": { "type": "number", "format": "double" }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "dunning": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceDunning" }, "dunningLevel": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceDunningLevel" }, "openItem": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItem" } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceDunningPosition_RunWizardRequest": { "type": "object", "properties": { "selectedFromCustomer": { "type": "string", "nullable": true }, "selectedToCustomer": { "type": "string", "nullable": true }, "selectedLocation": { "type": "integer", "format": "int32", "nullable": true }, "includeNegativeAmounts": { "type": "boolean" } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceEInvoiceTaxKeyCategory": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 2, "minLength": 0, "type": "string", "nullable": true }, "name": { "maxLength": 50, "minLength": 0, "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "financeTaxKeys": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTaxKey" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceFixedAsset": { "required": [ "assetNumber", "info", "statusId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "assetNumber": { "maxLength": 100, "minLength": 0, "type": "string" }, "info": { "maxLength": 200, "minLength": 0, "type": "string" }, "acquisitionCostGross": { "type": "number", "format": "double", "nullable": true }, "taxKeyId": { "maxLength": 3, "minLength": 0, "type": "string", "nullable": true }, "acquisitionCostNet": { "type": "number", "format": "double" }, "depreciationTypeId": { "type": "integer", "format": "int32" }, "cyclePeriodId": { "maxLength": 10, "minLength": 0, "type": "string", "nullable": true }, "assetGroupId": { "type": "integer", "format": "int32" }, "acquisitionDate": { "type": "string", "format": "date-time" }, "inServiceDate": { "type": "string", "format": "date-time", "nullable": true }, "depreciationStartDate": { "type": "string", "format": "date-time", "nullable": true }, "calculationStartDate": { "type": "string", "format": "date-time", "nullable": true }, "calculationStartAcquisitionCostNet": { "type": "number", "format": "double" }, "usefulLifeMonthsQuantity": { "type": "integer", "format": "int32", "nullable": true }, "depreciationAccountId": { "type": "integer", "format": "int32", "nullable": true }, "assetAccountId": { "type": "integer", "format": "int32", "nullable": true }, "memorandumValue": { "type": "number", "format": "double" }, "locationId": { "type": "integer", "format": "int32" }, "statusId": { "maxLength": 14, "minLength": 0, "type": "string" }, "costCenterId": { "type": "integer", "format": "int32", "nullable": true }, "costBearerId": { "type": "integer", "format": "int32", "nullable": true }, "switchToLinearDate": { "type": "string", "format": "date-time", "nullable": true }, "disposalDate": { "type": "string", "format": "date-time", "nullable": true }, "fullRateInAcquisitionYear": { "type": "boolean" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "assetAccount": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountPlan" }, "assetGroup": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetGroup" }, "costBearer": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceCostBearer" }, "costCenter": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceCostCenter" }, "cyclePeriod": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDepreciationCyclePeriod" }, "depreciationAccount": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountPlan" }, "depreciationType": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDepreciationType" }, "location": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminLocation" }, "status": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetStatus" }, "taxKey": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTaxKey" }, "financeFixedAssetDepreciationPlans": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDepreciationPlan" }, "nullable": true }, "financeFixedAssetDetails": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDetail" }, "nullable": true }, "financePostingDrafts": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingDraft" }, "nullable": true }, "financePostingTemplates": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingTemplate" }, "nullable": true }, "financePostings": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePosting" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceFixedAssetClass": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 255, "minLength": 0, "type": "string" }, "parentId": { "type": "integer", "format": "int32", "nullable": true }, "sortOrder": { "type": "integer", "format": "int32" }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "parent": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetClass" }, "financeAccountPlans": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountPlan" }, "nullable": true }, "inverseParent": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetClass" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceFixedAssetDepreciationCyclePeriod": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 10, "minLength": 0, "type": "string", "nullable": true }, "name": { "maxLength": 20, "minLength": 0, "type": "string" }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "financeFixedAssets": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAsset" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceFixedAssetDepreciationMethod": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "name": { "maxLength": 50, "minLength": 0, "type": "string" }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "financeFixedAssetDepreciationTypes": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDepreciationType" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceFixedAssetDepreciationPlan": { "required": [ "info" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "fixedAssetId": { "type": "integer", "format": "int32" }, "depreciationTypeId": { "type": "integer", "format": "int32" }, "postingPeriodId": { "type": "integer", "format": "int32" }, "year": { "type": "integer", "format": "int32" }, "month": { "type": "integer", "format": "int32" }, "depreciationAmount": { "type": "number", "format": "double" }, "depreciationAccountId": { "type": "integer", "format": "int32", "nullable": true }, "assetAccountId": { "type": "integer", "format": "int32", "nullable": true }, "receiptDate": { "type": "string", "format": "date-time" }, "costCenterId": { "type": "integer", "format": "int32", "nullable": true }, "costBearerId": { "type": "integer", "format": "int32", "nullable": true }, "info": { "maxLength": 200, "minLength": 0, "type": "string" }, "postingId": { "type": "integer", "format": "int32", "nullable": true }, "isPosted": { "type": "boolean" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "assetAccount": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountPlan" }, "costBearer": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceCostBearer" }, "costCenter": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceCostCenter" }, "depreciationAccount": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountPlan" }, "depreciationType": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDepreciationType" }, "fixedAsset": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAsset" }, "posting": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePosting" }, "postingPeriod": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPeriod" } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceFixedAssetDepreciationType": { "required": [ "methodId", "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 100, "minLength": 0, "type": "string" }, "methodId": { "maxLength": 20, "minLength": 0, "type": "string" }, "usefulLifeMonthsQuantity": { "type": "integer", "format": "int32", "nullable": true }, "minimumAmount": { "type": "number", "format": "double", "nullable": true }, "maximumAmount": { "type": "number", "format": "double", "nullable": true }, "validFrom": { "type": "string", "format": "date-time", "nullable": true }, "validUntil": { "type": "string", "format": "date-time", "nullable": true }, "isActive": { "type": "boolean" }, "fullRateInAcquisitionYear": { "type": "boolean" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "method": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDepreciationMethod" }, "financeFixedAssetDepreciationPlans": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDepreciationPlan" }, "nullable": true }, "financeFixedAssetDepreciationTypeDetails": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDepreciationTypeDetail" }, "nullable": true }, "financeFixedAssets": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAsset" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceFixedAssetDepreciationTypeDetail": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "nr": { "type": "integer", "format": "int32" }, "id": { "type": "integer", "format": "int32" }, "depreciationTypeId": { "type": "integer", "format": "int32" }, "months": { "type": "integer", "format": "int32" }, "depreciationPercent": { "type": "number", "format": "double" }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "depreciationType": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDepreciationType" } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceFixedAssetDetail": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "fixedAssetId": { "type": "integer", "format": "int32" }, "months": { "type": "integer", "format": "int32" }, "depreciationPercent": { "type": "number", "format": "double" }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "fixedAsset": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAsset" } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceFixedAssetGroup": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 50, "minLength": 0, "type": "string" }, "parentId": { "type": "integer", "format": "int32", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "parent": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetGroup" }, "financeFixedAssets": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAsset" }, "nullable": true }, "inverseParent": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetGroup" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceFixedAssetStatus": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 14, "minLength": 0, "type": "string", "nullable": true }, "name": { "maxLength": 20, "minLength": 0, "type": "string" }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "financeFixedAssets": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAsset" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceFixedAsset_CopyDepreciationTypeDetailsRequest": { "type": "object", "properties": { "fixedAssetId": { "type": "integer", "format": "int32" }, "depreciationTypeId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceFixedAsset_CreateDepreciationPostingRequest": { "type": "object", "properties": { "fixedAssetId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceFixedAsset_DeleteDepreciationSuggestionsRequest": { "type": "object", "additionalProperties": false }, "XERP.Shared.Models.FinanceFixedAsset_DisposalPreviewRequest": { "type": "object", "properties": { "fixedAssetId": { "type": "integer", "format": "int32" }, "disposalDate": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceFixedAsset_DisposalPreviewResult": { "type": "object", "properties": { "effectiveBasis": { "type": "number", "format": "double" }, "alreadyPostedDepreciation": { "type": "number", "format": "double" }, "totalDepreciation": { "type": "number", "format": "double" }, "catchUpDepreciation": { "type": "number", "format": "double" }, "remainingBookValue": { "type": "number", "format": "double" }, "elapsedDays": { "type": "integer", "format": "int32" }, "totalDays": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceFixedAsset_DisposeRequest": { "type": "object", "properties": { "fixedAssetId": { "type": "integer", "format": "int32" }, "disposalDate": { "type": "string", "format": "date-time" }, "statusId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceFixedAsset_LinkPostingRequest": { "type": "object", "properties": { "fixedAssetId": { "type": "integer", "format": "int32" }, "postingId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceFixedAsset_SuggestDepreciationsRequest": { "type": "object", "properties": { "assetFromId": { "type": "string", "nullable": true }, "assetToId": { "type": "string", "nullable": true }, "locationId": { "type": "integer", "format": "int32", "nullable": true }, "postingPeriodId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceFixedAsset_SwitchToLinearOptionsResult": { "type": "object", "properties": { "allowedYears": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "defaultYear": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceFixedAsset_SwitchToLinearRequest": { "type": "object", "properties": { "fixedAssetId": { "type": "integer", "format": "int32" }, "switchYear": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceGroupArticle": { "required": [ "name", "partnerTypeId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "partnerTypeAndName": { "type": "string", "nullable": true, "readOnly": true }, "id": { "type": "integer", "format": "int32" }, "partnerTypeId": { "maxLength": 10, "minLength": 0, "type": "string" }, "name": { "maxLength": 50, "minLength": 0, "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "partnerType": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerType" }, "countryPackageOssProcedureFinanceGroupArticleSale": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageOssProcedureFinanceGroupArticleSale" }, "articleProcurementFinanceGroups": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Article" }, "nullable": true }, "articleSalesFinanceGroups": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Article" }, "nullable": true }, "docPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition" }, "nullable": true }, "docXmlPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXmlPosition" }, "nullable": true }, "financeGroupArticleDetails": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceGroupArticleDetail" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceGroupArticleDetail": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "financeGroupArticleId": { "type": "integer", "format": "int32" }, "financeGroupPartnerDetailId": { "type": "integer", "format": "int32" }, "revenueExpenditureAccountId": { "type": "integer", "format": "int32", "nullable": true }, "taxKeyId": { "maxLength": 3, "minLength": 0, "type": "string", "nullable": true }, "costOfSalesAccountId": { "type": "integer", "format": "int32", "nullable": true }, "costCenterId": { "type": "integer", "format": "int32", "nullable": true }, "costBearerId": { "type": "integer", "format": "int32", "nullable": true }, "stockAccountId": { "type": "integer", "format": "int32", "nullable": true }, "vatNumberRequired": { "type": "boolean" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "costBearer": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceCostBearer" }, "costCenter": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceCostCenter" }, "costOfSalesAccount": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountPlan" }, "financeGroupArticle": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceGroupArticle" }, "financeGroupPartnerDetail": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceGroupPartner" }, "revenueExpenditureAccount": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountPlan" }, "stockAccount": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountPlan" }, "taxKey": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTaxKey" } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceGroupArticleIdResult": { "type": "object", "properties": { "taxKeyId": { "type": "string", "nullable": true }, "taxPercent": { "type": "number", "format": "double", "nullable": true }, "tax": { "type": "number", "format": "double", "nullable": true }, "accountId": { "type": "integer", "format": "int32", "nullable": true }, "costCenterId": { "type": "integer", "format": "int32", "nullable": true }, "costBearerId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceGroupPartner": { "required": [ "name", "partnerTypeId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "partnerTypeId": { "maxLength": 10, "minLength": 0, "type": "string" }, "name": { "maxLength": 50, "minLength": 0, "type": "string" }, "collectiveAccountId": { "type": "integer", "format": "int32" }, "isDefault": { "type": "boolean" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "collectiveAccount": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountPlan" }, "partnerType": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerType" }, "docPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition" }, "nullable": true }, "docXmlPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXmlPosition" }, "nullable": true }, "financeGroupArticleDetails": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceGroupArticleDetail" }, "nullable": true }, "partnerDetails": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDetail" }, "nullable": true }, "webshopSettings": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopSetting" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceOpenItem": { "required": [ "docNumber", "openItemOriginId", "openItemTypeId", "partnerTypeId", "statusId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "statusId": { "maxLength": 12, "minLength": 0, "type": "string" }, "openItemOriginId": { "maxLength": 8, "minLength": 0, "type": "string" }, "openItemTypeId": { "maxLength": 2, "minLength": 0, "type": "string" }, "docTypeId": { "maxLength": 35, "minLength": 0, "type": "string", "nullable": true }, "partnerTypeId": { "maxLength": 10, "minLength": 0, "type": "string" }, "partnerId": { "type": "integer", "format": "int32" }, "partnerDetailId": { "type": "integer", "format": "int32" }, "postingId": { "type": "integer", "format": "int32", "nullable": true }, "postingDate": { "type": "string", "format": "date-time" }, "docDate": { "type": "string", "format": "date-time" }, "docNumber": { "maxLength": 50, "minLength": 0, "type": "string" }, "amount": { "type": "number", "format": "double" }, "foreignCurrencyId": { "maxLength": 3, "minLength": 0, "type": "string", "nullable": true }, "rate": { "type": "number", "format": "double", "nullable": true }, "discountable": { "type": "boolean" }, "dueDate": { "type": "string", "format": "date-time" }, "cashDiscountDate1": { "type": "string", "format": "date-time", "nullable": true }, "cashDiscountPercentage1": { "type": "number", "format": "double", "nullable": true }, "cashDiscountDate2": { "type": "string", "format": "date-time", "nullable": true }, "cashDiscountPercentage2": { "type": "number", "format": "double", "nullable": true }, "cashDiscountAmount": { "type": "number", "format": "double" }, "openAmount": { "type": "number", "format": "double" }, "remark1": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "remark2": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "referenceDoc": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "contraAccountId": { "type": "integer", "format": "int32", "nullable": true }, "costCenterId": { "type": "integer", "format": "int32", "nullable": true }, "costBearerId": { "type": "integer", "format": "int32", "nullable": true }, "dunningBlock": { "type": "boolean" }, "paymentBlock": { "type": "boolean" }, "dunningLevelId": { "type": "integer", "format": "int32", "nullable": true }, "dunningDate": { "type": "string", "format": "date-time", "nullable": true }, "newDueDate": { "type": "string", "format": "date-time", "nullable": true }, "taxSplit": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "docSplit": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "termsOfPaymentId": { "type": "integer", "format": "int32", "nullable": true }, "archived": { "type": "boolean" }, "probabilityOfPayment": { "type": "number", "format": "double" }, "probableAmount": { "type": "number", "format": "double", "nullable": true }, "foreignCurrencyAmount": { "type": "number", "format": "double", "nullable": true }, "foreignCurrencyCashDiscountAmount": { "type": "number", "format": "double", "nullable": true }, "foreignCurrencyOpenAmount": { "type": "number", "format": "double", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "contraAccount": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountPlan" }, "costBearer": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceCostBearer" }, "costCenter": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceCostCenter" }, "docType": { "$ref": "#/components/schemas/XERP.Shared.Models.DocType" }, "dunningLevel": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceDunningLevel" }, "foreignCurrency": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCurrency" }, "openItemOrigin": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItemOrigin" }, "openItemType": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItemType" }, "partner": { "$ref": "#/components/schemas/XERP.Shared.Models.Partner" }, "partnerDetail": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDetail" }, "partnerType": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerType" }, "posting": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePosting" }, "status": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItemStatus" }, "termsOfPayment": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerTermsOfPayment" }, "financeDunningPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceDunningPosition" }, "nullable": true }, "financeOpenItemInternalReconciliationPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItemInternalReconciliationPosition" }, "nullable": true }, "financePaymentPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePaymentPosition" }, "nullable": true }, "financePostingPositionOpenItems": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPosition" }, "nullable": true }, "financePostingPositionSourceOpenItems": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPosition" }, "nullable": true }, "financeTransferPositionOpenItems": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionOpenItem" }, "nullable": true }, "financeTransferPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPosition" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceOpenItemInternalReconciliation": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "partnerId": { "type": "integer", "format": "int32", "nullable": true }, "partnerDetailId": { "type": "integer", "format": "int32", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "partner": { "$ref": "#/components/schemas/XERP.Shared.Models.Partner" }, "partnerDetail": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDetail" }, "financeOpenItemInternalReconciliationPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItemInternalReconciliationPosition" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceOpenItemInternalReconciliationPosition": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "reconciliationId": { "type": "integer", "format": "int32" }, "reconciliationPosition": { "type": "integer", "format": "int32" }, "openItemId": { "type": "integer", "format": "int32" }, "amount": { "type": "number", "format": "double" }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "openItem": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItem" }, "reconciliation": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItemInternalReconciliation" } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceOpenItemInternalReconciliationPosition_GetReconciliationPositionsRequest": { "type": "object", "properties": { "reconciliationId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceOpenItemInternalReconciliation_GetAttachmentCountRequest": { "type": "object", "properties": { "financeOpenItemInternalReconciliationId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceOpenItemInternalReconciliation_ReconciliationCancellationRequest": { "type": "object", "properties": { "reconciliationId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceOpenItemOrigin": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 8, "minLength": 0, "type": "string", "nullable": true }, "name": { "maxLength": 8, "minLength": 0, "type": "string" }, "financeOpenItems": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItem" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceOpenItemStatus": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 12, "minLength": 0, "type": "string", "nullable": true }, "name": { "maxLength": 12, "minLength": 0, "type": "string" }, "financeOpenItems": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItem" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceOpenItemType": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 2, "minLength": 0, "type": "string", "nullable": true }, "name": { "maxLength": 30, "minLength": 0, "type": "string" }, "financeOpenItems": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItem" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceOpeningBalance": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "info": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "accountantId": { "type": "integer", "format": "int32" }, "personalAccount": { "type": "boolean" }, "partnerTypeId": { "maxLength": 10, "minLength": 0, "type": "string", "nullable": true }, "contraAccountId": { "type": "integer", "format": "int32" }, "receiptNumber": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "receiptDate": { "type": "string", "format": "date-time" }, "postingPeriodId": { "type": "integer", "format": "int32" }, "draft": { "type": "boolean" }, "totalAmount": { "type": "number", "format": "double" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "accountant": { "$ref": "#/components/schemas/XERP.Shared.Models.Employee" }, "contraAccount": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountPlan" }, "partnerType": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerType" }, "postingPeriod": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPeriod" }, "financeOpeningBalancePositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpeningBalancePosition" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceOpeningBalancePosition": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "openingBalanceId": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "partnerDetailId": { "type": "integer", "format": "int32", "nullable": true }, "amount": { "type": "number", "format": "double" }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "account": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountPlan" }, "openingBalance": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpeningBalance" }, "partnerDetail": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDetail" } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceOpeningBalancePosition_DeleteRequest": { "type": "object", "properties": { "financeOpeningBalancePositionId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceOpeningBalancePosition_GetAllFromViewByValueRequest": { "type": "object", "properties": { "propertyName": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceOpeningBalancePosition_InsertAllRequest": { "type": "object", "properties": { "financeOpeningBalanceId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceOpeningBalancePosition_InsertRequest": { "type": "object", "properties": { "financeOpeningBalanceId": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32", "nullable": true }, "partnerDetailId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceOpeningBalancePosition_SaveDraftRequest": { "type": "object", "properties": { "financeOpeningBalanceId": { "type": "integer", "format": "int32" }, "createdBy": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceOpeningBalancePosition_UpdateAmountRequest": { "type": "object", "properties": { "financeOpeningBalancePositionId": { "type": "integer", "format": "int32" }, "amount": { "type": "number", "format": "double" } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceOpeningBalance_CreateNewRequest": { "type": "object", "properties": { "accountantId": { "type": "integer", "format": "int32" }, "contraAccountId": { "type": "integer", "format": "int32" }, "accountType": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceOpeningBalance_DeleteRequest": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceOpeningBalance_UpdateInfoRequest": { "type": "object", "properties": { "financeOpeningBalanceId": { "type": "integer", "format": "int32" }, "info": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceOpeningBalance_UpdatePostingPeriodIdRequest": { "type": "object", "properties": { "financeOpeningBalanceId": { "type": "integer", "format": "int32" }, "postingPeriodId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceOpeningBalance_UpdateReceiptDateRequest": { "type": "object", "properties": { "financeOpeningBalanceId": { "type": "integer", "format": "int32" }, "receiptDate": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceOpeningBalance_UpdateReceiptNumberRequest": { "type": "object", "properties": { "financeOpeningBalanceId": { "type": "integer", "format": "int32" }, "receiptNumber": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FinancePayment": { "required": [ "companyBankAccountId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "paymentDate": { "type": "string", "format": "date-time" }, "directDebitTypeId": { "type": "integer", "format": "int32", "nullable": true }, "companyBankAccountId": { "maxLength": 34, "minLength": 0, "type": "string" }, "amount": { "type": "number", "format": "double" }, "transferred": { "type": "boolean" }, "info": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "companyBankAccount": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceCompanyBankAccount" }, "directDebitType": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDirectDebitType" }, "financePaymentPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePaymentPosition" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FinancePaymentPosition": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "financePaymentId": { "type": "integer", "format": "int32", "nullable": true }, "position": { "type": "integer", "format": "int32" }, "openItemId": { "type": "integer", "format": "int32" }, "amount": { "type": "number", "format": "double" }, "cashDiscountAmount": { "type": "number", "format": "double" }, "purpose": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "bankAccountId": { "type": "integer", "format": "int32", "nullable": true }, "bankNumberId": { "maxLength": 40, "minLength": 0, "type": "string", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "bankAccount": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerBankAccount" }, "bankNumber": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminBank" }, "financePayment": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePayment" }, "openItem": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItem" } }, "additionalProperties": false }, "XERP.Shared.Models.FinancePaymentPosition_CreatePaymentRequest": { "type": "object", "properties": { "paymentDate": { "type": "string", "format": "date-time" }, "companyBankAccountId": { "type": "string", "nullable": true }, "createdById": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.FinancePaymentPosition_RunWizardRequest": { "type": "object", "properties": { "isCustomer": { "type": "boolean" }, "isSupplier": { "type": "boolean" }, "selectedFromCustomerMatchcode": { "type": "string", "nullable": true }, "selectedToCustomerMatchcode": { "type": "string", "nullable": true }, "selectedFromSupplierMatchcode": { "type": "string", "nullable": true }, "selectedToSupplierMatchcode": { "type": "string", "nullable": true }, "isCustomerValueCredits": { "type": "boolean" }, "isCustomerIncomingPayments": { "type": "boolean" }, "isCustomerOutgoingPayments": { "type": "boolean" }, "isSupplierValueCredits": { "type": "boolean" }, "isSupplierIncomingPayments": { "type": "boolean" }, "isSupplierOutgoingPayments": { "type": "boolean" }, "isCashDiscount": { "type": "boolean" }, "dueDate": { "type": "string", "format": "date-time" }, "paymentDate": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "XERP.Shared.Models.FinancePaymentPosition_Sproc_UpdateField": { "type": "object", "properties": { "paymentPositionId": { "type": "integer", "format": "int32" }, "fieldName": { "type": "string", "nullable": true }, "fieldValue": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FinancePosting": { "required": [ "docNumber", "receiptNumber", "statusId", "subject" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "docNumber": { "maxLength": 50, "minLength": 0, "type": "string" }, "statusId": { "maxLength": 12, "minLength": 0, "type": "string" }, "reversalReferenceId": { "type": "integer", "format": "int32", "nullable": true }, "postingTemplateId": { "type": "integer", "format": "int32", "nullable": true }, "receiptNumber": { "maxLength": 50, "minLength": 0, "type": "string" }, "receiptDate": { "type": "string", "format": "date-time" }, "postingPeriodId": { "type": "integer", "format": "int32" }, "subject": { "maxLength": 255, "minLength": 0, "type": "string" }, "batchNumber": { "maxLength": 10, "minLength": 0, "type": "string", "nullable": true }, "sourceId": { "maxLength": 8, "minLength": 0, "type": "string", "nullable": true }, "reversible": { "type": "boolean" }, "opening": { "type": "boolean" }, "closing": { "type": "boolean" }, "fixedAssetId": { "type": "integer", "format": "int32", "nullable": true }, "foreignCurrencyId": { "maxLength": 3, "minLength": 0, "type": "string", "nullable": true }, "rate": { "type": "number", "format": "double", "nullable": true }, "exportDate": { "type": "string", "format": "date-time", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "fixedAsset": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAsset" }, "foreignCurrency": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCurrency" }, "postingPeriod": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPeriod" }, "postingTemplate": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingTemplate" }, "reversalReference": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePosting" }, "source": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingSource" }, "status": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingStatus" }, "countryPackageOssProcedureFinancePosting": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageOssProcedureFinancePosting" }, "financeFixedAssetDepreciationPlans": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDepreciationPlan" }, "nullable": true }, "financeOpenItems": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItem" }, "nullable": true }, "financePostingPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPosition" }, "nullable": true }, "inverseReversalReference": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePosting" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FinancePostingDraft": { "required": [ "statusId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "docNumber": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "statusId": { "maxLength": 12, "minLength": 0, "type": "string" }, "reversalReferenceId": { "type": "integer", "format": "int32", "nullable": true }, "postingTemplateId": { "type": "integer", "format": "int32", "nullable": true }, "receiptNumber": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "receiptDate": { "type": "string", "format": "date-time" }, "postingPeriodId": { "type": "integer", "format": "int32", "nullable": true }, "subject": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "batchNumber": { "maxLength": 10, "minLength": 0, "type": "string", "nullable": true }, "sourceId": { "maxLength": 8, "minLength": 0, "type": "string", "nullable": true }, "reversible": { "type": "boolean" }, "fixedAssetId": { "type": "integer", "format": "int32", "nullable": true }, "foreignCurrencyId": { "maxLength": 3, "minLength": 0, "type": "string", "nullable": true }, "rate": { "type": "number", "format": "double", "nullable": true }, "exportDate": { "type": "string", "format": "date-time", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "fixedAsset": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAsset" }, "foreignCurrency": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCurrency" }, "postingPeriod": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPeriod" }, "postingTemplate": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingTemplate" }, "source": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingSource" }, "status": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingStatus" }, "financePostingPositionDrafts": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionDraft" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FinancePostingDraft_CheckNegativeBalanceRequest": { "type": "object", "properties": { "financePostingDraftId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.FinancePostingDraft_CheckNegativeBalanceResult": { "type": "object", "properties": { "wouldGoNegative": { "type": "boolean" }, "accountNames": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FinancePostingDraft_GetAttachmentCountRequest": { "type": "object", "properties": { "financePostingId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.FinancePostingDraft_PostRequest": { "type": "object", "properties": { "financePostingDraftId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.FinancePostingDraft_PostingReversalRequest": { "type": "object", "properties": { "postingId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.FinancePostingDraft_SwapDebitCreditRequest": { "type": "object", "properties": { "financePostingDraftId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.FinancePostingDraft_UpdateDocNumberRequest": { "type": "object", "properties": { "financePostingDraftId": { "type": "integer", "format": "int32" }, "docNumber": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FinancePostingDraft_UpdateForeignCurrencyIdRequest": { "type": "object", "properties": { "financePostingDraftId": { "type": "integer", "format": "int32" }, "foreignCurrencyId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FinancePostingDraft_UpdateNameRequest": { "type": "object", "properties": { "financePostingDraftId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FinancePostingDraft_UpdatePostingPeriodIdRequest": { "type": "object", "properties": { "financePostingDraftId": { "type": "integer", "format": "int32" }, "postingPeriodId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.FinancePostingDraft_UpdateRateRequest": { "type": "object", "properties": { "financePostingDraftId": { "type": "integer", "format": "int32" }, "rate": { "type": "number", "format": "double" } }, "additionalProperties": false }, "XERP.Shared.Models.FinancePostingDraft_UpdateReceiptDateRequest": { "type": "object", "properties": { "financePostingDraftId": { "type": "integer", "format": "int32" }, "receiptDate": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "XERP.Shared.Models.FinancePostingDraft_UpdateReceiptNumberRequest": { "type": "object", "properties": { "financePostingDraftId": { "type": "integer", "format": "int32" }, "receiptNumber": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FinancePostingDraft_UpdateSubjectRequest": { "type": "object", "properties": { "financePostingDraftId": { "type": "integer", "format": "int32" }, "subject": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FinancePostingPeriod": { "required": [ "name", "statusId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "fiscalYearPeriod": { "type": "integer", "format": "int32", "nullable": true }, "name": { "maxLength": 30, "minLength": 0, "type": "string" }, "fiscalYearId": { "type": "integer", "format": "int32" }, "fiscalPeriodId": { "type": "integer", "format": "int32" }, "calendarYearId": { "type": "integer", "format": "int32" }, "calendarMonthId": { "type": "integer", "format": "int32" }, "statusId": { "maxLength": 6, "minLength": 0, "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "calendarMonth": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminMonth" }, "calendarYear": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminYear" }, "fiscalPeriod": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminFiscalPeriod" }, "fiscalYear": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminYear" }, "status": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPeriodStatus" }, "countryPackageDatevExports": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageDatevExport" }, "nullable": true }, "docXmls": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXml" }, "nullable": true }, "docs": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc" }, "nullable": true }, "financeClosingPostingClosingPostingPeriods": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceClosingPosting" }, "nullable": true }, "financeClosingPostingOpeningPostingPeriods": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceClosingPosting" }, "nullable": true }, "financeFixedAssetDepreciationPlans": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAssetDepreciationPlan" }, "nullable": true }, "financeOpeningBalances": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpeningBalance" }, "nullable": true }, "financePostingDrafts": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingDraft" }, "nullable": true }, "financePostingTemplates": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingTemplate" }, "nullable": true }, "financePostings": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePosting" }, "nullable": true }, "financeTransferPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPosition" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FinancePostingPeriodStatus": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 6, "minLength": 0, "type": "string", "nullable": true }, "name": { "maxLength": 20, "minLength": 0, "type": "string" }, "financePostingPeriods": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPeriod" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FinancePostingPosition": { "required": [ "accountName", "statusId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "accountPlanTaxCodeFix": { "type": "boolean" }, "isValid": { "type": "boolean" }, "id": { "type": "integer", "format": "int32" }, "postingId": { "type": "integer", "format": "int32" }, "position": { "type": "integer", "format": "int32" }, "parentPosition": { "type": "integer", "format": "int32", "nullable": true }, "statusId": { "maxLength": 12, "minLength": 0, "type": "string" }, "reversalReferencePositionId": { "type": "integer", "format": "int32", "nullable": true }, "accountId": { "type": "integer", "format": "int32" }, "postingPositionAccountTypeId": { "type": "integer", "format": "int32" }, "accountName": { "maxLength": 200, "minLength": 0, "type": "string" }, "openItemId": { "type": "integer", "format": "int32", "nullable": true }, "debit": { "type": "number", "format": "double" }, "credit": { "type": "number", "format": "double" }, "contraAccountId": { "type": "integer", "format": "int32", "nullable": true }, "partnerDetailId": { "type": "integer", "format": "int32", "nullable": true }, "businessPartnerNumber": { "type": "integer", "format": "int32", "nullable": true }, "grossValue": { "type": "number", "format": "double" }, "divergentPerformanceDate": { "type": "string", "format": "date-time", "nullable": true }, "taxKeyId": { "maxLength": 3, "minLength": 0, "type": "string", "nullable": true }, "taxPercent": { "type": "number", "format": "double", "nullable": true }, "taxAmount": { "type": "number", "format": "double" }, "costCenterId": { "type": "integer", "format": "int32", "nullable": true }, "costBearerId": { "type": "integer", "format": "int32", "nullable": true }, "openAmount": { "type": "number", "format": "double" }, "vatNumber": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "projectId": { "type": "integer", "format": "int32", "nullable": true }, "sourceOpenItemId": { "type": "integer", "format": "int32", "nullable": true }, "foreignCurrencyDebit": { "type": "number", "format": "double", "nullable": true }, "foreignCurrencyCredit": { "type": "number", "format": "double", "nullable": true }, "foreignCurrencyGrossValue": { "type": "number", "format": "double", "nullable": true }, "foreignCurrencyOpenAmount": { "type": "number", "format": "double", "nullable": true }, "foreignCurrencyTaxAmount": { "type": "number", "format": "double", "nullable": true }, "archived": { "type": "boolean" }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "account": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountPlan" }, "contraAccount": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountPlan" }, "costBearer": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceCostBearer" }, "costCenter": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceCostCenter" }, "openItem": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItem" }, "partnerDetail": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDetail" }, "posting": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePosting" }, "postingPositionAccountType": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionAccountType" }, "project": { "$ref": "#/components/schemas/XERP.Shared.Models.Project" }, "reversalReferencePosition": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPosition" }, "sourceOpenItem": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItem" }, "status": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingStatus" }, "taxKey": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTaxKey" }, "financeAccountInternalReconciliationPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountInternalReconciliationPosition" }, "nullable": true }, "inverseReversalReferencePosition": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPosition" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FinancePostingPositionAccountType": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 15, "minLength": 0, "type": "string" }, "financePostingPositionDrafts": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionDraft" }, "nullable": true }, "financePostingPositionTemplates": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionTemplate" }, "nullable": true }, "financePostingPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPosition" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FinancePostingPositionDraft": { "required": [ "accountName", "statusId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "postingId": { "type": "integer", "format": "int32" }, "position": { "type": "integer", "format": "int32" }, "parentPosition": { "type": "integer", "format": "int32", "nullable": true }, "statusId": { "maxLength": 12, "minLength": 0, "type": "string" }, "reversalReferencePositionId": { "type": "integer", "format": "int32", "nullable": true }, "accountId": { "type": "integer", "format": "int32" }, "postingPositionAccountTypeId": { "type": "integer", "format": "int32" }, "accountName": { "maxLength": 200, "minLength": 0, "type": "string" }, "openItemId": { "type": "integer", "format": "int32", "nullable": true }, "debit": { "type": "number", "format": "double" }, "credit": { "type": "number", "format": "double" }, "contraAccountId": { "type": "integer", "format": "int32", "nullable": true }, "partnerDetailId": { "type": "integer", "format": "int32", "nullable": true }, "businessPartnerNumber": { "type": "integer", "format": "int32", "nullable": true }, "grossValue": { "type": "number", "format": "double" }, "divergentPerformanceDate": { "type": "string", "format": "date-time", "nullable": true }, "taxKeyId": { "maxLength": 3, "minLength": 0, "type": "string", "nullable": true }, "taxPercent": { "type": "number", "format": "double", "nullable": true }, "taxAmount": { "type": "number", "format": "double" }, "costCenterId": { "type": "integer", "format": "int32", "nullable": true }, "costBearerId": { "type": "integer", "format": "int32", "nullable": true }, "openAmount": { "type": "number", "format": "double" }, "vatNumber": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "projectId": { "type": "integer", "format": "int32", "nullable": true }, "foreignCurrencyDebit": { "type": "number", "format": "double", "nullable": true }, "foreignCurrencyCredit": { "type": "number", "format": "double", "nullable": true }, "foreignCurrencyGrossValue": { "type": "number", "format": "double", "nullable": true }, "foreignCurrencyOpenAmount": { "type": "number", "format": "double", "nullable": true }, "foreignCurrencyTaxAmount": { "type": "number", "format": "double", "nullable": true }, "archived": { "type": "boolean" }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "account": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountPlan" }, "contraAccount": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountPlan" }, "costBearer": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceCostBearer" }, "costCenter": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceCostCenter" }, "partnerDetail": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDetail" }, "posting": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingDraft" }, "postingPositionAccountType": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionAccountType" }, "project": { "$ref": "#/components/schemas/XERP.Shared.Models.Project" }, "status": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingStatus" }, "taxKey": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTaxKey" } }, "additionalProperties": false }, "XERP.Shared.Models.FinancePostingPositionDraft_AddGeneralLedgerAccountRequest": { "type": "object", "properties": { "financePostingDraftId": { "type": "integer", "format": "int32" }, "financeAccountPlanId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.FinancePostingPositionDraft_AddPersonalAccountRequest": { "type": "object", "properties": { "financePostingDraftId": { "type": "integer", "format": "int32" }, "partnerDetailId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.FinancePostingPositionDraft_DeleteRequest": { "type": "object", "properties": { "financePostingPositionDraftId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.FinancePostingPositionDraft_UpdateCostBearerIdRequest": { "type": "object", "properties": { "financePostingPositionDraftId": { "type": "integer", "format": "int32" }, "costBearerId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FinancePostingPositionDraft_UpdateCostCenterIdRequest": { "type": "object", "properties": { "financePostingPositionDraftId": { "type": "integer", "format": "int32" }, "costCenterId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FinancePostingPositionDraft_UpdateCreditRequest": { "type": "object", "properties": { "financePostingPositionDraftId": { "type": "integer", "format": "int32" }, "credit": { "type": "number", "format": "double" } }, "additionalProperties": false }, "XERP.Shared.Models.FinancePostingPositionDraft_UpdateDebitRequest": { "type": "object", "properties": { "financePostingPositionDraftId": { "type": "integer", "format": "int32" }, "debit": { "type": "number", "format": "double" } }, "additionalProperties": false }, "XERP.Shared.Models.FinancePostingPositionDraft_UpdateForeignCurrencyCreditRequest": { "type": "object", "properties": { "financePostingPositionDraftId": { "type": "integer", "format": "int32" }, "foreignCurrencyCredit": { "type": "number", "format": "double" } }, "additionalProperties": false }, "XERP.Shared.Models.FinancePostingPositionDraft_UpdateForeignCurrencyDebitRequest": { "type": "object", "properties": { "financePostingPositionDraftId": { "type": "integer", "format": "int32" }, "foreignCurrencyDebit": { "type": "number", "format": "double" } }, "additionalProperties": false }, "XERP.Shared.Models.FinancePostingPositionDraft_UpdateForeignCurrencyGrossValueRequest": { "type": "object", "properties": { "financePostingPositionDraftId": { "type": "integer", "format": "int32" }, "foreignCurrencyGrossValue": { "type": "number", "format": "double" } }, "additionalProperties": false }, "XERP.Shared.Models.FinancePostingPositionDraft_UpdateGrossValueRequest": { "type": "object", "properties": { "financePostingPositionDraftId": { "type": "integer", "format": "int32" }, "grossValue": { "type": "number", "format": "double" } }, "additionalProperties": false }, "XERP.Shared.Models.FinancePostingPositionDraft_UpdateProjectIdRequest": { "type": "object", "properties": { "financePostingPositionDraftId": { "type": "integer", "format": "int32" }, "projectId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.FinancePostingPositionDraft_UpdateTaxKeyIdRequest": { "type": "object", "properties": { "financePostingPositionDraftId": { "type": "integer", "format": "int32" }, "taxKeyId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FinancePostingPositionDraft_UpdateVatNumberRequest": { "type": "object", "properties": { "financePostingPositionDraftId": { "type": "integer", "format": "int32" }, "vatNumber": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FinancePostingPositionTemplate": { "required": [ "accountName", "statusId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "isValid": { "type": "boolean" }, "id": { "type": "integer", "format": "int32" }, "postingTemplateId": { "type": "integer", "format": "int32" }, "position": { "type": "integer", "format": "int32" }, "parentPosition": { "type": "integer", "format": "int32", "nullable": true }, "statusId": { "maxLength": 12, "minLength": 0, "type": "string" }, "reversalReferencePositionId": { "type": "integer", "format": "int32", "nullable": true }, "accountId": { "type": "integer", "format": "int32" }, "postingPositionAccountTypeId": { "type": "integer", "format": "int32" }, "accountName": { "maxLength": 200, "minLength": 0, "type": "string" }, "openItemId": { "type": "integer", "format": "int32", "nullable": true }, "debit": { "type": "number", "format": "double" }, "credit": { "type": "number", "format": "double" }, "contraAccountId": { "type": "integer", "format": "int32", "nullable": true }, "partnerDetailId": { "type": "integer", "format": "int32", "nullable": true }, "businessPartnerNumber": { "type": "integer", "format": "int32", "nullable": true }, "grossValue": { "type": "number", "format": "double" }, "divergentPerformanceDate": { "type": "string", "format": "date-time", "nullable": true }, "taxKeyId": { "maxLength": 3, "minLength": 0, "type": "string", "nullable": true }, "taxPercent": { "type": "number", "format": "double", "nullable": true }, "taxAmount": { "type": "number", "format": "double" }, "costCenterId": { "type": "integer", "format": "int32", "nullable": true }, "costBearerId": { "type": "integer", "format": "int32", "nullable": true }, "openAmount": { "type": "number", "format": "double" }, "vatNumber": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "projectId": { "type": "integer", "format": "int32", "nullable": true }, "sourceOpenItemId": { "type": "integer", "format": "int32", "nullable": true }, "foreignCurrencyDebit": { "type": "number", "format": "double", "nullable": true }, "foreignCurrencyCredit": { "type": "number", "format": "double", "nullable": true }, "foreignCurrencyGrossValue": { "type": "number", "format": "double", "nullable": true }, "foreignCurrencyOpenAmount": { "type": "number", "format": "double", "nullable": true }, "foreignCurrencyTaxAmount": { "type": "number", "format": "double", "nullable": true }, "archived": { "type": "boolean" }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "account": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountPlan" }, "contraAccount": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountPlan" }, "costBearer": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceCostBearer" }, "costCenter": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceCostCenter" }, "partnerDetail": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDetail" }, "postingPositionAccountType": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionAccountType" }, "postingTemplate": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingTemplate" }, "project": { "$ref": "#/components/schemas/XERP.Shared.Models.Project" }, "status": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingStatus" }, "taxKey": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTaxKey" } }, "additionalProperties": false }, "XERP.Shared.Models.FinancePostingSource": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 8, "minLength": 0, "type": "string", "nullable": true }, "name": { "maxLength": 20, "minLength": 0, "type": "string" }, "financePostingDrafts": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingDraft" }, "nullable": true }, "financePostings": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePosting" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FinancePostingStatus": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 12, "minLength": 0, "type": "string", "nullable": true }, "name": { "maxLength": 12, "minLength": 0, "type": "string" }, "financePostingDrafts": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingDraft" }, "nullable": true }, "financePostingPositionDrafts": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionDraft" }, "nullable": true }, "financePostingPositionTemplates": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionTemplate" }, "nullable": true }, "financePostingPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPosition" }, "nullable": true }, "financePostings": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePosting" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FinancePostingTemplate": { "required": [ "statusId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "docNumber": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "statusId": { "maxLength": 12, "minLength": 0, "type": "string" }, "reversalReferenceId": { "type": "integer", "format": "int32", "nullable": true }, "postingTemplateId": { "type": "integer", "format": "int32", "nullable": true }, "receiptNumber": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "receiptDate": { "type": "string", "format": "date-time" }, "postingPeriodId": { "type": "integer", "format": "int32", "nullable": true }, "subject": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "batchNumber": { "maxLength": 10, "minLength": 0, "type": "string", "nullable": true }, "sourceId": { "maxLength": 8, "minLength": 0, "type": "string", "nullable": true }, "reversible": { "type": "boolean" }, "foreignCurrencyId": { "maxLength": 3, "minLength": 0, "type": "string", "nullable": true }, "fixedAssetId": { "type": "integer", "format": "int32", "nullable": true }, "rate": { "type": "number", "format": "double", "nullable": true }, "exportDate": { "type": "string", "format": "date-time", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "fixedAsset": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAsset" }, "foreignCurrency": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCurrency" }, "postingPeriod": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPeriod" }, "financePostingDrafts": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingDraft" }, "nullable": true }, "financePostingPositionTemplates": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionTemplate" }, "nullable": true }, "financePostings": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePosting" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FinancePosting_GetAttachmentCountRequest": { "type": "object", "properties": { "financePostingId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.FinancePosting_PostingReversalRequest": { "type": "object", "properties": { "postingId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceProfitLossGroup": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 255, "minLength": 0, "type": "string" }, "level": { "type": "integer", "format": "int32" }, "parentId": { "type": "integer", "format": "int32", "nullable": true }, "sortOrder": { "type": "integer", "format": "int32" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "parent": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceProfitLossGroup" }, "financeAccountPlans": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountPlan" }, "nullable": true }, "inverseParent": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceProfitLossGroup" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceTaxKey": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "taxKeyIdAndName": { "type": "string", "nullable": true, "readOnly": true }, "id": { "maxLength": 3, "minLength": 0, "type": "string", "nullable": true }, "name": { "maxLength": 100, "minLength": 0, "type": "string" }, "taxKeyKindId": { "type": "integer", "format": "int32" }, "vatNumberRequired": { "type": "boolean" }, "eInvoiceTaxKeyCategoryId": { "maxLength": 2, "minLength": 0, "type": "string", "nullable": true }, "countryId": { "maxLength": 2, "minLength": 0, "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "country": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCountry" }, "eInvoiceTaxKeyCategory": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceEInvoiceTaxKeyCategory" }, "taxKeyKind": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTaxKeyKind" }, "countryPackageDatevAccountNumber": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageDatevAccountNumber" }, "docPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition" }, "nullable": true }, "docXmlPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXmlPosition" }, "nullable": true }, "financeAccountPlans": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountPlan" }, "nullable": true }, "financeFixedAssets": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceFixedAsset" }, "nullable": true }, "financeGroupArticleDetails": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceGroupArticleDetail" }, "nullable": true }, "financePostingPositionDrafts": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionDraft" }, "nullable": true }, "financePostingPositionTemplates": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionTemplate" }, "nullable": true }, "financePostingPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPosition" }, "nullable": true }, "financeTaxKeyDetails": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTaxKeyDetail" }, "nullable": true }, "financeTransferCategories": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferCategory" }, "nullable": true }, "financeTransferPositionAccountPlans": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionAccountPlan" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceTaxKeyDetail": { "required": [ "taxKeyId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "taxKeyId": { "maxLength": 3, "minLength": 0, "type": "string" }, "validFrom": { "type": "string", "format": "date-time" }, "taxPercent": { "type": "number", "format": "double" }, "taxAccountId": { "type": "integer", "format": "int32", "nullable": true }, "cashDiscountAccountId": { "type": "integer", "format": "int32", "nullable": true }, "notDueAccountId": { "type": "integer", "format": "int32", "nullable": true }, "rate": { "type": "number", "format": "double" }, "exportKey": { "maxLength": 10, "minLength": 0, "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "cashDiscountAccount": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountPlan" }, "notDueAccount": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountPlan" }, "taxAccount": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountPlan" }, "taxKey": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTaxKey" }, "countryPackageDatevTaxKeyDetail": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageDatevTaxKeyDetail" } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceTaxKeyDetail_GetTaxRateRequest": { "type": "object", "properties": { "forDate": { "type": "string", "format": "date-time" }, "taxKeyId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceTaxKeyKind": { "required": [ "taxKind" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "taxKind": { "maxLength": 20, "minLength": 0, "type": "string" }, "additionalPosition": { "type": "integer", "format": "int32" }, "parentSidePos1": { "type": "boolean" }, "parentSidePos2": { "type": "boolean" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "financeTaxKeys": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTaxKey" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceTransfer": { "required": [ "companyBankAccountId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "draft": { "type": "boolean" }, "companyBankAccountId": { "maxLength": 34, "minLength": 0, "type": "string" }, "receiptNumber": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "receiptDate": { "type": "string", "format": "date-time" }, "generalLedgerAccountId": { "type": "integer", "format": "int32", "nullable": true }, "interimAccountId": { "type": "integer", "format": "int32", "nullable": true }, "foreignCurrencyId": { "maxLength": 3, "minLength": 0, "type": "string", "nullable": true }, "beginningBalance": { "type": "number", "format": "double", "nullable": true }, "endingBalance": { "type": "number", "format": "double", "nullable": true }, "manually": { "type": "boolean" }, "mappingFormatNameId": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "companyBankAccount": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceCompanyBankAccount" }, "foreignCurrency": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCurrency" }, "generalLedgerAccount": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountPlan" }, "interimAccount": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountPlan" }, "mappingFormatName": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemMappingFormatName" }, "financeTransferBankStatement": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferBankStatement" }, "financeTransferPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPosition" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceTransferBankStatement": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "financeTransferId": { "type": "integer", "format": "int32" }, "computerFile": { "type": "string", "format": "byte", "nullable": true }, "fileName": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "contentType": { "maxLength": 75, "minLength": 0, "type": "string", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "financeTransfer": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransfer" } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceTransferCategory": { "required": [ "accountTypeId", "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 50, "minLength": 0, "type": "string" }, "subject": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "accountTypeId": { "maxLength": 14, "minLength": 0, "type": "string" }, "generalLedgerAccountId": { "type": "integer", "format": "int32", "nullable": true }, "taxKeyId": { "maxLength": 3, "minLength": 0, "type": "string", "nullable": true }, "partnerDetailId": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "accountType": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferCategoryAccountType" }, "generalLedgerAccount": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountPlan" }, "partnerDetail": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDetail" }, "taxKey": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTaxKey" }, "financeTransferPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPosition" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceTransferCategoryAccountType": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 14, "minLength": 0, "type": "string", "nullable": true }, "name": { "maxLength": 14, "minLength": 0, "type": "string" }, "financeTransferCategories": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferCategory" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceTransferPosition": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "isValid": { "type": "boolean" }, "id": { "type": "integer", "format": "int32" }, "transferId": { "type": "integer", "format": "int32" }, "subject": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "statementID": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "position": { "type": "integer", "format": "int32" }, "postingPeriodId": { "type": "integer", "format": "int32", "nullable": true }, "entryReference": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "messageID": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "amount": { "type": "number", "format": "double", "nullable": true }, "foreignCurrencyAmount": { "type": "number", "format": "double", "nullable": true }, "rate": { "type": "number", "format": "double", "nullable": true }, "balance": { "type": "number", "format": "double", "nullable": true }, "charge": { "type": "number", "format": "double", "nullable": true }, "interest": { "type": "number", "format": "double", "nullable": true }, "accountId": { "type": "integer", "format": "int32", "nullable": true }, "debitSide": { "type": "boolean" }, "statementDate": { "type": "string", "format": "date-time", "nullable": true }, "valueDate": { "type": "string", "format": "date-time", "nullable": true }, "categoryName": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "transferCategoryId": { "type": "integer", "format": "int32", "nullable": true }, "transactionType": { "maxLength": 10, "minLength": 0, "type": "string", "nullable": true }, "textKeyId": { "type": "integer", "format": "int32", "nullable": true }, "memo1": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "memo2": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "memo3": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "memo4": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "memo5": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "memo6": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "memo7": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "memo8": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "memo9": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "memo10": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "memo11": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "memo12": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "memo13": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "memo14": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "mandateReference": { "maxLength": 35, "minLength": 0, "type": "string", "nullable": true }, "name": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "customerPartnerDetailId": { "type": "integer", "format": "int32", "nullable": true }, "supplierPartnerDetailId": { "type": "integer", "format": "int32", "nullable": true }, "openItemReference": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "openItemId": { "type": "integer", "format": "int32", "nullable": true }, "email": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "payPalArt": { "maxLength": 80, "minLength": 0, "type": "string", "nullable": true }, "payPalStatus": { "maxLength": 80, "minLength": 0, "type": "string", "nullable": true }, "reference": { "maxLength": 40, "minLength": 0, "type": "string", "nullable": true }, "bankTransactionCode": { "maxLength": 40, "minLength": 0, "type": "string", "nullable": true }, "xmlLevel": { "type": "integer", "format": "int32", "nullable": true }, "msgId": { "maxLength": 35, "minLength": 0, "type": "string", "nullable": true }, "endToEndId": { "maxLength": 35, "minLength": 0, "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "account": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountPlan" }, "customerPartnerDetail": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDetail" }, "openItem": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItem" }, "postingPeriod": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPeriod" }, "supplierPartnerDetail": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDetail" }, "transfer": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransfer" }, "transferCategory": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferCategory" }, "financeTransferPositionAccountPlans": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionAccountPlan" }, "nullable": true }, "financeTransferPositionOpenItems": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionOpenItem" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceTransferPositionAccountPlan": { "required": [ "accountName" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "transferPositionId": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "accountName": { "maxLength": 200, "minLength": 0, "type": "string" }, "partnerDetailId": { "type": "integer", "format": "int32", "nullable": true }, "amount": { "type": "number", "format": "double" }, "taxKeyId": { "maxLength": 3, "minLength": 0, "type": "string", "nullable": true }, "costCenterId": { "type": "integer", "format": "int32", "nullable": true }, "costBearerId": { "type": "integer", "format": "int32", "nullable": true }, "projectId": { "type": "integer", "format": "int32", "nullable": true }, "foreignCurrencyAmount": { "type": "number", "format": "double", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "account": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountPlan" }, "costBearer": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceCostBearer" }, "costCenter": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceCostCenter" }, "partnerDetail": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDetail" }, "project": { "$ref": "#/components/schemas/XERP.Shared.Models.Project" }, "taxKey": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTaxKey" }, "transferPosition": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPosition" } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceTransferPositionAccountPlan_DeleteRequest": { "type": "object", "properties": { "financeTransferPositionAccountPlanId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceTransferPositionAccountPlan_GetAllFromViewByValueRequest": { "type": "object", "properties": { "propertyName": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceTransferPositionAccountPlan_InsertGeneralLedgerAccountRequest": { "type": "object", "properties": { "transferPositionId": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceTransferPositionAccountPlan_InsertPersonalAccountRequest": { "type": "object", "properties": { "transferPositionId": { "type": "integer", "format": "int32" }, "partnerDetailId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceTransferPositionAccountPlan_UpdateAmountRequest": { "type": "object", "properties": { "financeTransferPositionAccountPlanId": { "type": "integer", "format": "int32" }, "amount": { "type": "number", "format": "double" } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceTransferPositionAccountPlan_UpdateForeignCurrencyAmountRequest": { "type": "object", "properties": { "financeTransferPositionAccountPlanId": { "type": "integer", "format": "int32" }, "foreignCurrencyAmount": { "type": "number", "format": "double" } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceTransferPositionAccountPlan_UpdateTaxKeyIdRequest": { "type": "object", "properties": { "financeTransferPositionAccountPlanId": { "type": "integer", "format": "int32" }, "taxKeyId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceTransferPositionOpenItem": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "transferPositionId": { "type": "integer", "format": "int32" }, "openItemId": { "type": "integer", "format": "int32" }, "previouslyOpen": { "type": "number", "format": "double" }, "paymentAmount": { "type": "number", "format": "double" }, "cashDiscountAmount": { "type": "number", "format": "double" }, "applicablePercent": { "type": "number", "format": "double" }, "permissibleAmount": { "type": "number", "format": "double" }, "remaining": { "type": "number", "format": "double" }, "foreignCurrencyPaymentAmount": { "type": "number", "format": "double", "nullable": true }, "foreignCurrencyCashDiscountAmount": { "type": "number", "format": "double", "nullable": true }, "foreignCurrencyPermissibleAmount": { "type": "number", "format": "double", "nullable": true }, "foreignCurrencyRemaining": { "type": "number", "format": "double", "nullable": true }, "currencyDifference": { "type": "number", "format": "double", "nullable": true }, "currencyDifferenceAccountId": { "type": "integer", "format": "int32", "nullable": true }, "currencyDifferenceSubject": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "currencyDifferenceAccount": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountPlan" }, "openItem": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItem" }, "transferPosition": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPosition" } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceTransferPositionOpenItem_DeleteRequest": { "type": "object", "properties": { "financeTransferPositionOpenItemId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceTransferPositionOpenItem_GetAllFromViewByValueRequest": { "type": "object", "properties": { "propertyName": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceTransferPositionOpenItem_InsertRequest": { "type": "object", "properties": { "transferPositionId": { "type": "integer", "format": "int32" }, "openItemId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceTransferPositionOpenItem_UpdateAmountRequest": { "type": "object", "properties": { "financeTransferPositionOpenItemId": { "type": "integer", "format": "int32" }, "amount": { "type": "number", "format": "double" } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceTransferPositionOpenItem_UpdateCashDiscountAmountRequest": { "type": "object", "properties": { "financeTransferPositionOpenItemId": { "type": "integer", "format": "int32" }, "cashDiscountAmount": { "type": "number", "format": "double" } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceTransferPositionOpenItem_UpdateCurrencyDifferenceAccountIdRequest": { "type": "object", "properties": { "financeTransferPositionOpenItemId": { "type": "integer", "format": "int32" }, "currencyDifferenceAccountId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceTransferPositionOpenItem_UpdateCurrencyDifferenceRequest": { "type": "object", "properties": { "financeTransferPositionOpenItemId": { "type": "integer", "format": "int32" }, "currencyDifference": { "type": "number", "format": "double" } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceTransferPositionOpenItem_UpdateCurrencyDifferenceSubjectRequest": { "type": "object", "properties": { "financeTransferPositionOpenItemId": { "type": "integer", "format": "int32" }, "currencyDifferenceSubject": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceTransferPositionOpenItem_UpdateForeignCurrencyCashDiscountAmountRequest": { "type": "object", "properties": { "financeTransferPositionOpenItemId": { "type": "integer", "format": "int32" }, "foreignCurrencyCashDiscountAmount": { "type": "number", "format": "double" } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceTransferPositionOpenItem_UpdateForeignCurrencyPaymentAmountRequest": { "type": "object", "properties": { "financeTransferPositionOpenItemId": { "type": "integer", "format": "int32" }, "foreignCurrencyPaymentAmount": { "type": "number", "format": "double" } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceTransferPositionTextKey": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "text": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceTransferPosition_DeletePositionRequest": { "type": "object", "properties": { "financeTransferPositionId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceTransferPosition_GetAllFromViewByValueRequest": { "type": "object", "properties": { "propertyName": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceTransferPosition_ImportRequest": { "type": "object", "properties": { "financeTransferId": { "type": "integer", "format": "int32" }, "xmlContent": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceTransferPosition_InsertPositionRequest": { "type": "object", "properties": { "financeTransferId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceTransferPosition_UpdateAccountIdRequest": { "type": "object", "properties": { "financeTransferPositionId": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceTransferPosition_UpdateAmountRequest": { "type": "object", "properties": { "financeTransferPositionId": { "type": "integer", "format": "int32" }, "amount": { "type": "number", "format": "double" } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceTransferPosition_UpdateCustomerIdRequest": { "type": "object", "properties": { "financeTransferPositionId": { "type": "integer", "format": "int32" }, "customerId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceTransferPosition_UpdateForeignCurrencyAmountRequest": { "type": "object", "properties": { "financeTransferPositionId": { "type": "integer", "format": "int32" }, "foreignCurrencyAmount": { "type": "number", "format": "double" } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceTransferPosition_UpdateMemo1Request": { "type": "object", "properties": { "financeTransferPositionId": { "type": "integer", "format": "int32" }, "memo1": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceTransferPosition_UpdateNameRequest": { "type": "object", "properties": { "financeTransferPositionId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceTransferPosition_UpdatePostingPeriodIdRequest": { "type": "object", "properties": { "financeTransferPositionId": { "type": "integer", "format": "int32" }, "postingPeriodId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceTransferPosition_UpdateRateRequest": { "type": "object", "properties": { "financeTransferPositionId": { "type": "integer", "format": "int32" }, "rate": { "type": "number", "format": "double" } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceTransferPosition_UpdateStatementDateRequest": { "type": "object", "properties": { "financeTransferPositionId": { "type": "integer", "format": "int32" }, "statementDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceTransferPosition_UpdateSupplierIdRequest": { "type": "object", "properties": { "financeTransferPositionId": { "type": "integer", "format": "int32" }, "supplierId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceTransferSuggestion": { "required": [ "suggestionFieldId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "suggestionFieldId": { "maxLength": 10, "minLength": 0, "type": "string" }, "accountId": { "type": "integer", "format": "int32", "nullable": true }, "customerPartnerDetailId": { "type": "integer", "format": "int32", "nullable": true }, "supplierPartnerDetailId": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "account": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountPlan" }, "customerPartnerDetail": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDetail" }, "suggestionField": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferSuggestionField" }, "supplierPartnerDetail": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDetail" } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceTransferSuggestionField": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 10, "minLength": 0, "type": "string", "nullable": true }, "name": { "maxLength": 20, "minLength": 0, "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "financeTransferSuggestions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferSuggestion" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceTransfer_CheckNegativeBalanceRequest": { "type": "object", "properties": { "financeTransferId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceTransfer_CheckNegativeBalanceResult": { "type": "object", "properties": { "wouldGoNegative": { "type": "boolean" }, "accountNames": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceTransfer_CreateNewRequest": { "type": "object", "properties": { "companyBankAccountId": { "type": "string", "nullable": true }, "selectedManually": { "type": "boolean" } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceTransfer_GetAttachmentCountRequest": { "type": "object", "properties": { "financeTransferId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceTransfer_PostTransferRequest": { "type": "object", "properties": { "financeTransferId": { "type": "integer", "format": "int32" }, "createdById": { "type": "integer", "format": "int32" }, "acceptBalanceMismatch": { "type": "boolean" } }, "additionalProperties": false }, "XERP.Shared.Models.FinanceTransfer_SuggestRequest": { "type": "object", "properties": { "financeTransferId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.ForeignCurrencyPriceResult": { "type": "object", "properties": { "newPrice": { "type": "number", "format": "double" } }, "additionalProperties": false }, "XERP.Shared.Models.FormattedSearch": { "required": [ "sourceValueSelectStatement", "targetAuthorizationPageId", "targetSystemTableId", "triggerFireModeId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 128, "minLength": 0, "type": "string", "nullable": true }, "sourceValueSelectStatement": { "minLength": 1, "type": "string" }, "targetSystemTableId": { "maxLength": 50, "minLength": 0, "type": "string" }, "targetSystemTableFieldId": { "type": "integer", "format": "int32" }, "triggerFireModeId": { "maxLength": 6, "minLength": 0, "type": "string" }, "updateTriggerFieldId": { "type": "integer", "format": "int32", "nullable": true }, "targetAuthorizationPageId": { "maxLength": 100, "minLength": 0, "type": "string" }, "enable": { "type": "boolean" }, "draft": { "type": "boolean" }, "triggerScript": { "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "targetAuthorizationPage": { "$ref": "#/components/schemas/XERP.Shared.Models.AuthorizationPage" }, "targetSystemTable": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemTable" }, "targetSystemTableField": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemTableField" }, "triggerFireMode": { "$ref": "#/components/schemas/XERP.Shared.Models.FormattedSearchFireMode" }, "updateTriggerField": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemTableField" } }, "additionalProperties": false }, "XERP.Shared.Models.FormattedSearchFireMode": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 6, "minLength": 0, "type": "string", "nullable": true }, "formattedSearches": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FormattedSearch" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.GenericLookupRequest": { "type": "object", "properties": { "idField": { "type": "string", "nullable": true }, "nameField": { "type": "string", "nullable": true }, "filters": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PropertyFilter" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.GenericQueryRequest": { "type": "object", "properties": { "filters": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PropertyFilter" }, "nullable": true }, "includeEntities": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.GetXXFieldsDataRequest": { "type": "object", "properties": { "tableName": { "type": "string", "nullable": true }, "filterProperty": { "type": "string", "nullable": true }, "filterValue": { "type": "string", "nullable": true }, "mode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.Helpdesk": { "required": [ "info" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "partnerId": { "type": "integer", "format": "int32" }, "contactPersonId": { "type": "integer", "format": "int32", "nullable": true }, "info": { "maxLength": 200, "minLength": 0, "type": "string" }, "prioId": { "type": "integer", "format": "int32" }, "helpdeskDate": { "type": "string", "format": "date-time", "nullable": true }, "starsId": { "type": "integer", "format": "int32", "nullable": true }, "supporterId": { "type": "integer", "format": "int32", "nullable": true }, "statusSupporterId": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "categoryId": { "type": "integer", "format": "int32" }, "topicId": { "type": "integer", "format": "int32" }, "estimatedProcessingTime": { "type": "number", "format": "double", "nullable": true }, "actualProcessingTime": { "type": "number", "format": "double", "nullable": true }, "helpdeskAnswered": { "type": "string", "format": "date-time", "nullable": true }, "onPartnerSide": { "type": "boolean" }, "qualityComment": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "category": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskCategory" }, "contactPerson": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerContactPerson" }, "partner": { "$ref": "#/components/schemas/XERP.Shared.Models.Partner" }, "prio": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskPrio" }, "stars": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskStar" }, "statusSupporter": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskStatusSupporter" }, "supporter": { "$ref": "#/components/schemas/XERP.Shared.Models.Employee" }, "topic": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskTopic" }, "helpdeskDialogs": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskDialog" }, "nullable": true }, "timeTrackings": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.TimeTracking" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.HelpdeskCategory": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 20, "minLength": 0, "type": "string" }, "parentId": { "type": "integer", "format": "int32", "nullable": true }, "selectable": { "type": "boolean" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "parent": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskCategory" }, "helpdesks": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Helpdesk" }, "nullable": true }, "inverseParent": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskCategory" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.HelpdeskDialog": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "helpdeskId": { "type": "integer", "format": "int32" }, "partnerId": { "type": "integer", "format": "int32" }, "contactPersonId": { "type": "integer", "format": "int32" }, "question": { "type": "string", "nullable": true }, "supporterId": { "type": "integer", "format": "int32", "nullable": true }, "answer": { "type": "string", "nullable": true }, "answerTime": { "type": "string", "format": "date-time", "nullable": true }, "answerDuration": { "type": "number", "format": "double", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "contactPerson": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerContactPerson" }, "helpdesk": { "$ref": "#/components/schemas/XERP.Shared.Models.Helpdesk" }, "partner": { "$ref": "#/components/schemas/XERP.Shared.Models.Partner" }, "supporter": { "$ref": "#/components/schemas/XERP.Shared.Models.Employee" }, "helpdeskDialogProtocols": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskDialogProtocol" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.HelpdeskDialogProtocol": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "helpdeskDialogId": { "type": "integer", "format": "int32" }, "supporterId": { "type": "integer", "format": "int32", "nullable": true }, "openTime": { "type": "string", "format": "date-time" }, "closeTime": { "type": "string", "format": "date-time", "nullable": true }, "durationSeconds": { "type": "integer", "format": "int32", "nullable": true }, "answerChanged": { "type": "boolean" }, "answerBefore": { "type": "string", "nullable": true }, "answerAfter": { "type": "string", "nullable": true }, "closeReason": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "helpdeskDialog": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskDialog" }, "supporter": { "$ref": "#/components/schemas/XERP.Shared.Models.Employee" } }, "additionalProperties": false }, "XERP.Shared.Models.HelpdeskNotification": { "required": [ "helpdeskNotificationEventId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "helpdeskNotificationEventId": { "maxLength": 13, "minLength": 0, "type": "string" }, "emailTemplateId": { "type": "integer", "format": "int32" }, "recipientIsPartner": { "type": "boolean" }, "active": { "type": "boolean" }, "email": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "emailTemplate": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailTemplate" }, "helpdeskNotificationEvent": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskNotificationEvent" } }, "additionalProperties": false }, "XERP.Shared.Models.HelpdeskNotificationEvent": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 13, "minLength": 0, "type": "string", "nullable": true }, "name": { "maxLength": 50, "minLength": 0, "type": "string" }, "helpdeskNotifications": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskNotification" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.HelpdeskPrio": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 20, "minLength": 0, "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "helpdesks": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Helpdesk" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.HelpdeskSetting": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 50, "minLength": 0, "type": "string" }, "description": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "legalNotice": { "type": "string", "nullable": true }, "privacyPolicy": { "type": "string", "nullable": true }, "logo": { "type": "string", "format": "byte", "nullable": true }, "url": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "templateId": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "emailAccountId": { "type": "integer", "format": "int32", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "emailAccount": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailAccount" } }, "additionalProperties": false }, "XERP.Shared.Models.HelpdeskStar": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "helpdesks": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Helpdesk" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.HelpdeskStatusSupporter": { "required": [ "color", "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "name": { "maxLength": 50, "minLength": 0, "type": "string" }, "array": { "type": "integer", "format": "int32" }, "closing": { "type": "boolean" }, "color": { "maxLength": 9, "minLength": 0, "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "helpdesks": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Helpdesk" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.HelpdeskTopic": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 50, "minLength": 0, "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "helpdesks": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Helpdesk" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.InsertArticleResult": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "erroR_MESS": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.InsertTextResult": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "docId": { "type": "integer", "format": "int32" }, "rowNumber": { "type": "integer", "format": "int32" }, "positionTypeId": { "type": "string", "nullable": true }, "positionNumber": { "type": "integer", "format": "int32" }, "parentPositionId": { "type": "integer", "format": "int32", "nullable": true }, "childPositionNumber": { "type": "integer", "format": "int32", "nullable": true }, "statusId": { "type": "string", "nullable": true }, "articleId": { "type": "string", "nullable": true }, "name1": { "type": "string", "nullable": true }, "name2": { "type": "string", "nullable": true }, "quantity": { "type": "number", "format": "double" }, "quantityOpen": { "type": "number", "format": "double" }, "uoMId": { "type": "integer", "format": "int32", "nullable": true }, "shippingDate": { "type": "string", "format": "date-time" }, "deliveryDate": { "type": "string", "format": "date-time" }, "price": { "type": "number", "format": "double" }, "totalPrice": { "type": "number", "format": "double" }, "predecessorId": { "type": "integer", "format": "int32", "nullable": true }, "quantityTransferred": { "type": "number", "format": "double", "nullable": true }, "level": { "type": "integer", "format": "int32", "nullable": true }, "positionLabel": { "type": "string", "nullable": true }, "catalogNumberId": { "type": "string", "nullable": true }, "dissolve": { "type": "boolean" }, "positionWeight": { "type": "number", "format": "double", "nullable": true }, "projectId": { "type": "integer", "format": "int32", "nullable": true }, "start": { "type": "string", "format": "date-time", "nullable": true }, "stop": { "type": "string", "format": "date-time", "nullable": true }, "priceUnitId": { "type": "integer", "format": "int32" }, "costPriceTotal": { "type": "number", "format": "double" }, "discountPercent": { "type": "number", "format": "double" }, "quantityDiscountPercent": { "type": "number", "format": "double" }, "docDiscountPercent": { "type": "number", "format": "double" }, "discountedPrice": { "type": "number", "format": "double" }, "revenueEffective": { "type": "integer", "format": "int32", "nullable": true }, "revenue": { "type": "number", "format": "double" }, "salesPersonId": { "type": "integer", "format": "int32", "nullable": true }, "commissionPercent": { "type": "number", "format": "double" }, "commissionAmount": { "type": "number", "format": "double" }, "profitAmount": { "type": "number", "format": "double" }, "profitPercent": { "type": "number", "format": "double", "nullable": true }, "financeGroupArticleId": { "type": "integer", "format": "int32", "nullable": true }, "financeGroupPartnerDetailId": { "type": "integer", "format": "int32", "nullable": true }, "taxKeyId": { "type": "string", "nullable": true }, "taxPercent": { "type": "number", "format": "double" }, "tax": { "type": "number", "format": "double" }, "accountId": { "type": "integer", "format": "int32", "nullable": true }, "costCenterId": { "type": "integer", "format": "int32", "nullable": true }, "costBearerId": { "type": "integer", "format": "int32", "nullable": true }, "warehousing": { "type": "boolean" }, "warehousingEffective": { "type": "integer", "format": "int32", "nullable": true }, "warehousingQuantity": { "type": "number", "format": "double", "nullable": true }, "viewRowNumber": { "type": "integer", "format": "int32" }, "positionNumberConcat": { "type": "string", "nullable": true }, "viewRevenue": { "type": "number", "format": "double", "nullable": true }, "viewWarehousingQuantity": { "type": "number", "format": "double", "nullable": true }, "viewNowAvailable": { "type": "number", "format": "double", "nullable": true }, "docNumber": { "type": "string", "nullable": true }, "docCategoryId": { "type": "string", "nullable": true }, "docTypeId": { "type": "string", "nullable": true }, "inventoryStatusId": { "type": "string", "nullable": true }, "docWarehousingEffective": { "type": "integer", "format": "int32" }, "docRevenueEffective": { "type": "integer", "format": "int32" }, "docStatusId": { "type": "string", "nullable": true }, "partnerId": { "type": "integer", "format": "int32", "nullable": true }, "docDate": { "type": "string", "format": "date-time" }, "postingDate": { "type": "string", "format": "date-time", "nullable": true }, "stock": { "type": "number", "format": "double", "nullable": true }, "confirmed": { "type": "number", "format": "double", "nullable": true }, "packed": { "type": "number", "format": "double", "nullable": true }, "ordered": { "type": "number", "format": "double", "nullable": true }, "announced": { "type": "number", "format": "double", "nullable": true }, "nowAvailable": { "type": "number", "format": "double", "nullable": true }, "laterAvailable": { "type": "number", "format": "double", "nullable": true }, "minimumStock": { "type": "number", "format": "double", "nullable": true }, "maximumStock": { "type": "number", "format": "double", "nullable": true }, "decimalPlacesQuantitiesId": { "type": "integer", "format": "int32", "nullable": true }, "minimumQuantity": { "type": "number", "format": "double", "nullable": true }, "deliveryTime": { "type": "integer", "format": "int32", "nullable": true }, "lotSize": { "type": "number", "format": "double", "nullable": true }, "procurementPrice": { "type": "number", "format": "double", "nullable": true }, "warehouseCost": { "type": "number", "format": "double", "nullable": true }, "overheadCost": { "type": "number", "format": "double", "nullable": true }, "otherCost": { "type": "number", "format": "double", "nullable": true }, "changeInValue": { "type": "number", "format": "double", "nullable": true }, "factor": { "type": "number", "format": "double", "nullable": true }, "costPrice": { "type": "number", "format": "double", "nullable": true }, "infoText": { "type": "string", "nullable": true }, "orderText": { "type": "string", "nullable": true }, "dimensionText": { "type": "string", "nullable": true }, "matchcode": { "type": "string", "nullable": true }, "uoMName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.Intercom": { "required": [ "subject" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "senderId": { "type": "integer", "format": "int32" }, "statusSenderId": { "type": "integer", "format": "int32" }, "deadline": { "type": "string", "format": "date-time" }, "intercomGroupId": { "type": "integer", "format": "int32" }, "subject": { "maxLength": 100, "minLength": 0, "type": "string" }, "description": { "type": "string", "nullable": true }, "reminder": { "type": "integer", "format": "int32", "nullable": true }, "private": { "type": "boolean" }, "recipientId": { "type": "integer", "format": "int32" }, "statusRecipientId": { "type": "integer", "format": "int32" }, "prioId": { "type": "integer", "format": "int32" }, "duration": { "type": "number", "format": "double", "nullable": true }, "plannedCompletion": { "type": "string", "format": "date-time", "nullable": true }, "completion": { "type": "string", "format": "date-time", "nullable": true }, "answer": { "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "intercomGroup": { "$ref": "#/components/schemas/XERP.Shared.Models.IntercomGroup" }, "prio": { "$ref": "#/components/schemas/XERP.Shared.Models.IntercomPrio" }, "recipient": { "$ref": "#/components/schemas/XERP.Shared.Models.Employee" }, "sender": { "$ref": "#/components/schemas/XERP.Shared.Models.Employee" }, "statusRecipient": { "$ref": "#/components/schemas/XERP.Shared.Models.IntercomRecipientStatus" }, "statusSender": { "$ref": "#/components/schemas/XERP.Shared.Models.IntercomSenderStatus" } }, "additionalProperties": false }, "XERP.Shared.Models.IntercomGroup": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 50, "minLength": 0, "type": "string" }, "parentId": { "type": "integer", "format": "int32", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "parent": { "$ref": "#/components/schemas/XERP.Shared.Models.IntercomGroup" }, "intercoms": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Intercom" }, "nullable": true }, "inverseParent": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.IntercomGroup" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.IntercomPrio": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 20, "minLength": 0, "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "intercoms": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Intercom" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.IntercomRecipientStatus": { "required": [ "status" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "status": { "maxLength": 20, "minLength": 0, "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "intercoms": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Intercom" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.IntercomSenderStatus": { "required": [ "status" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "status": { "maxLength": 20, "minLength": 0, "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "intercoms": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Intercom" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.InternalReconciliationPostingDto": { "type": "object", "properties": { "internalReconciliation": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItemInternalReconciliation" }, "internalReconciliationPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW603_FinanceOpenItemReconciliationPosition" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.LoggedInEmployeeCalendarDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "calendarNameId": { "type": "integer", "format": "int32", "nullable": true }, "calendarReminderMinutes": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.LoggedInEmployeeIdDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.LoginInput": { "required": [ "databaseName", "email", "password" ], "type": "object", "properties": { "email": { "minLength": 1, "type": "string", "format": "email" }, "password": { "minLength": 1, "type": "string", "format": "password" }, "newPassword": { "type": "string", "format": "password", "nullable": true }, "confirmNewPassword": { "type": "string", "format": "password", "nullable": true }, "databaseName": { "minLength": 1, "type": "string" }, "rememberMe": { "type": "boolean" }, "keepLoggedIn": { "type": "boolean" }, "keepLoggedInHours": { "maximum": 720, "minimum": 1, "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.LookupItem": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.LookupItem_Of_System.String": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.Maintenance.DatabaseMaintenanceOperation": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7 ], "type": "integer", "format": "int32" }, "XERP.Shared.Models.Maintenance.DatabaseMaintenanceOperationResult": { "type": "object", "properties": { "databaseName": { "type": "string", "nullable": true }, "operation": { "$ref": "#/components/schemas/XERP.Shared.Models.Maintenance.DatabaseMaintenanceOperation" }, "backupType": { "type": "string", "nullable": true }, "fileName": { "type": "string", "nullable": true }, "fileSizeBytes": { "type": "integer", "format": "int64", "nullable": true }, "verificationSucceeded": { "type": "boolean", "nullable": true }, "succeeded": { "type": "boolean" }, "startedAtUtc": { "type": "string", "format": "date-time" }, "endedAtUtc": { "type": "string", "format": "date-time" }, "durationSeconds": { "type": "number", "format": "double" }, "errorMessage": { "type": "string", "nullable": true }, "warnings": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.Maintenance.ExceptionalLogShrinkRequest": { "type": "object", "properties": { "confirmExceptionalOperation": { "type": "boolean" } }, "additionalProperties": false }, "XERP.Shared.Models.Map": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 20, "minLength": 0, "type": "string" }, "urlQuery": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "apiKey": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "zoomLevel": { "type": "integer", "format": "int32", "nullable": true }, "defaultLatitude": { "type": "number", "format": "double", "nullable": true }, "defaultLongitude": { "type": "number", "format": "double", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.Marketplace": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 50, "minLength": 0, "type": "string" }, "keyName": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "contactEmail": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "phoneNumber": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "legalNotice": { "type": "string", "nullable": true }, "privacyPolicy": { "type": "string", "nullable": true }, "logo": { "type": "string", "format": "byte", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.MarketplaceSellerArticle": { "required": [ "articleId", "sellerArticleNumber" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "partnerId": { "type": "integer", "format": "int32", "nullable": true }, "articleId": { "maxLength": 50, "minLength": 0, "type": "string" }, "sellerArticleNumber": { "maxLength": 100, "minLength": 0, "type": "string" }, "price": { "type": "number", "format": "double", "nullable": true }, "deliveryTime": { "type": "integer", "format": "int32", "nullable": true }, "available": { "type": "integer", "format": "int32" }, "active": { "type": "boolean" }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "article": { "$ref": "#/components/schemas/XERP.Shared.Models.Article" }, "partner": { "$ref": "#/components/schemas/XERP.Shared.Models.Partner" } }, "additionalProperties": false }, "XERP.Shared.Models.MarketplaceSellerPosition": { "required": [ "sellerArticleNumber" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "salesPositionId": { "type": "integer", "format": "int32" }, "partnerId": { "type": "integer", "format": "int32", "nullable": true }, "sellerArticleNumber": { "maxLength": 100, "minLength": 0, "type": "string" }, "purchasePositionId": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "partner": { "$ref": "#/components/schemas/XERP.Shared.Models.Partner" }, "purchasePosition": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition" }, "salesPosition": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition" } }, "additionalProperties": false }, "XERP.Shared.Models.MarketplaceSetting": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 50, "minLength": 0, "type": "string" }, "keyName": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "contactEmail": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "phoneNumber": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "legalNotice": { "type": "string", "nullable": true }, "privacyPolicy": { "type": "string", "nullable": true }, "logo": { "type": "string", "format": "byte", "nullable": true }, "url": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.MassEmail": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 100, "minLength": 0, "type": "string" }, "emailAccountId": { "type": "integer", "format": "int32" }, "partnerGroupId": { "type": "integer", "format": "int32", "nullable": true }, "subject": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "bodyHtml": { "type": "string", "nullable": true }, "sentDateTime": { "type": "string", "format": "date-time", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "emailAccount": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailAccount" }, "partnerGroup": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerGroup" }, "massEmailRecipients": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.MassEmailRecipient" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.MassEmailCandidateFilter": { "type": "object", "properties": { "searchText": { "type": "string", "nullable": true }, "partnerGroupId": { "type": "integer", "format": "int32", "nullable": true }, "includeSubGroups": { "type": "boolean" }, "categoryId": { "type": "integer", "format": "int32", "nullable": true }, "includeSubCategories": { "type": "boolean" } }, "additionalProperties": false }, "XERP.Shared.Models.MassEmailRecipient": { "required": [ "emailAddress" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "massEmailId": { "type": "integer", "format": "int32" }, "partnerId": { "type": "integer", "format": "int32" }, "emailAddress": { "maxLength": 255, "minLength": 0, "type": "string" }, "isSelected": { "type": "boolean" }, "sentDateTime": { "type": "string", "format": "date-time", "nullable": true }, "errorMessage": { "maxLength": 1000, "minLength": 0, "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "massEmail": { "$ref": "#/components/schemas/XERP.Shared.Models.MassEmail" }, "partner": { "$ref": "#/components/schemas/XERP.Shared.Models.Partner" } }, "additionalProperties": false }, "XERP.Shared.Models.MassEmailRecipientCandidate": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "matchcode": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "position": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.MenuVisibilityDto": { "type": "object", "properties": { "showHome": { "type": "boolean" }, "showSales": { "type": "boolean" }, "showPurchase": { "type": "boolean" }, "showWarehousing": { "type": "boolean" }, "showProduction": { "type": "boolean" }, "showService": { "type": "boolean" }, "showFinance": { "type": "boolean" }, "showManagement": { "type": "boolean" }, "showCrm": { "type": "boolean" }, "showIntercom": { "type": "boolean" }, "showEmail": { "type": "boolean" }, "showCalendar": { "type": "boolean" }, "showPortal": { "type": "boolean" }, "showAdministration": { "type": "boolean" }, "showHelp": { "type": "boolean" }, "showInfo": { "type": "boolean" } }, "additionalProperties": false }, "XERP.Shared.Models.OrderAddressDto": { "type": "object", "properties": { "deliveryAddress": { "$ref": "#/components/schemas/XERP.Shared.Models.AddressDto" }, "billingAddress": { "$ref": "#/components/schemas/XERP.Shared.Models.AddressDto" } }, "additionalProperties": false }, "XERP.Shared.Models.OrderConfirmationDueState": { "type": "object", "properties": { "overdueCount": { "type": "integer", "format": "int32" }, "dueTodayCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.OutputControlButton": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 7, "minLength": 0, "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.OutputControlFormat": { "required": [ "name", "outputControlMediumId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 50, "minLength": 0, "type": "string" }, "outputControlMediumId": { "maxLength": 20, "minLength": 0, "type": "string" }, "archive": { "type": "boolean" }, "dunning": { "type": "boolean" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "outputControlMedium": { "$ref": "#/components/schemas/XERP.Shared.Models.OutputControlMedium" }, "docTypes": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocType" }, "nullable": true }, "docs": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc" }, "nullable": true }, "financeDunnings": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceDunning" }, "nullable": true }, "partnerDetailOutputs": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDetailOutput" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.OutputControlMedium": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "name": { "maxLength": 50, "minLength": 0, "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "outputControlFormats": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.OutputControlFormat" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.OutputControlPrinterConfiguration": { "required": [ "name", "printer" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 50, "minLength": 0, "type": "string" }, "printer": { "maxLength": 255, "minLength": 0, "type": "string" }, "quantity": { "type": "integer", "format": "int32" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.PackingListBox": { "required": [ "locked" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "pickingListDocId": { "type": "integer", "format": "int32" }, "packingListBoxTypeId": { "type": "integer", "format": "int32", "nullable": true }, "parcelCounter": { "type": "integer", "format": "int32" }, "shippingNumber": { "maxLength": 40, "minLength": 0, "type": "string", "nullable": true }, "weight": { "type": "number", "format": "double", "nullable": true }, "content": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "additionalIdentifier": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "shippingTypeId": { "type": "integer", "format": "int32", "nullable": true }, "shippingDate": { "type": "string", "format": "date-time", "nullable": true }, "shippingCosts": { "type": "number", "format": "double", "nullable": true }, "foreignCurrencyId": { "maxLength": 3, "minLength": 0, "type": "string", "nullable": true }, "trackingUrl": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "waybill": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "parentId": { "type": "integer", "format": "int32", "nullable": true }, "deliveryNoteDocId": { "type": "integer", "format": "int32", "nullable": true }, "locked": { "type": "boolean" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "deliveryNoteDoc": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc" }, "foreignCurrency": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCurrency" }, "packingListBoxType": { "$ref": "#/components/schemas/XERP.Shared.Models.PackingListBoxType" }, "parent": { "$ref": "#/components/schemas/XERP.Shared.Models.PackingListBox" }, "pickingListDoc": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc" }, "shippingType": { "$ref": "#/components/schemas/XERP.Shared.Models.ShippingType" }, "inverseParent": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PackingListBox" }, "nullable": true }, "packingListBoxPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PackingListBoxPosition" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.PackingListBoxPosition": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "boxId": { "type": "integer", "format": "int32" }, "docPositionId": { "type": "integer", "format": "int32", "nullable": true }, "quantity": { "type": "number", "format": "double", "nullable": true }, "individualizationNumberId": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "info": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "box": { "$ref": "#/components/schemas/XERP.Shared.Models.PackingListBox" }, "docPosition": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition" }, "individualizationNumber": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleIndividualization" } }, "additionalProperties": false }, "XERP.Shared.Models.PackingListBoxType": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 30, "minLength": 0, "type": "string" }, "length": { "type": "number", "format": "double", "nullable": true }, "width": { "type": "number", "format": "double", "nullable": true }, "height": { "type": "number", "format": "double", "nullable": true }, "volume": { "type": "number", "format": "double", "nullable": true }, "weight": { "type": "number", "format": "double", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "packingListBoxes": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PackingListBox" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.Partner": { "required": [ "city", "countryId", "email", "languageId", "matchcode", "name1", "street", "zip" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "countryPackageIntrastatPartner": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageIntrastatPartner" }, "id": { "type": "integer", "format": "int32" }, "partnerNumber": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "name1": { "maxLength": 100, "minLength": 0, "type": "string" }, "name2": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "street": { "maxLength": 100, "minLength": 0, "type": "string" }, "zip": { "maxLength": 20, "minLength": 0, "type": "string" }, "city": { "maxLength": 50, "minLength": 0, "type": "string" }, "countryId": { "maxLength": 2, "minLength": 0, "type": "string" }, "matchcode": { "maxLength": 100, "minLength": 0, "type": "string" }, "partnerGroupId": { "type": "integer", "format": "int32" }, "tel1": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "tel2": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "mobile": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "fax": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "email": { "maxLength": 256, "minLength": 0, "type": "string" }, "normalizedEmail": { "maxLength": 256, "minLength": 0, "type": "string", "nullable": true }, "emailConfirmed": { "type": "boolean" }, "passwordHash": { "maxLength": 256, "minLength": 0, "type": "string", "nullable": true }, "changePasswordAtNextLogin": { "type": "boolean" }, "securityStamp": { "maxLength": 256, "minLength": 0, "type": "string", "nullable": true }, "concurrencyStamp": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "twoFactorEnabled": { "type": "boolean" }, "lockoutEnd": { "type": "string", "format": "date-time", "nullable": true }, "lockoutEnabled": { "type": "boolean" }, "accessFailedCount": { "type": "integer", "format": "int32", "nullable": true }, "homepage": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "privatePerson": { "type": "boolean" }, "languageId": { "maxLength": 5, "minLength": 0, "type": "string" }, "locationId": { "type": "integer", "format": "int32" }, "name3": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "name4": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "name5": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "postboxZip": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "postboxCity": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "postboxCountryId": { "maxLength": 2, "minLength": 0, "type": "string", "nullable": true }, "guest": { "type": "boolean" }, "editor": { "type": "boolean" }, "author": { "type": "boolean" }, "active": { "type": "boolean" }, "favorite": { "type": "boolean" }, "deliveryBlock": { "type": "boolean" }, "callBlock": { "type": "boolean" }, "emailBlock": { "type": "boolean" }, "gln": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "eori": { "maxLength": 17, "minLength": 0, "type": "string", "nullable": true }, "keyword": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "isWebshop": { "type": "boolean" }, "isMarketplace": { "type": "boolean" }, "isHelpdesk": { "type": "boolean" }, "isNews": { "type": "boolean" }, "isWiki": { "type": "boolean" }, "isCrm": { "type": "boolean" }, "duplicateProtection": { "type": "boolean" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "country": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCountry" }, "language": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminLanguage" }, "location": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminLocation" }, "partnerGroup": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerGroup" }, "postboxCountry": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCountry" }, "crm": { "$ref": "#/components/schemas/XERP.Shared.Models.Crm" }, "partnerBankAccount": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerBankAccount" }, "partnerInfo": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerInfo" }, "partnerPicture": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerPicture" }, "archiveDunnings": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArchiveDunning" }, "nullable": true }, "archives": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Archive" }, "nullable": true }, "articleManufacturers": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Article" }, "nullable": true }, "articleStandardSuppliers": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Article" }, "nullable": true }, "crmActivities": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CrmActivity" }, "nullable": true }, "docDivergentInvoiceRecipients": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc" }, "nullable": true }, "docPartners": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc" }, "nullable": true }, "docXmlDivergentInvoiceRecipients": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXml" }, "nullable": true }, "docXmlPartners": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXml" }, "nullable": true }, "externalAspNetUsers": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ExternalAspNetUser" }, "nullable": true }, "financeDunnings": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceDunning" }, "nullable": true }, "financeOpenItemInternalReconciliations": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItemInternalReconciliation" }, "nullable": true }, "financeOpenItems": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItem" }, "nullable": true }, "helpdeskDialogs": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskDialog" }, "nullable": true }, "helpdesks": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Helpdesk" }, "nullable": true }, "marketplaceSellerArticles": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.MarketplaceSellerArticle" }, "nullable": true }, "marketplaceSellerPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.MarketplaceSellerPosition" }, "nullable": true }, "massEmailRecipients": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.MassEmailRecipient" }, "nullable": true }, "partnerBillingAddresses": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerBillingAddress" }, "nullable": true }, "partnerCatalogNumbers": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerCatalogNumber" }, "nullable": true }, "partnerCategories": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerCategory" }, "nullable": true }, "partnerContactPeople": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerContactPerson" }, "nullable": true }, "partnerDeliveryAddresses": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDeliveryAddress" }, "nullable": true }, "partnerDetailDivergentInvoiceRecipients": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDetail" }, "nullable": true }, "partnerDetailPartners": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDetail" }, "nullable": true }, "partnerPasskeys": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerPasskey" }, "nullable": true }, "partnerPurchasePriceLists": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerPurchasePriceList" }, "nullable": true }, "partnerTokens": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerToken" }, "nullable": true }, "procurements": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Procurement" }, "nullable": true }, "projects": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Project" }, "nullable": true }, "timeTrackings": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.TimeTracking" }, "nullable": true }, "webshopActivityLogs": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopActivityLog" }, "nullable": true }, "webshopArticleReviews": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopArticleReview" }, "nullable": true }, "webshopPasskeys": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopPasskey" }, "nullable": true }, "webshopRatings": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopRating" }, "nullable": true }, "webshopUserCarts": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopUserCart" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.PartnerBankAccount": { "required": [ "accountOwner", "bankId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "bankAccountNumber": { "maxLength": 34, "minLength": 0, "type": "string", "nullable": true }, "partnerId": { "type": "integer", "format": "int32" }, "bankId": { "maxLength": 40, "minLength": 0, "type": "string" }, "accountName": { "maxLength": 40, "minLength": 0, "type": "string", "nullable": true }, "accountOwner": { "maxLength": 100, "minLength": 0, "type": "string" }, "foreignCurrencyId": { "maxLength": 3, "minLength": 0, "type": "string", "nullable": true }, "mandateReference": { "maxLength": 35, "minLength": 0, "type": "string", "nullable": true }, "purpose": { "maxLength": 80, "minLength": 0, "type": "string", "nullable": true }, "directDebitId": { "type": "integer", "format": "int32", "nullable": true }, "signatureDate": { "type": "string", "format": "date-time", "nullable": true }, "active": { "type": "boolean" }, "startDate": { "type": "string", "format": "date-time", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "bank": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminBank" }, "directDebit": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDirectDebitType" }, "foreignCurrency": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCurrency" }, "partner": { "$ref": "#/components/schemas/XERP.Shared.Models.Partner" }, "financePaymentPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePaymentPosition" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.PartnerBillingAddress": { "required": [ "city", "countryId", "matchcode", "name1", "street", "zip" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "partnerId": { "type": "integer", "format": "int32", "nullable": true }, "matchcode": { "maxLength": 100, "minLength": 0, "type": "string" }, "name1": { "maxLength": 100, "minLength": 0, "type": "string" }, "name2": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "name3": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "position": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "title": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "salutation": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "firstName": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "lastName": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "street": { "maxLength": 100, "minLength": 0, "type": "string" }, "extension": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "zip": { "maxLength": 20, "minLength": 0, "type": "string" }, "city": { "maxLength": 50, "minLength": 0, "type": "string" }, "countryId": { "maxLength": 2, "minLength": 0, "type": "string" }, "tel1": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "tel2": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "mobile": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "fax": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "email": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "homepage": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "keyword": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "vatNumber": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "taxNumber": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "eInvoiceRoutingId": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "favorite": { "type": "boolean" }, "active": { "type": "boolean" }, "latitude": { "type": "number", "format": "double", "nullable": true }, "longitude": { "type": "number", "format": "double", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "country": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCountry" }, "partner": { "$ref": "#/components/schemas/XERP.Shared.Models.Partner" }, "docBillingAddresses": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocBillingAddress" }, "nullable": true }, "partnerDetails": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDetail" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.PartnerCatalogNumber": { "required": [ "articleId", "catalogNumber" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "partnerId": { "type": "integer", "format": "int32" }, "articleId": { "maxLength": 50, "minLength": 0, "type": "string" }, "catalogNumber": { "maxLength": 30, "minLength": 0, "type": "string" }, "active": { "type": "boolean" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "article": { "$ref": "#/components/schemas/XERP.Shared.Models.Article" }, "partner": { "$ref": "#/components/schemas/XERP.Shared.Models.Partner" }, "docPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition" }, "nullable": true }, "docXmlPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXmlPosition" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.PartnerCategory": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "categoryId": { "type": "integer", "format": "int32" }, "partnerId": { "type": "integer", "format": "int32" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "category": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerCategoryName" }, "partner": { "$ref": "#/components/schemas/XERP.Shared.Models.Partner" } }, "additionalProperties": false }, "XERP.Shared.Models.PartnerCategoryName": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 50, "minLength": 0, "type": "string" }, "parentId": { "type": "integer", "format": "int32", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "parent": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerCategoryName" }, "inverseParent": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerCategoryName" }, "nullable": true }, "partnerCategories": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerCategory" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.PartnerContactPerson": { "required": [ "matchcode" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "partnerId": { "type": "integer", "format": "int32" }, "matchcode": { "maxLength": 100, "minLength": 0, "type": "string" }, "position": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "title": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "salutation": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "firstName": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "lastName": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "street": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "extension": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "zip": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "city": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "countryId": { "maxLength": 2, "minLength": 0, "type": "string", "nullable": true }, "tel1": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "tel2": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "mobile": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "fax": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "email": { "maxLength": 256, "minLength": 0, "type": "string", "nullable": true }, "homepage": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "keyword": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "favorite": { "type": "boolean" }, "active": { "type": "boolean" }, "info": { "maxLength": 1000, "minLength": 0, "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "country": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCountry" }, "partner": { "$ref": "#/components/schemas/XERP.Shared.Models.Partner" }, "calendarAppointmentAttendees": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarAppointmentAttendee" }, "nullable": true }, "crmActivities": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CrmActivity" }, "nullable": true }, "crms": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Crm" }, "nullable": true }, "docXmls": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXml" }, "nullable": true }, "docs": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc" }, "nullable": true }, "helpdeskDialogs": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.HelpdeskDialog" }, "nullable": true }, "helpdesks": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Helpdesk" }, "nullable": true }, "partnerContactPersonEmailCategoryContactPeople": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerContactPersonEmailCategoryContactPerson" }, "nullable": true }, "partnerDetails": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDetail" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.PartnerContactPersonEmailCategoryContactPerson": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "contactPersonEmailCategoryNameId": { "type": "integer", "format": "int32", "nullable": true }, "partnerContactPersonId": { "type": "integer", "format": "int32", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "contactPersonEmailCategoryName": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerContactPersonEmailCategoryName" }, "partnerContactPerson": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerContactPerson" } }, "additionalProperties": false }, "XERP.Shared.Models.PartnerContactPersonEmailCategoryDocType": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "contactPersonEmailCategoryNameId": { "type": "integer", "format": "int32", "nullable": true }, "docTypeId": { "maxLength": 35, "minLength": 0, "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "contactPersonEmailCategoryName": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerContactPersonEmailCategoryName" }, "docType": { "$ref": "#/components/schemas/XERP.Shared.Models.DocType" } }, "additionalProperties": false }, "XERP.Shared.Models.PartnerContactPersonEmailCategoryName": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "contactPersonEmailType": { "type": "integer", "format": "int32", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "partnerContactPersonEmailCategoryContactPeople": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerContactPersonEmailCategoryContactPerson" }, "nullable": true }, "partnerContactPersonEmailCategoryDocTypes": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerContactPersonEmailCategoryDocType" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.PartnerDeliveryAddress": { "required": [ "city", "countryId", "matchcode", "name1", "street", "zip" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "partnerId": { "type": "integer", "format": "int32", "nullable": true }, "matchcode": { "maxLength": 100, "minLength": 0, "type": "string" }, "name1": { "maxLength": 100, "minLength": 0, "type": "string" }, "name2": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "name3": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "position": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "title": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "salutation": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "firstName": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "lastName": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "street": { "maxLength": 100, "minLength": 0, "type": "string" }, "extension": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "zip": { "maxLength": 20, "minLength": 0, "type": "string" }, "city": { "maxLength": 50, "minLength": 0, "type": "string" }, "countryId": { "maxLength": 2, "minLength": 0, "type": "string" }, "tel1": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "tel2": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "mobile": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "fax": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "email": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "homepage": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "keyword": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "vatNumber": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "taxNumber": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "favorite": { "type": "boolean" }, "active": { "type": "boolean" }, "latitude": { "type": "number", "format": "double", "nullable": true }, "longitude": { "type": "number", "format": "double", "nullable": true }, "shippingZoneId": { "type": "integer", "format": "int32", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "country": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCountry" }, "partner": { "$ref": "#/components/schemas/XERP.Shared.Models.Partner" }, "shippingZone": { "$ref": "#/components/schemas/XERP.Shared.Models.ShippingZone" }, "docDeliveryAddresses": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocDeliveryAddress" }, "nullable": true }, "partnerDetails": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDetail" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.PartnerDetail": { "required": [ "bankingId", "partnerTypeId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "partnerTypeId": { "maxLength": 10, "minLength": 0, "type": "string" }, "partnerId": { "type": "integer", "format": "int32" }, "ownNumber": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "termsOfPaymentId": { "type": "integer", "format": "int32" }, "bankingId": { "maxLength": 10, "minLength": 0, "type": "string" }, "termsOfDeliveryId": { "type": "integer", "format": "int32" }, "financeGroupPartnerDetailId": { "type": "integer", "format": "int32" }, "costCenterId": { "type": "integer", "format": "int32", "nullable": true }, "standardContactPersonId": { "type": "integer", "format": "int32", "nullable": true }, "standardDeliveryAddressId": { "type": "integer", "format": "int32" }, "standardBillingAddressId": { "type": "integer", "format": "int32" }, "discountGroupNameId": { "type": "integer", "format": "int32", "nullable": true }, "priceListSalesId": { "type": "integer", "format": "int32", "nullable": true }, "docDiscountPercent": { "type": "number", "format": "double" }, "creditLimit": { "type": "number", "format": "double", "nullable": true }, "dunningLock": { "type": "boolean" }, "eDocTypeId": { "type": "integer", "format": "int32" }, "invoiceEmail": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "divergentInvoiceRecipientId": { "type": "integer", "format": "int32", "nullable": true }, "salesPersonId": { "type": "integer", "format": "int32", "nullable": true }, "employeeId": { "type": "integer", "format": "int32", "nullable": true }, "datevAccount": { "type": "integer", "format": "int32", "nullable": true }, "balance": { "type": "number", "format": "double" }, "foreignCurrencyBalance": { "type": "number", "format": "double", "nullable": true }, "foreignCurrencyId": { "maxLength": 3, "minLength": 0, "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "banking": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDetailBanking" }, "costCenter": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceCostCenter" }, "discountGroupName": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDiscountGroupName" }, "divergentInvoiceRecipient": { "$ref": "#/components/schemas/XERP.Shared.Models.Partner" }, "eDocType": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminEDocType" }, "employee": { "$ref": "#/components/schemas/XERP.Shared.Models.Employee" }, "financeGroupPartnerDetail": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceGroupPartner" }, "foreignCurrency": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCurrency" }, "partner": { "$ref": "#/components/schemas/XERP.Shared.Models.Partner" }, "partnerType": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerType" }, "priceListSales": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleSalesPriceListName" }, "salesPerson": { "$ref": "#/components/schemas/XERP.Shared.Models.Employee" }, "standardBillingAddress": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerBillingAddress" }, "standardContactPerson": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerContactPerson" }, "standardDeliveryAddress": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDeliveryAddress" }, "termsOfDelivery": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerTermsOfDelivery" }, "termsOfPayment": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerTermsOfPayment" }, "docXmls": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXml" }, "nullable": true }, "docs": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc" }, "nullable": true }, "financeOpenItemInternalReconciliations": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItemInternalReconciliation" }, "nullable": true }, "financeOpenItems": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItem" }, "nullable": true }, "financeOpeningBalancePositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpeningBalancePosition" }, "nullable": true }, "financePostingPositionDrafts": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionDraft" }, "nullable": true }, "financePostingPositionTemplates": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionTemplate" }, "nullable": true }, "financePostingPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPosition" }, "nullable": true }, "financeTransferCategories": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferCategory" }, "nullable": true }, "financeTransferPositionAccountPlans": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionAccountPlan" }, "nullable": true }, "financeTransferPositionCustomerPartnerDetails": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPosition" }, "nullable": true }, "financeTransferPositionSupplierPartnerDetails": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPosition" }, "nullable": true }, "financeTransferSuggestionCustomerPartnerDetails": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferSuggestion" }, "nullable": true }, "financeTransferSuggestionSupplierPartnerDetails": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferSuggestion" }, "nullable": true }, "partnerDetailOutputs": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDetailOutput" }, "nullable": true }, "webshopRatings": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopRating" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.PartnerDetailBanking": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 10, "minLength": 0, "type": "string", "nullable": true }, "name": { "maxLength": 50, "minLength": 0, "type": "string" }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "partnerDetails": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDetail" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.PartnerDetailOutput": { "required": [ "docTypeId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "partnerDetailId": { "type": "integer", "format": "int32" }, "docTypeId": { "maxLength": 35, "minLength": 0, "type": "string" }, "outputControlFormatId": { "type": "integer", "format": "int32" }, "emailTemplateId": { "type": "integer", "format": "int32", "nullable": true }, "reportTemplateId": { "type": "integer", "format": "int32" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "docType": { "$ref": "#/components/schemas/XERP.Shared.Models.DocType" }, "emailTemplate": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailTemplate" }, "outputControlFormat": { "$ref": "#/components/schemas/XERP.Shared.Models.OutputControlFormat" }, "partnerDetail": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDetail" }, "reportTemplate": { "$ref": "#/components/schemas/XERP.Shared.Models.ReportTemplate" } }, "additionalProperties": false }, "XERP.Shared.Models.PartnerDirectDebitType": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 50, "minLength": 0, "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "financePayments": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePayment" }, "nullable": true }, "partnerBankAccounts": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerBankAccount" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.PartnerDiscountGroup": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "discountGroupNameId": { "type": "integer", "format": "int32" }, "articleGroupId": { "type": "integer", "format": "int32" }, "discountPercent": { "type": "number", "format": "double" }, "quantityLevelA": { "type": "number", "format": "double", "nullable": true }, "quantityDiscountA": { "type": "number", "format": "double", "nullable": true }, "quantityLevelB": { "type": "number", "format": "double", "nullable": true }, "quantityDiscountB": { "type": "number", "format": "double", "nullable": true }, "quantityLevelC": { "type": "number", "format": "double", "nullable": true }, "quantityDiscountC": { "type": "number", "format": "double", "nullable": true }, "quantityLevelD": { "type": "number", "format": "double", "nullable": true }, "quantityDiscountD": { "type": "number", "format": "double", "nullable": true }, "quantityLevelE": { "type": "number", "format": "double", "nullable": true }, "quantityDiscountE": { "type": "number", "format": "double", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "articleGroup": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleGroup" }, "discountGroupName": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDiscountGroupName" } }, "additionalProperties": false }, "XERP.Shared.Models.PartnerDiscountGroupName": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 50, "minLength": 0, "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "partnerDetails": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDetail" }, "nullable": true }, "partnerDiscountGroups": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDiscountGroup" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.PartnerGroup": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "hierarchyNode": { "$ref": "#/components/schemas/Microsoft.EntityFrameworkCore.HierarchyId" }, "children": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerGroup" }, "nullable": true }, "hasChildren": { "type": "boolean" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 50, "minLength": 0, "type": "string" }, "partnerTypeId": { "maxLength": 10, "minLength": 0, "type": "string", "nullable": true }, "parentId": { "type": "integer", "format": "int32", "nullable": true }, "hierarchyLevel": { "type": "integer", "format": "int32", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "parent": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerGroup" }, "partnerType": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerType" }, "employeeCommissionGroups": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.EmployeeCommissionGroup" }, "nullable": true }, "financeAccountDeterminations": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceAccountDetermination" }, "nullable": true }, "inverseParent": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerGroup" }, "nullable": true }, "massEmails": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.MassEmail" }, "nullable": true }, "partners": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Partner" }, "nullable": true }, "webshopSettings": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopSetting" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.PartnerInfo": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "partnerId": { "type": "integer", "format": "int32" }, "info": { "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "partner": { "$ref": "#/components/schemas/XERP.Shared.Models.Partner" } }, "additionalProperties": false }, "XERP.Shared.Models.PartnerPasskey": { "required": [ "credentialId", "data" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "credentialId": { "maxLength": 512, "type": "string", "format": "byte" }, "partnerId": { "type": "integer", "format": "int32" }, "name": { "maxLength": 256, "minLength": 0, "type": "string", "nullable": true }, "data": { "minLength": 1, "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "partner": { "$ref": "#/components/schemas/XERP.Shared.Models.Partner" } }, "additionalProperties": false }, "XERP.Shared.Models.PartnerPaymentType": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 50, "minLength": 0, "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "partnerTermsOfPayments": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerTermsOfPayment" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.PartnerPicture": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "partnerId": { "type": "integer", "format": "int32" }, "picture": { "type": "string", "format": "byte", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "partner": { "$ref": "#/components/schemas/XERP.Shared.Models.Partner" } }, "additionalProperties": false }, "XERP.Shared.Models.PartnerPurchasePriceList": { "required": [ "articleId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "partnerId": { "type": "integer", "format": "int32" }, "articleId": { "maxLength": 50, "minLength": 0, "type": "string" }, "deliveryTime": { "type": "integer", "format": "int32" }, "minimumQuantity": { "type": "number", "format": "double" }, "lotSize": { "type": "number", "format": "double" }, "discountGroupAssigned": { "type": "boolean" }, "purchasePrice": { "type": "number", "format": "double" }, "discountPercent": { "type": "number", "format": "double" }, "logisticCost": { "type": "number", "format": "double" }, "customsCost": { "type": "number", "format": "double" }, "riskCost": { "type": "number", "format": "double" }, "landedCost": { "type": "number", "format": "double", "nullable": true }, "priceUnitId": { "type": "integer", "format": "int32" }, "unitPrice": { "type": "number", "format": "double", "nullable": true }, "comment": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "article": { "$ref": "#/components/schemas/XERP.Shared.Models.Article" }, "partner": { "$ref": "#/components/schemas/XERP.Shared.Models.Partner" }, "priceUnit": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticlePriceUnit" } }, "additionalProperties": false }, "XERP.Shared.Models.PartnerTermsOfDelivery": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 50, "minLength": 0, "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "docXmls": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXml" }, "nullable": true }, "docs": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc" }, "nullable": true }, "partnerDetails": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDetail" }, "nullable": true }, "webshopSettings": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopSetting" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.PartnerTermsOfPayment": { "required": [ "name", "partnerTypeId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 50, "minLength": 0, "type": "string" }, "partnerTypeId": { "maxLength": 10, "minLength": 0, "type": "string" }, "daysUntilDue": { "type": "integer", "format": "int32" }, "cashDiscountDays1": { "type": "integer", "format": "int32", "nullable": true }, "cashDiscountPercentage1": { "type": "number", "format": "double", "nullable": true }, "cashDiscountDays2": { "type": "integer", "format": "int32", "nullable": true }, "cashDiscountPercentage2": { "type": "number", "format": "double", "nullable": true }, "paymentTypeId": { "type": "integer", "format": "int32" }, "paymentWizard": { "type": "boolean" }, "untdidId": { "type": "integer", "format": "int32", "nullable": true }, "companyBankAccountId": { "maxLength": 34, "minLength": 0, "type": "string", "nullable": true }, "isDefault": { "type": "boolean" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "companyBankAccount": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceCompanyBankAccount" }, "partnerType": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerType" }, "paymentType": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerPaymentType" }, "untdid": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerTermsOfPaymentUNTDID" }, "docXmls": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXml" }, "nullable": true }, "docs": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc" }, "nullable": true }, "financeOpenItems": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItem" }, "nullable": true }, "partnerDetails": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDetail" }, "nullable": true }, "webshopSettings": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopSetting" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.PartnerTermsOfPaymentUNTDID": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "idAndName": { "type": "string", "nullable": true, "readOnly": true }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 100, "minLength": 0, "type": "string" }, "description": { "maxLength": 300, "minLength": 0, "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "partnerTermsOfPayments": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerTermsOfPayment" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.PartnerToken": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "partnerId": { "type": "integer", "format": "int32" }, "loginProvider": { "maxLength": 128, "minLength": 0, "type": "string", "nullable": true }, "name": { "maxLength": 128, "minLength": 0, "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true }, "tokenHash": { "maxLength": 256, "minLength": 0, "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": true }, "expiresAt": { "type": "string", "format": "date-time", "nullable": true }, "lastActivityAt": { "type": "string", "format": "date-time", "nullable": true }, "deviceInfo": { "maxLength": 512, "minLength": 0, "type": "string", "nullable": true }, "ipAddress": { "maxLength": 45, "minLength": 0, "type": "string", "nullable": true }, "isRememberMeSession": { "type": "boolean", "nullable": true }, "partner": { "$ref": "#/components/schemas/XERP.Shared.Models.Partner" } }, "additionalProperties": false }, "XERP.Shared.Models.PartnerType": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 10, "minLength": 0, "type": "string", "nullable": true }, "name": { "maxLength": 20, "minLength": 0, "type": "string" }, "financeGroupPartner": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceGroupPartner" }, "partnerTermsOfPayment": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerTermsOfPayment" }, "countryPackageOssProcedureFinanceGroupArticleSales": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.CountryPackageOssProcedureFinanceGroupArticleSale" }, "nullable": true }, "financeGroupArticles": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceGroupArticle" }, "nullable": true }, "financeOpenItems": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpenItem" }, "nullable": true }, "financeOpeningBalances": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceOpeningBalance" }, "nullable": true }, "partnerDetails": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDetail" }, "nullable": true }, "partnerGroups": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerGroup" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.PhoneCall": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "phoneLineId": { "type": "integer", "format": "int32", "nullable": true }, "phoneFolderId": { "type": "integer", "format": "int32", "nullable": true }, "date": { "type": "string", "format": "date-time", "nullable": true }, "incoming": { "type": "boolean" }, "subject": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "employeeId": { "type": "integer", "format": "int32", "nullable": true }, "remark": { "maxLength": 1000, "minLength": 0, "type": "string", "nullable": true }, "prioHigh": { "type": "boolean" }, "followUp": { "type": "string", "format": "date-time", "nullable": true }, "done": { "type": "boolean" }, "startTime": { "type": "string", "format": "date-time", "nullable": true }, "endTime": { "type": "string", "format": "date-time", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "employee": { "$ref": "#/components/schemas/XERP.Shared.Models.Employee" }, "phoneFolder": { "$ref": "#/components/schemas/XERP.Shared.Models.PhoneFolder" }, "phoneLine": { "$ref": "#/components/schemas/XERP.Shared.Models.PhoneLine" }, "phoneLogs": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PhoneLog" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.PhoneFolder": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 50, "minLength": 0, "type": "string" }, "parentId": { "type": "integer", "format": "int32", "nullable": true }, "groupFolder": { "type": "boolean" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "parent": { "$ref": "#/components/schemas/XERP.Shared.Models.PhoneFolder" }, "inverseParent": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PhoneFolder" }, "nullable": true }, "phoneCalls": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PhoneCall" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.PhoneLine": { "required": [ "line", "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 50, "minLength": 0, "type": "string" }, "line": { "maxLength": 20, "minLength": 0, "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "phoneCalls": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PhoneCall" }, "nullable": true }, "phoneLineEmployees": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PhoneLineEmployee" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.PhoneLineEmployee": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 50, "minLength": 0, "type": "string" }, "phoneLineId": { "type": "integer", "format": "int32" }, "employeeId": { "type": "integer", "format": "int32" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "employee": { "$ref": "#/components/schemas/XERP.Shared.Models.Employee" }, "phoneLine": { "$ref": "#/components/schemas/XERP.Shared.Models.PhoneLine" } }, "additionalProperties": false }, "XERP.Shared.Models.PhoneLog": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "phoneCallId": { "type": "integer", "format": "int32", "nullable": true }, "date": { "type": "string", "format": "date-time", "nullable": true }, "logEntry": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "success": { "type": "boolean" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "phoneCall": { "$ref": "#/components/schemas/XERP.Shared.Models.PhoneCall" } }, "additionalProperties": false }, "XERP.Shared.Models.PositionTypeIdResult": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "docId": { "type": "integer", "format": "int32", "nullable": true }, "rowNumber": { "type": "integer", "format": "int32", "nullable": true }, "positionTypeId": { "type": "string", "nullable": true }, "positionNumber": { "type": "integer", "format": "int32", "nullable": true }, "parentPositionId": { "type": "integer", "format": "int32", "nullable": true }, "childPositionNumber": { "type": "integer", "format": "int32", "nullable": true }, "statusId": { "type": "string", "nullable": true }, "articleId": { "type": "string", "nullable": true }, "name1": { "type": "string", "nullable": true }, "name2": { "type": "string", "nullable": true }, "quantity": { "type": "number", "format": "double", "nullable": true }, "quantityOpen": { "type": "number", "format": "double", "nullable": true }, "uoMId": { "type": "integer", "format": "int32", "nullable": true }, "shippingDate": { "type": "string", "format": "date-time" }, "deliveryDate": { "type": "string", "format": "date-time" }, "price": { "type": "number", "format": "double", "nullable": true }, "totalPrice": { "type": "number", "format": "double", "nullable": true }, "predecessorId": { "type": "integer", "format": "int32", "nullable": true }, "quantityTransferred": { "type": "number", "format": "double", "nullable": true }, "level": { "type": "integer", "format": "int32", "nullable": true }, "positionLabel": { "type": "string", "nullable": true }, "catalogNumberId": { "type": "string", "nullable": true }, "dissolve": { "type": "boolean", "nullable": true }, "positionWeight": { "type": "number", "format": "double", "nullable": true }, "projectId": { "type": "integer", "format": "int32", "nullable": true }, "start": { "type": "string", "format": "date-time", "nullable": true }, "stop": { "type": "string", "format": "date-time", "nullable": true }, "priceUnitId": { "type": "integer", "format": "int32", "nullable": true }, "costPriceTotal": { "type": "number", "format": "double", "nullable": true }, "discountPercent": { "type": "number", "format": "double", "nullable": true }, "quantityDiscountPercent": { "type": "number", "format": "double", "nullable": true }, "docDiscountPercent": { "type": "number", "format": "double", "nullable": true }, "discountedPrice": { "type": "number", "format": "double", "nullable": true }, "revenueEffective": { "type": "integer", "format": "int32", "nullable": true }, "revenue": { "type": "number", "format": "double", "nullable": true }, "salesPersonId": { "type": "integer", "format": "int32", "nullable": true }, "commissionPercent": { "type": "number", "format": "double", "nullable": true }, "commissionAmount": { "type": "number", "format": "double", "nullable": true }, "profitAmount": { "type": "number", "format": "double", "nullable": true }, "profitPercent": { "type": "number", "format": "double", "nullable": true }, "financeGroupArticleId": { "type": "integer", "format": "int32", "nullable": true }, "financeGroupPartnerDetailId": { "type": "integer", "format": "int32", "nullable": true }, "taxKeyId": { "type": "string", "nullable": true }, "taxPercent": { "type": "number", "format": "double", "nullable": true }, "tax": { "type": "number", "format": "double", "nullable": true }, "accountId": { "type": "integer", "format": "int32", "nullable": true }, "costCenterId": { "type": "integer", "format": "int32", "nullable": true }, "costBearerId": { "type": "integer", "format": "int32", "nullable": true }, "warehousing": { "type": "boolean", "nullable": true }, "warehousingEffective": { "type": "integer", "format": "int32", "nullable": true }, "warehousingQuantity": { "type": "number", "format": "double", "nullable": true }, "viewRowNumber": { "type": "integer", "format": "int32", "nullable": true }, "positionNumberConcat": { "type": "string", "nullable": true }, "viewRevenue": { "type": "number", "format": "double", "nullable": true }, "viewWarehousingQuantity": { "type": "number", "format": "double", "nullable": true }, "viewNowAvailable": { "type": "number", "format": "double", "nullable": true }, "docNumber": { "type": "string", "nullable": true }, "docCategoryId": { "type": "string", "nullable": true }, "docTypeId": { "type": "string", "nullable": true }, "inventoryStatusId": { "type": "string", "nullable": true }, "docWarehousingEffective": { "type": "integer", "format": "int32", "nullable": true }, "docRevenueEffective": { "type": "integer", "format": "int32", "nullable": true }, "docStatusId": { "type": "string", "nullable": true }, "partnerId": { "type": "integer", "format": "int32", "nullable": true }, "docDate": { "type": "string", "format": "date-time" }, "postingDate": { "type": "string", "format": "date-time", "nullable": true }, "stock": { "type": "number", "format": "double", "nullable": true }, "confirmed": { "type": "number", "format": "double", "nullable": true }, "packed": { "type": "number", "format": "double", "nullable": true }, "ordered": { "type": "number", "format": "double", "nullable": true }, "announced": { "type": "number", "format": "double", "nullable": true }, "nowAvailable": { "type": "number", "format": "double", "nullable": true }, "laterAvailable": { "type": "number", "format": "double", "nullable": true }, "minimumStock": { "type": "number", "format": "double", "nullable": true }, "maximumStock": { "type": "number", "format": "double", "nullable": true }, "decimalPlacesQuantitiesId": { "type": "integer", "format": "int32", "nullable": true }, "minimumQuantity": { "type": "number", "format": "double", "nullable": true }, "deliveryTime": { "type": "integer", "format": "int32", "nullable": true }, "lotSize": { "type": "number", "format": "double", "nullable": true }, "procurementPrice": { "type": "number", "format": "double", "nullable": true }, "warehouseCost": { "type": "number", "format": "double", "nullable": true }, "overheadCost": { "type": "number", "format": "double", "nullable": true }, "otherCost": { "type": "number", "format": "double", "nullable": true }, "changeInValue": { "type": "number", "format": "double", "nullable": true }, "factor": { "type": "number", "format": "double", "nullable": true }, "costPrice": { "type": "number", "format": "double", "nullable": true }, "infoText": { "type": "string", "nullable": true }, "orderText": { "type": "string", "nullable": true }, "dimensionText": { "type": "string", "nullable": true }, "matchcode": { "type": "string", "nullable": true }, "uoMName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.PostFinanceClosingPostingResult": { "type": "object", "properties": { "positionId": { "type": "integer", "format": "int32", "nullable": true }, "accountId": { "type": "integer", "format": "int32", "nullable": true }, "accountName": { "type": "string", "nullable": true }, "text": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.PostFinanceOpeningBalanceResult": { "type": "object", "properties": { "positionId": { "type": "integer", "format": "int32", "nullable": true }, "accountId": { "type": "integer", "format": "int32", "nullable": true }, "accountName": { "type": "string", "nullable": true }, "text": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.PostingReversalResult": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "docNumber": { "type": "string", "nullable": true }, "statusId": { "type": "string", "nullable": true }, "reversalReferenceId": { "type": "integer", "format": "int32", "nullable": true }, "postingTemplateId": { "type": "integer", "format": "int32", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time", "nullable": true }, "receiptNumber": { "type": "string", "nullable": true }, "receiptDate": { "type": "string", "format": "date-time", "nullable": true }, "postingPeriodId": { "type": "integer", "format": "int32", "nullable": true }, "subject": { "type": "string", "nullable": true }, "batchNumber": { "type": "string", "nullable": true }, "sourceId": { "type": "string", "nullable": true }, "reversible": { "type": "boolean", "nullable": true }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "exportDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.Procurement": { "required": [ "articleId", "procurementTypeId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "articleId": { "maxLength": 50, "minLength": 0, "type": "string" }, "procurementTypeId": { "maxLength": 4, "minLength": 0, "type": "string" }, "orderConfirmationPositionId": { "type": "integer", "format": "int32", "nullable": true }, "productionPositionId": { "type": "integer", "format": "int32", "nullable": true }, "confirmedQuantityOpen": { "type": "number", "format": "double" }, "warehouseId": { "type": "integer", "format": "int32", "nullable": true }, "binLocationId": { "type": "integer", "format": "int32", "nullable": true }, "thresholdQuantity": { "type": "number", "format": "double" }, "stockQuantityUsed": { "type": "number", "format": "double" }, "orderedQuantityUsed": { "type": "number", "format": "double" }, "announcedQuantityUsed": { "type": "number", "format": "double" }, "suggestedQuantity": { "type": "number", "format": "double" }, "supplierId": { "type": "integer", "format": "int32", "nullable": true }, "purchaseOrderPosId": { "type": "integer", "format": "int32", "nullable": true }, "productionId": { "type": "integer", "format": "int32", "nullable": true }, "info": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "article": { "$ref": "#/components/schemas/XERP.Shared.Models.Article" }, "binLocation": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseBinLocation" }, "orderConfirmationPosition": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition" }, "procurementType": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProcurementType" }, "production": { "$ref": "#/components/schemas/XERP.Shared.Models.Production" }, "productionPosition": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPosition" }, "purchaseOrderPos": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition" }, "supplier": { "$ref": "#/components/schemas/XERP.Shared.Models.Partner" }, "warehouse": { "$ref": "#/components/schemas/XERP.Shared.Models.Warehouse" } }, "additionalProperties": false }, "XERP.Shared.Models.Procurement_CreateOrderRequest": { "type": "object", "properties": { "procurementTypeId": { "type": "string", "nullable": true }, "createdById": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.Procurement_CreateProductionRequest": { "type": "object", "properties": { "positionId": { "type": "integer", "format": "int32" }, "createdById": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.Procurement_RunWizardRequest": { "type": "object", "properties": { "procurementTypeId": { "type": "string", "nullable": true }, "selectedLocation": { "type": "integer", "format": "int32", "nullable": true }, "selectedFromArticle": { "type": "string", "nullable": true }, "selectedToArticle": { "type": "string", "nullable": true }, "selectedFromArticleGroup": { "type": "integer", "format": "int32", "nullable": true }, "selectedToArticleGroup": { "type": "integer", "format": "int32", "nullable": true }, "selectedFromSupplier": { "type": "string", "nullable": true }, "selectedToSupplier": { "type": "string", "nullable": true }, "selectedFromCustomer": { "type": "string", "nullable": true }, "selectedToCustomer": { "type": "string", "nullable": true }, "selectedStockConsideration": { "type": "string", "nullable": true }, "selectedSupplierPriority": { "type": "string", "nullable": true }, "selectedFromWarehouseId": { "type": "integer", "format": "int32", "nullable": true }, "selectedToWarehouseId": { "type": "integer", "format": "int32", "nullable": true }, "selectedFromProductionNumber": { "type": "string", "nullable": true }, "selectedToProductionNumber": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.Procurement_UpdateQuantityUsedRequest": { "type": "object", "properties": { "procurementId": { "type": "integer", "format": "int32" }, "quantity": { "type": "number", "format": "double" } }, "additionalProperties": false }, "XERP.Shared.Models.Production": { "required": [ "productId", "productionStatusId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "productionNumber": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "productId": { "maxLength": 50, "minLength": 0, "type": "string" }, "productionQuantityPlanned": { "type": "number", "format": "double" }, "productionQuantityOpen": { "type": "number", "format": "double" }, "productionQuantityConfirmed": { "type": "number", "format": "double" }, "productionQuantityPick": { "type": "number", "format": "double" }, "productionQuantityPacked": { "type": "number", "format": "double" }, "productionQuantityIssued": { "type": "number", "format": "double" }, "productionQuantityConsumed": { "type": "number", "format": "double" }, "productionQuantityOrdered": { "type": "number", "format": "double" }, "productionQuantityAnnounced": { "type": "number", "format": "double" }, "productionQuantityCompleted": { "type": "number", "format": "double" }, "productionQuantityScrap": { "type": "number", "format": "double", "nullable": true }, "disassembly": { "type": "boolean" }, "productionStatusId": { "maxLength": 12, "minLength": 0, "type": "string" }, "productionManagerId": { "type": "integer", "format": "int32", "nullable": true }, "forwardPlanning": { "type": "boolean" }, "productionPlannedStart": { "type": "string", "format": "date-time", "nullable": true }, "productionPlannedEnd": { "type": "string", "format": "date-time", "nullable": true }, "productionActualStart": { "type": "string", "format": "date-time", "nullable": true }, "productionActualEnd": { "type": "string", "format": "date-time", "nullable": true }, "productionSetupSeconds": { "type": "integer", "format": "int32", "nullable": true }, "productionRunSeconds": { "type": "integer", "format": "int32", "nullable": true }, "productionDowntimeSeconds": { "type": "integer", "format": "int32", "nullable": true }, "productionPauseSeconds": { "type": "integer", "format": "int32", "nullable": true }, "orderConfirmationPositionId": { "type": "integer", "format": "int32", "nullable": true }, "productionWarehouseId": { "type": "integer", "format": "int32" }, "subject": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "approvalRequired": { "type": "boolean" }, "contractId": { "type": "integer", "format": "int32", "nullable": true }, "projectId": { "type": "integer", "format": "int32", "nullable": true }, "costPriceSum": { "type": "number", "format": "double", "nullable": true }, "locationId": { "type": "integer", "format": "int32" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "contract": { "$ref": "#/components/schemas/XERP.Shared.Models.Production" }, "location": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminLocation" }, "orderConfirmationPosition": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition" }, "product": { "$ref": "#/components/schemas/XERP.Shared.Models.Article" }, "productionManager": { "$ref": "#/components/schemas/XERP.Shared.Models.Employee" }, "productionStatus": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionStatus" }, "productionWarehouse": { "$ref": "#/components/schemas/XERP.Shared.Models.Warehouse" }, "project": { "$ref": "#/components/schemas/XERP.Shared.Models.Project" }, "productionPositionTimerState": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionTimerState" }, "inverseContract": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Production" }, "nullable": true }, "procurements": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Procurement" }, "nullable": true }, "productionPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPosition" }, "nullable": true }, "timeTrackings": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.TimeTracking" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.ProductionDataAcquisition": { "required": [ "action", "statusId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "rowNumber": { "type": "integer", "format": "int32" }, "productionPositionId": { "type": "integer", "format": "int32" }, "employeeId": { "type": "integer", "format": "int32" }, "employeeSessionId": { "type": "integer", "format": "int32", "nullable": true }, "workplaceId": { "type": "integer", "format": "int32", "nullable": true }, "shiftId": { "type": "integer", "format": "int32", "nullable": true }, "resourceId": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "statusId": { "maxLength": 20, "minLength": 0, "type": "string" }, "info": { "type": "string", "nullable": true }, "quantity": { "type": "number", "format": "double", "nullable": true }, "quantityType": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "goodQuantity": { "type": "number", "format": "double", "nullable": true }, "scrapQuantity": { "type": "number", "format": "double", "nullable": true }, "reasonCodeId": { "maxLength": 40, "minLength": 0, "type": "string", "nullable": true }, "progress": { "type": "integer", "format": "int32", "nullable": true }, "productionDataAcquisitionPlannedStart": { "type": "string", "format": "date-time", "nullable": true }, "productionDataAcquisitionPlannedEnd": { "type": "string", "format": "date-time", "nullable": true }, "productionDataAcquisitionActualStart": { "type": "string", "format": "date-time", "nullable": true }, "productionDataAcquisitionActualEnd": { "type": "string", "format": "date-time", "nullable": true }, "productionDataAcquisitionDurationSeconds": { "type": "integer", "format": "int32", "nullable": true }, "action": { "maxLength": 20, "minLength": 0, "type": "string" }, "sessionId": { "type": "string", "format": "uuid", "nullable": true }, "previousEventId": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "clientTimestamp": { "type": "string", "format": "date-time", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "employee": { "$ref": "#/components/schemas/XERP.Shared.Models.Employee" }, "employeeSession": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisitionWorkplaceSession" }, "productionPosition": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPosition" }, "reasonCode": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisitionReasonCode" }, "resource": { "$ref": "#/components/schemas/XERP.Shared.Models.Resource" }, "status": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisitionStatus" }, "workplace": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisitionWorkplace" } }, "additionalProperties": false }, "XERP.Shared.Models.ProductionDataAcquisitionReasonCategory": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "name": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "productionDataAcquisitionReasonCodes": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisitionReasonCode" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.ProductionDataAcquisitionReasonCode": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 40, "minLength": 0, "type": "string", "nullable": true }, "reasonTypeId": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "categoryId": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "name": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "color": { "maxLength": 9, "minLength": 0, "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "category": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisitionReasonCategory" }, "reasonType": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisitionReasonType" }, "productionDataAcquisitions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisition" }, "nullable": true }, "productionPositionTimerStates": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionTimerState" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.ProductionDataAcquisitionReasonType": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "name": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "productionDataAcquisitionReasonCodes": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisitionReasonCode" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.ProductionDataAcquisitionStatus": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "name": { "maxLength": 50, "minLength": 0, "type": "string" }, "sortOrder": { "type": "integer", "format": "int32", "nullable": true }, "isTerminal": { "type": "boolean", "nullable": true }, "productionDataAcquisitions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisition" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.ProductionDataAcquisitionWorkplace": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "employeeId": { "type": "integer", "format": "int32", "nullable": true }, "statusId": { "type": "integer", "format": "int32" }, "info": { "type": "string", "nullable": true }, "costCenterId": { "type": "integer", "format": "int32", "nullable": true }, "hourlyRate": { "type": "number", "format": "double", "nullable": true }, "capacityPerHour": { "type": "number", "format": "double", "nullable": true }, "setupTimeMinutes": { "type": "integer", "format": "int32", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "costCenter": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceCostCenter" }, "employee": { "$ref": "#/components/schemas/XERP.Shared.Models.Employee" }, "status": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisitionWorkplaceStatus" }, "productionDataAcquisitionWorkplaceSessions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisitionWorkplaceSession" }, "nullable": true }, "productionDataAcquisitions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisition" }, "nullable": true }, "productionPositionTimerStates": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionTimerState" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.ProductionDataAcquisitionWorkplaceSession": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "workplaceId": { "type": "integer", "format": "int32" }, "employeeId": { "type": "integer", "format": "int32" }, "productionPositionId": { "type": "integer", "format": "int32", "nullable": true }, "loginAt": { "type": "string", "format": "date-time", "nullable": true }, "logoutAt": { "type": "string", "format": "date-time", "nullable": true }, "shiftId": { "type": "integer", "format": "int32", "nullable": true }, "isActive": { "type": "number", "format": "double", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "employee": { "$ref": "#/components/schemas/XERP.Shared.Models.Employee" }, "productionPosition": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPosition" }, "workplace": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisitionWorkplace" }, "productionDataAcquisitions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisition" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.ProductionDataAcquisitionWorkplaceStatus": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "productionDataAcquisitionWorkplaces": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisitionWorkplace" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.ProductionDurationUnit": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 1, "minLength": 0, "type": "string", "nullable": true }, "name": { "maxLength": 20, "minLength": 0, "type": "string" }, "articleUoMs": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleUoM" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.ProductionGanttChartModel": { "type": "object", "properties": { "taskId": { "type": "integer", "format": "int32" }, "quantityPlanned": { "type": "number", "format": "double" }, "productionOrderNumber": { "type": "string", "nullable": true }, "uoM": { "type": "string", "nullable": true }, "productId": { "type": "string", "nullable": true }, "name1": { "type": "string", "nullable": true }, "duration": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "parentId": { "type": "integer", "format": "int32", "nullable": true }, "productionStartDate": { "type": "string", "format": "date-time", "nullable": true }, "productionEndDate": { "type": "string", "format": "date-time", "nullable": true }, "progress": { "type": "integer", "format": "int32", "nullable": true }, "manual": { "type": "string", "nullable": true }, "manualBool": { "type": "boolean" }, "taskType": { "type": "string", "nullable": true }, "bgcolorCode": { "type": "string", "nullable": true }, "resourceGroupId": { "type": "integer", "format": "int32", "nullable": true }, "predecessor": { "type": "string", "nullable": true }, "positionTypeId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.ProductionPosition": { "required": [ "positionTypeId", "taskMode" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "productionId": { "type": "integer", "format": "int32" }, "rowNumber": { "type": "integer", "format": "int32" }, "positionTypeId": { "maxLength": 15, "minLength": 0, "type": "string" }, "articleProductionStepComponentTypeId": { "type": "integer", "format": "int32" }, "positionNumber": { "type": "integer", "format": "int32" }, "parentPositionId": { "type": "integer", "format": "int32", "nullable": true }, "childPositionNumber": { "type": "integer", "format": "int32", "nullable": true }, "productionStatusId": { "maxLength": 12, "minLength": 0, "type": "string", "nullable": true }, "articleId": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "name1": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "name2": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "quantityFactor": { "type": "number", "format": "double" }, "uoMId": { "type": "integer", "format": "int32", "nullable": true }, "positionQuantityPlanned": { "type": "number", "format": "double" }, "positionQuantityOpen": { "type": "number", "format": "double" }, "positionQuantityConfirmed": { "type": "number", "format": "double" }, "positionQuantityPick": { "type": "number", "format": "double" }, "positionQuantityPacked": { "type": "number", "format": "double" }, "positionQuantityIssued": { "type": "number", "format": "double" }, "positionQuantityConsumed": { "type": "number", "format": "double" }, "positionQuantityOrdered": { "type": "number", "format": "double" }, "positionQuantityAnnounced": { "type": "number", "format": "double" }, "positionQuantityCompleted": { "type": "number", "format": "double" }, "positionQuantityScrap": { "type": "number", "format": "double" }, "positionPlannedStart": { "type": "string", "format": "date-time", "nullable": true }, "positionPlannedEnd": { "type": "string", "format": "date-time", "nullable": true }, "positionActualStart": { "type": "string", "format": "date-time", "nullable": true }, "positionActualEnd": { "type": "string", "format": "date-time", "nullable": true }, "positionSetupSeconds": { "type": "integer", "format": "int32", "nullable": true }, "positionRunSeconds": { "type": "integer", "format": "int32", "nullable": true }, "positionDowntimeSeconds": { "type": "integer", "format": "int32", "nullable": true }, "positionPauseSeconds": { "type": "integer", "format": "int32", "nullable": true }, "lastBdeState": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "lastBdeStateAt": { "type": "string", "format": "date-time", "nullable": true }, "costPricePerUnit": { "type": "number", "format": "double" }, "costPriceTotal": { "type": "number", "format": "double" }, "level": { "type": "integer", "format": "int32", "nullable": true }, "positionLabel": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "dissolve": { "type": "boolean" }, "relatedPositionId": { "type": "integer", "format": "int32", "nullable": true }, "subTaskId": { "type": "integer", "format": "int32", "nullable": true }, "progress": { "type": "integer", "format": "int32", "nullable": true }, "predecessorTask": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "taskMode": { "maxLength": 6, "minLength": 0, "type": "string" }, "secondsOffset": { "type": "integer", "format": "int32", "nullable": true }, "warehousingEffectiveId": { "type": "integer", "format": "int32", "nullable": true }, "pending": { "type": "boolean" }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "article": { "$ref": "#/components/schemas/XERP.Shared.Models.Article" }, "articleProductionStepComponentType": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProductionStepComponentType" }, "parentPosition": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPosition" }, "positionType": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionType" }, "production": { "$ref": "#/components/schemas/XERP.Shared.Models.Production" }, "productionStatus": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionStatus" }, "relatedPosition": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPosition" }, "subTask": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPosition" }, "uoM": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleUoM" }, "warehousingEffective": { "$ref": "#/components/schemas/XERP.Shared.Models.DocTypeWarehousingEffective" }, "inverseParentPosition": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPosition" }, "nullable": true }, "inverseRelatedPosition": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPosition" }, "nullable": true }, "inverseSubTask": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPosition" }, "nullable": true }, "procurements": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Procurement" }, "nullable": true }, "productionDataAcquisitionWorkplaceSessions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisitionWorkplaceSession" }, "nullable": true }, "productionDataAcquisitions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisition" }, "nullable": true }, "productionPositionResourceSegments": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionResourceSegment" }, "nullable": true }, "productionPositionResources": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionResource" }, "nullable": true }, "productionPositionWarehousings": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionWarehousing" }, "nullable": true }, "timeTrackings": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.TimeTracking" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.ProductionPositionModel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "positionPlannedStart": { "type": "string", "format": "date-time", "nullable": true }, "positionPlannedEnd": { "type": "string", "format": "date-time", "nullable": true }, "progress": { "type": "integer", "format": "int32", "nullable": true }, "taskMode": { "type": "string", "nullable": true }, "predecessorTask": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.ProductionPositionResource": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "positionId": { "type": "integer", "format": "int32" }, "resourceId": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "resourceStart": { "type": "string", "format": "date-time", "nullable": true }, "resourceEnd": { "type": "string", "format": "date-time", "nullable": true }, "durationHour": { "type": "number", "format": "double", "nullable": true }, "unit": { "type": "number", "format": "double", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "position": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPosition" }, "resource": { "$ref": "#/components/schemas/XERP.Shared.Models.Resource" }, "productionPositionResourceSegments": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionResourceSegment" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.ProductionPositionResourceGroup": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 50, "minLength": 0, "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.ProductionPositionResourceSegment": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "productionPositionId": { "type": "integer", "format": "int32" }, "productionPositionResourceId": { "type": "integer", "format": "int32", "nullable": true }, "segmentStartTime": { "type": "string", "format": "date-time", "nullable": true }, "segmentEndTime": { "type": "string", "format": "date-time", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "productionPosition": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPosition" }, "productionPositionResource": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionResource" } }, "additionalProperties": false }, "XERP.Shared.Models.ProductionPositionTimerState": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "productionId": { "type": "integer", "format": "int32" }, "currentState": { "type": "integer", "format": "int32" }, "phaseStartedAt": { "type": "string", "format": "date-time", "nullable": true }, "runStartedAt": { "type": "string", "format": "date-time", "nullable": true }, "finishedAt": { "type": "string", "format": "date-time", "nullable": true }, "runElapsedSecond": { "type": "integer", "format": "int32", "nullable": true }, "setupElapsedSecond": { "type": "integer", "format": "int32", "nullable": true }, "downtimeElapsedSeconds": { "type": "integer", "format": "int32", "nullable": true }, "pendingDowntime": { "type": "boolean", "nullable": true }, "downtimeReasonCodeId": { "maxLength": 40, "minLength": 0, "type": "string", "nullable": true }, "runningEmployeeId": { "type": "integer", "format": "int32", "nullable": true }, "runningWorkplaceId": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "downtimeReasonCode": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisitionReasonCode" }, "production": { "$ref": "#/components/schemas/XERP.Shared.Models.Production" }, "runningEmployee": { "$ref": "#/components/schemas/XERP.Shared.Models.Employee" }, "runningWorkplace": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisitionWorkplace" } }, "additionalProperties": false }, "XERP.Shared.Models.ProductionPositionType": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 15, "minLength": 0, "type": "string", "nullable": true }, "name": { "maxLength": 20, "minLength": 0, "type": "string" }, "switchable": { "type": "boolean" }, "productionPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPosition" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.ProductionPositionWarehousing": { "required": [ "individualizationTypeId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "productionPositionId": { "type": "integer", "format": "int32" }, "warehouseId": { "type": "integer", "format": "int32", "nullable": true }, "binLocationId": { "type": "integer", "format": "int32", "nullable": true }, "individualizationTypeId": { "maxLength": 6, "minLength": 0, "type": "string" }, "individualizationNumberId": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "quantity": { "type": "number", "format": "double" }, "warehousingEffective": { "type": "integer", "format": "int32" }, "warehousingQuantity": { "type": "number", "format": "double", "nullable": true }, "warehouseMediumId": { "type": "integer", "format": "int32", "nullable": true }, "issued": { "type": "boolean" }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "binLocation": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseBinLocation" }, "individualizationNumber": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleIndividualization" }, "individualizationType": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleIndividualizationType" }, "productionPosition": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPosition" }, "warehouse": { "$ref": "#/components/schemas/XERP.Shared.Models.Warehouse" }, "warehouseMedium": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseMedium" }, "warehousingEffectiveNavigation": { "$ref": "#/components/schemas/XERP.Shared.Models.DocTypeWarehousingEffective" } }, "additionalProperties": false }, "XERP.Shared.Models.ProductionPositionWarehousing_DeleteRequest": { "type": "object", "properties": { "warehousingId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.ProductionPositionWarehousing_GetAllFromViewByValueRequest": { "type": "object", "properties": { "propertyName": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.ProductionPositionWarehousing_InsertRequest": { "type": "object", "properties": { "productionPositionId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.ProductionPositionWarehousing_ProductionIdRequest": { "type": "object", "properties": { "productionId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.ProductionPositionWarehousing_UpdateBinLocationIdRequest": { "type": "object", "properties": { "warehousingId": { "type": "integer", "format": "int32" }, "binLocationId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.ProductionPositionWarehousing_UpdateIndividualizationNumberIdRequest": { "type": "object", "properties": { "warehousingId": { "type": "integer", "format": "int32" }, "individualizationNumberId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.ProductionPositionWarehousing_UpdateQuantityRequest": { "type": "object", "properties": { "warehousingId": { "type": "integer", "format": "int32" }, "quantity": { "type": "number", "format": "double" } }, "additionalProperties": false }, "XERP.Shared.Models.ProductionPositionWarehousing_UpdateWarehouseIdRequest": { "type": "object", "properties": { "warehousingId": { "type": "integer", "format": "int32" }, "warehouseId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.ProductionPositionWarehousing_UpdateWarehouseMediumIdRequest": { "type": "object", "properties": { "warehousingId": { "type": "integer", "format": "int32" }, "warehouseMediumId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.ProductionPosition_GetWithQuantitiesRequest": { "type": "object", "properties": { "productionId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.ProductionPosition_Sproc_UpdateField": { "type": "object", "properties": { "productionPositionId": { "type": "integer", "format": "int32" }, "fieldName": { "type": "string", "nullable": true }, "fieldValue": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.ProductionSegmentModel": { "type": "object", "properties": { "segmentId": { "type": "integer", "format": "int32" }, "taskId": { "type": "integer", "format": "int32" }, "segmentStartTime": { "type": "string", "format": "date-time" }, "segmentEndTime": { "type": "string", "format": "date-time" }, "segmentDuration": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.ProductionStatus": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 12, "minLength": 0, "type": "string", "nullable": true }, "name": { "maxLength": 20, "minLength": 0, "type": "string" }, "productionPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPosition" }, "nullable": true }, "productions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Production" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.Production_AnnounceQuantityRequest": { "type": "object", "properties": { "productionId": { "type": "integer", "format": "int32" }, "announceQuantity": { "type": "number", "format": "double" } }, "additionalProperties": false }, "XERP.Shared.Models.Production_CreateNewOrderRequest": { "type": "object", "properties": { "articleId": { "type": "string", "nullable": true }, "createdById": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.Production_IdRequest": { "type": "object", "properties": { "productionId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.Production_IssueQuantityRequest": { "type": "object", "properties": { "productionId": { "type": "integer", "format": "int32" }, "issueQuantity": { "type": "number", "format": "double" } }, "additionalProperties": false }, "XERP.Shared.Models.Production_PickQuantityRequest": { "type": "object", "properties": { "productionId": { "type": "integer", "format": "int32" }, "pickQuantity": { "type": "number", "format": "double" } }, "additionalProperties": false }, "XERP.Shared.Models.Production_ReserveQuantityRequest": { "type": "object", "properties": { "productionId": { "type": "integer", "format": "int32" }, "reserveQuantity": { "type": "number", "format": "double" } }, "additionalProperties": false }, "XERP.Shared.Models.Production_SetFirstNumberRequest": { "type": "object", "properties": { "firstProductionNumber": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.Production_Sproc_UpdateField": { "type": "object", "properties": { "docId": { "type": "integer", "format": "int32" }, "fieldName": { "type": "string", "nullable": true }, "fieldValue": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.Project": { "required": [ "name", "projectStatusId", "taskMode" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 100, "minLength": 0, "type": "string" }, "customerId": { "type": "integer", "format": "int32" }, "projectDate": { "type": "string", "format": "date-time" }, "projectStatusId": { "maxLength": 10, "minLength": 0, "type": "string" }, "clerkId": { "type": "integer", "format": "int32", "nullable": true }, "deadline": { "type": "string", "format": "date-time", "nullable": true }, "ourReference": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "remark": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "subjectCustomer": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "parentId": { "type": "integer", "format": "int32", "nullable": true }, "startTime": { "type": "string", "format": "date-time", "nullable": true }, "endTime": { "type": "string", "format": "date-time", "nullable": true }, "progress": { "type": "integer", "format": "int32", "nullable": true }, "predecessorTaskDependencyTypeId": { "maxLength": 2, "minLength": 0, "type": "string", "nullable": true }, "predecessorTask": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "taskMode": { "maxLength": 6, "minLength": 0, "type": "string" }, "secondsOffset": { "type": "integer", "format": "int32", "nullable": true }, "budget": { "type": "number", "format": "double" }, "downPaymentSum": { "type": "number", "format": "double" }, "balanceDue": { "type": "number", "format": "double", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "clerk": { "$ref": "#/components/schemas/XERP.Shared.Models.Employee" }, "customer": { "$ref": "#/components/schemas/XERP.Shared.Models.Partner" }, "parent": { "$ref": "#/components/schemas/XERP.Shared.Models.Project" }, "predecessorTaskDependencyType": { "$ref": "#/components/schemas/XERP.Shared.Models.ProjectDependencyType" }, "projectStatus": { "$ref": "#/components/schemas/XERP.Shared.Models.ProjectStatus" }, "docPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition" }, "nullable": true }, "docXmlPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXmlPosition" }, "nullable": true }, "docXmls": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXml" }, "nullable": true }, "docs": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc" }, "nullable": true }, "financePostingPositionDrafts": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionDraft" }, "nullable": true }, "financePostingPositionTemplates": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPositionTemplate" }, "nullable": true }, "financePostingPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinancePostingPosition" }, "nullable": true }, "financeTransferPositionAccountPlans": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransferPositionAccountPlan" }, "nullable": true }, "inverseParent": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Project" }, "nullable": true }, "productions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Production" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.ProjectDependencyType": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 2, "minLength": 0, "type": "string", "nullable": true }, "name": { "maxLength": 30, "minLength": 0, "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "projects": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Project" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.ProjectStatus": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 10, "minLength": 0, "type": "string", "nullable": true }, "name": { "maxLength": 20, "minLength": 0, "type": "string" }, "projects": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Project" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.PropertyFilter": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.QuantityCompletedResult": { "type": "object", "properties": { "warehousingId": { "type": "integer", "format": "int32", "nullable": true }, "positionNumber": { "type": "integer", "format": "int32", "nullable": true }, "productionPositionId": { "type": "integer", "format": "int32", "nullable": true }, "articleId": { "type": "string", "nullable": true }, "text": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.ReportTemplate": { "required": [ "name", "reportTemplateXml", "reportTypeId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 100, "minLength": 0, "type": "string" }, "reportTemplateXml": { "minLength": 1, "type": "string" }, "reportTypeId": { "maxLength": 100, "minLength": 0, "type": "string" }, "docTypeId": { "maxLength": 35, "minLength": 0, "type": "string", "nullable": true }, "successorId": { "type": "integer", "format": "int32", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "docType": { "$ref": "#/components/schemas/XERP.Shared.Models.DocType" }, "reportType": { "$ref": "#/components/schemas/XERP.Shared.Models.ReportType" }, "successor": { "$ref": "#/components/schemas/XERP.Shared.Models.ReportTemplate" }, "docTypes": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocType" }, "nullable": true }, "financeDunnings": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceDunning" }, "nullable": true }, "inverseSuccessor": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ReportTemplate" }, "nullable": true }, "partnerDetailOutputs": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDetailOutput" }, "nullable": true }, "webshopSettings": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopSetting" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.ReportTemplateListItem": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.ReportTemplate_GetDocReportTemplatesRequest": { "type": "object", "properties": { "docTypeId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.ReportType": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "name": { "maxLength": 100, "minLength": 0, "type": "string" }, "reportTemplates": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ReportTemplate" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.Resource": { "required": [ "matchcode", "name1" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "name1": { "maxLength": 100, "minLength": 0, "type": "string" }, "name2": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "matchcode": { "maxLength": 50, "minLength": 0, "type": "string" }, "resourceGroupId": { "type": "integer", "format": "int32" }, "active": { "type": "boolean" }, "favorite": { "type": "boolean" }, "manufacturerId": { "type": "integer", "format": "int32", "nullable": true }, "manufacturerOrderNumber": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "warehouseInfoId": { "type": "integer", "format": "int32", "nullable": true }, "weight": { "type": "number", "format": "double", "nullable": true }, "length": { "type": "number", "format": "double", "nullable": true }, "width": { "type": "number", "format": "double", "nullable": true }, "height": { "type": "number", "format": "double", "nullable": true }, "volume": { "type": "number", "format": "double", "nullable": true }, "secondsPerCycle": { "type": "number", "format": "double", "nullable": true }, "quantityPerCycle": { "type": "number", "format": "double", "nullable": true }, "minimumQuantity": { "type": "number", "format": "double", "nullable": true }, "priceUnitId": { "type": "integer", "format": "int32" }, "costsPerCycle": { "type": "number", "format": "double", "nullable": true }, "setupCost": { "type": "number", "format": "double", "nullable": true }, "costsPerHour": { "type": "number", "format": "double", "nullable": true }, "quantityFormular": { "maxLength": 1000, "minLength": 0, "type": "string", "nullable": true }, "priceFormular": { "maxLength": 1000, "minLength": 0, "type": "string", "nullable": true }, "timeFormular": { "maxLength": 1000, "minLength": 0, "type": "string", "nullable": true }, "info": { "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "priceUnit": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticlePriceUnit" }, "resourceGroup": { "$ref": "#/components/schemas/XERP.Shared.Models.ResourceGroup" }, "articleProductionStepResources": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProductionStepResource" }, "nullable": true }, "productionDataAcquisitions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionDataAcquisition" }, "nullable": true }, "productionPositionResources": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionResource" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.ResourceAssignmentModel": { "type": "object", "properties": { "primaryId": { "type": "integer", "format": "int32" }, "taskId": { "type": "integer", "format": "int32" }, "resourceId": { "type": "string", "nullable": true }, "unit": { "type": "number", "format": "double" } }, "additionalProperties": false }, "XERP.Shared.Models.ResourceGroup": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 50, "minLength": 0, "type": "string" }, "parentId": { "type": "integer", "format": "int32", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "parent": { "$ref": "#/components/schemas/XERP.Shared.Models.ResourceGroup" }, "articleProductionStepResources": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleProductionStepResource" }, "nullable": true }, "inverseParent": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ResourceGroup" }, "nullable": true }, "resources": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Resource" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.RoleAllPagesPermissionDto": { "type": "object", "properties": { "pageId": { "type": "string", "nullable": true }, "read": { "type": "boolean" }, "create": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" }, "roleName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.RoleAllWebApisPermissionDto": { "type": "object", "properties": { "webApiId": { "type": "string", "nullable": true }, "read": { "type": "boolean" }, "create": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" }, "roleName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.SalesPersonIdResult": { "type": "object", "properties": { "commissionPercent": { "type": "number", "format": "double", "nullable": true }, "commissionAmount": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.SaveDraftWarehousingResult": { "type": "object", "properties": { "warehousingId": { "type": "integer", "format": "int32", "nullable": true }, "positionNumber": { "type": "integer", "format": "int32", "nullable": true }, "childPositionNumber": { "type": "integer", "format": "int32", "nullable": true }, "docPositionId": { "type": "integer", "format": "int32", "nullable": true }, "articleId": { "type": "string", "nullable": true }, "text": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.SaveWarehouseInventoryCountingDraftResult": { "type": "object", "properties": { "warehouseInventoryCountingPositionId": { "type": "integer", "format": "int32", "nullable": true }, "articleId": { "type": "string", "nullable": true }, "individualizationNumberId": { "type": "string", "nullable": true }, "text": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.SaveWarehouseInventoryRevaluationDraftResult": { "type": "object", "properties": { "warehouseInventoryRevaluationPositionId": { "type": "integer", "format": "int32", "nullable": true }, "articleId": { "type": "string", "nullable": true }, "text": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.SaveWarehouseTransferDraftResult": { "type": "object", "properties": { "warehouseTransferPosition": { "type": "integer", "format": "int32", "nullable": true }, "positionNumber": { "type": "integer", "format": "int32", "nullable": true }, "articleId": { "type": "string", "nullable": true }, "individualizationNumberId": { "type": "string", "nullable": true }, "text": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.ServerInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.ShippingCarrier": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "name": { "maxLength": 50, "minLength": 0, "type": "string" }, "url": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "shippingTypes": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ShippingType" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.ShippingRate": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "shippingTypeId": { "type": "integer", "format": "int32", "nullable": true }, "shippingZoneId": { "type": "integer", "format": "int32", "nullable": true }, "minWeight": { "type": "number", "format": "double", "nullable": true }, "price": { "type": "number", "format": "double", "nullable": true }, "foreignCurrencyId": { "maxLength": 3, "minLength": 0, "type": "string", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "foreignCurrency": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCurrency" }, "shippingType": { "$ref": "#/components/schemas/XERP.Shared.Models.ShippingType" }, "shippingZone": { "$ref": "#/components/schemas/XERP.Shared.Models.ShippingZone" } }, "additionalProperties": false }, "XERP.Shared.Models.ShippingType": { "required": [ "carrierCode", "name", "shippingTypeCode" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 100, "minLength": 0, "type": "string" }, "shippingTypeCode": { "maxLength": 30, "minLength": 0, "type": "string" }, "carrierCode": { "maxLength": 30, "minLength": 0, "type": "string" }, "url": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "carrierCodeNavigation": { "$ref": "#/components/schemas/XERP.Shared.Models.ShippingCarrier" }, "packingListBoxes": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PackingListBox" }, "nullable": true }, "shippingRates": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ShippingRate" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.ShippingZone": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 50, "minLength": 0, "type": "string" }, "isDefault": { "type": "boolean" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "docDeliveryAddresses": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocDeliveryAddress" }, "nullable": true }, "partnerDeliveryAddresses": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDeliveryAddress" }, "nullable": true }, "shippingRates": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ShippingRate" }, "nullable": true }, "shippingZoneCountries": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ShippingZoneCountry" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.ShippingZoneCountry": { "required": [ "countryId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "shippingZoneId": { "type": "integer", "format": "int32", "nullable": true }, "countryId": { "maxLength": 2, "minLength": 0, "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "country": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCountry" }, "shippingZone": { "$ref": "#/components/schemas/XERP.Shared.Models.ShippingZone" } }, "additionalProperties": false }, "XERP.Shared.Models.SmartPool": { "required": [ "computerFile" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "fileGuid": { "type": "string", "format": "uuid" }, "computerFile": { "type": "string", "format": "byte" }, "tags": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "fileName": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "fileType": { "maxLength": 75, "minLength": 0, "type": "string", "nullable": true }, "fileDate": { "type": "string", "format": "date-time", "nullable": true }, "fileSizeMb": { "type": "integer", "format": "int64", "nullable": true }, "ocrProcessing": { "type": "boolean", "nullable": true }, "embeddingProcessing": { "type": "boolean", "nullable": true }, "computerFileHash": { "maxLength": 32, "type": "string", "format": "byte", "nullable": true }, "version": { "type": "integer", "format": "int32" }, "blocked": { "type": "boolean" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "smartPoolEmbeddingQueue": { "$ref": "#/components/schemas/XERP.Shared.Models.SmartPoolEmbeddingQueue" }, "smartPoolApprovals": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.SmartPoolApproval" }, "nullable": true }, "smartPoolDocumentAnalyses": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.SmartPoolDocumentAnalysis" }, "nullable": true }, "smartPoolEmbeddingStatuses": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.SmartPoolEmbeddingStatus" }, "nullable": true }, "smartPoolEmbeddings": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.SmartPoolEmbedding" }, "nullable": true }, "smartPoolLinkedEntities": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.SmartPoolLinkedEntity" }, "nullable": true }, "smartPoolOcrs": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.SmartPoolOcr" }, "nullable": true }, "smartPoolPageAnalyses": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.SmartPoolPageAnalysis" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.SmartPoolApproval": { "required": [ "blocked" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "status": { "type": "string", "nullable": true, "readOnly": true }, "id": { "type": "integer", "format": "int32" }, "smartPoolId": { "type": "integer", "format": "int32" }, "info": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "blocked": { "type": "boolean" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "smartPool": { "$ref": "#/components/schemas/XERP.Shared.Models.SmartPool" } }, "additionalProperties": false }, "XERP.Shared.Models.SmartPoolDocumentAnalysis": { "required": [ "visionModel" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "smartPoolId": { "type": "integer", "format": "int32" }, "visionModel": { "maxLength": 200, "minLength": 0, "type": "string" }, "documentType": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "language": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "summary": { "type": "string", "nullable": true }, "pageCount": { "type": "integer", "format": "int32" }, "keywords": { "type": "string", "nullable": true }, "extractedFields": { "type": "string", "nullable": true }, "extractedTables": { "type": "string", "nullable": true }, "extractedCharts": { "type": "string", "nullable": true }, "extractedSignatures": { "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "smartPool": { "$ref": "#/components/schemas/XERP.Shared.Models.SmartPool" } }, "additionalProperties": false }, "XERP.Shared.Models.SmartPoolEmbedding": { "required": [ "chunkText", "embeddingModel", "sourceType", "visionModel" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "smartPoolId": { "type": "integer", "format": "int32" }, "embedding": { "$ref": "#/components/schemas/Microsoft.Data.SqlTypes.SqlVector_Of_System.Single" }, "embeddingModel": { "maxLength": 100, "minLength": 0, "type": "string" }, "chunkNumber": { "type": "integer", "format": "int32" }, "chunkText": { "minLength": 1, "type": "string" }, "pageNumber": { "type": "integer", "format": "int32", "nullable": true }, "sourceType": { "maxLength": 20, "minLength": 0, "type": "string" }, "visionModel": { "maxLength": 100, "minLength": 0, "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "smartPool": { "$ref": "#/components/schemas/XERP.Shared.Models.SmartPool" } }, "additionalProperties": false }, "XERP.Shared.Models.SmartPoolEmbeddingQueue": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "smartPoolId": { "type": "integer", "format": "int32" }, "dateCreated": { "type": "string", "format": "date-time" }, "smartPool": { "$ref": "#/components/schemas/XERP.Shared.Models.SmartPool" } }, "additionalProperties": false }, "XERP.Shared.Models.SmartPoolEmbeddingStatus": { "required": [ "embeddingModel", "sourceType", "status", "visionModel" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "smartPoolId": { "type": "integer", "format": "int32" }, "embeddingModel": { "maxLength": 100, "minLength": 0, "type": "string" }, "status": { "maxLength": 50, "minLength": 0, "type": "string" }, "attemptCount": { "type": "integer", "format": "int32" }, "lastError": { "maxLength": 4000, "minLength": 0, "type": "string", "nullable": true }, "processedAt": { "type": "string", "format": "date-time", "nullable": true }, "sourceType": { "maxLength": 20, "minLength": 0, "type": "string" }, "visionModel": { "maxLength": 100, "minLength": 0, "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "smartPool": { "$ref": "#/components/schemas/XERP.Shared.Models.SmartPool" } }, "additionalProperties": false }, "XERP.Shared.Models.SmartPoolLinkedEntity": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "smartPoolId": { "type": "integer", "format": "int32", "nullable": true }, "entityType": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "entityId": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "smartPool": { "$ref": "#/components/schemas/XERP.Shared.Models.SmartPool" } }, "additionalProperties": false }, "XERP.Shared.Models.SmartPoolOcr": { "required": [ "status" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "smartPoolId": { "type": "integer", "format": "int32" }, "ocrContent": { "type": "string", "nullable": true }, "ocrContentFormat": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "ocrPlainText": { "type": "string", "nullable": true }, "ocrConfidence": { "type": "number", "format": "double", "nullable": true }, "pageCount": { "type": "integer", "format": "int32", "nullable": true }, "detectedLanguage": { "maxLength": 10, "minLength": 0, "type": "string", "nullable": true }, "ocrStructured": { "type": "string", "nullable": true }, "errorMessage": { "maxLength": 2000, "minLength": 0, "type": "string", "nullable": true }, "durationMs": { "type": "integer", "format": "int32", "nullable": true }, "status": { "maxLength": 75, "minLength": 0, "type": "string" }, "processedAt": { "type": "string", "format": "date-time", "nullable": true }, "ocrEngine": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "smartPool": { "$ref": "#/components/schemas/XERP.Shared.Models.SmartPool" } }, "additionalProperties": false }, "XERP.Shared.Models.SmartPoolPageAnalysis": { "required": [ "visionModel" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "smartPoolId": { "type": "integer", "format": "int32" }, "pageNumber": { "type": "integer", "format": "int32" }, "visionModel": { "maxLength": 200, "minLength": 0, "type": "string" }, "description": { "type": "string", "nullable": true }, "documentType": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "language": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "keywords": { "type": "string", "nullable": true }, "hasTables": { "type": "boolean" }, "hasCharts": { "type": "boolean" }, "hasSignatures": { "type": "boolean" }, "hasHandwriting": { "type": "boolean" }, "hasStamps": { "type": "boolean" }, "structuredData": { "type": "string", "nullable": true }, "durationMs": { "type": "integer", "format": "int64", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "smartPool": { "$ref": "#/components/schemas/XERP.Shared.Models.SmartPool" } }, "additionalProperties": false }, "XERP.Shared.Models.SmartSearchMatchKind": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32" }, "XERP.Shared.Models.SmartSearchRequest": { "type": "object", "properties": { "searchTerm": { "type": "string", "nullable": true }, "dateFrom": { "type": "string", "format": "date-time", "nullable": true }, "dateTo": { "type": "string", "format": "date-time", "nullable": true }, "searchSmartPool": { "type": "boolean" }, "searchAttachments": { "type": "boolean" }, "searchNameAndTags": { "type": "boolean" }, "searchDocumentText": { "type": "boolean" }, "searchTextMeaning": { "type": "boolean" }, "searchVisualContent": { "type": "boolean" }, "maxResults": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.SmartSearchResponse": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.SmartSearchResult" }, "nullable": true }, "indexedDocuments": { "type": "integer", "format": "int32" }, "pendingDocuments": { "type": "integer", "format": "int32" }, "failedDocuments": { "type": "integer", "format": "int32" }, "semanticSearchUnavailable": { "type": "boolean" }, "semanticSearchUnavailableReason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.SmartSearchResult": { "type": "object", "properties": { "source": { "$ref": "#/components/schemas/XERP.Shared.Models.SmartSearchSource" }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "fileName": { "type": "string", "nullable": true }, "fileType": { "type": "string", "nullable": true }, "tags": { "type": "string", "nullable": true }, "fileDate": { "type": "string", "format": "date-time", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time", "nullable": true }, "createdByMatchcode": { "type": "string", "nullable": true }, "linkedRecord": { "type": "string", "nullable": true }, "linkedEntityType": { "type": "string", "nullable": true }, "linkedEntityId": { "type": "string", "nullable": true }, "matchKind": { "$ref": "#/components/schemas/XERP.Shared.Models.SmartSearchMatchKind" }, "snippet": { "type": "string", "nullable": true }, "pageNumber": { "type": "integer", "format": "int32", "nullable": true }, "semanticDistance": { "type": "number", "format": "double", "nullable": true }, "relevance": { "type": "number", "format": "double" } }, "additionalProperties": false }, "XERP.Shared.Models.SmartSearchSource": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "XERP.Shared.Models.StatusIdResult": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "docId": { "type": "integer", "format": "int32", "nullable": true }, "rowNumber": { "type": "integer", "format": "int32", "nullable": true }, "positionTypeId": { "type": "string", "nullable": true }, "positionNumber": { "type": "integer", "format": "int32", "nullable": true }, "parentPositionId": { "type": "integer", "format": "int32", "nullable": true }, "childPositionNumber": { "type": "integer", "format": "int32", "nullable": true }, "statusId": { "type": "string", "nullable": true }, "articleId": { "type": "string", "nullable": true }, "name1": { "type": "string", "nullable": true }, "name2": { "type": "string", "nullable": true }, "quantity": { "type": "number", "format": "double", "nullable": true }, "quantityOpen": { "type": "number", "format": "double", "nullable": true }, "uoMId": { "type": "integer", "format": "int32", "nullable": true }, "shippingDate": { "type": "string", "format": "date-time" }, "deliveryDate": { "type": "string", "format": "date-time" }, "price": { "type": "number", "format": "double", "nullable": true }, "totalPrice": { "type": "number", "format": "double", "nullable": true }, "predecessorId": { "type": "integer", "format": "int32", "nullable": true }, "quantityTransferred": { "type": "number", "format": "double", "nullable": true }, "level": { "type": "integer", "format": "int32", "nullable": true }, "positionLabel": { "type": "string", "nullable": true }, "catalogNumberId": { "type": "string", "nullable": true }, "dissolve": { "type": "boolean", "nullable": true }, "positionWeight": { "type": "number", "format": "double", "nullable": true }, "relatedPositionId": { "type": "integer", "format": "int32", "nullable": true }, "projectId": { "type": "integer", "format": "int32", "nullable": true }, "start": { "type": "string", "format": "date-time", "nullable": true }, "stop": { "type": "string", "format": "date-time", "nullable": true }, "priceUnitId": { "type": "integer", "format": "int32", "nullable": true }, "costPriceTotal": { "type": "number", "format": "double", "nullable": true }, "discountPercent": { "type": "number", "format": "double", "nullable": true }, "quantityDiscountPercent": { "type": "number", "format": "double", "nullable": true }, "docDiscountPercent": { "type": "number", "format": "double", "nullable": true }, "discountedPrice": { "type": "number", "format": "double", "nullable": true }, "revenueEffective": { "type": "integer", "format": "int32", "nullable": true }, "revenue": { "type": "number", "format": "double", "nullable": true }, "salesPersonId": { "type": "integer", "format": "int32", "nullable": true }, "commissionPercent": { "type": "number", "format": "double", "nullable": true }, "commissionAmount": { "type": "number", "format": "double", "nullable": true }, "profitAmount": { "type": "number", "format": "double", "nullable": true }, "profitPercent": { "type": "number", "format": "double", "nullable": true }, "financeGroupArticleId": { "type": "integer", "format": "int32", "nullable": true }, "financeGroupPartnerDetailId": { "type": "integer", "format": "int32", "nullable": true }, "taxKeyId": { "type": "string", "nullable": true }, "taxPercent": { "type": "number", "format": "double", "nullable": true }, "tax": { "type": "number", "format": "double", "nullable": true }, "accountId": { "type": "integer", "format": "int32", "nullable": true }, "costCenterId": { "type": "integer", "format": "int32", "nullable": true }, "costBearerId": { "type": "integer", "format": "int32", "nullable": true }, "warehousing": { "type": "boolean", "nullable": true }, "warehousingEffective": { "type": "integer", "format": "int32", "nullable": true }, "warehousingQuantity": { "type": "number", "format": "double", "nullable": true }, "sysStartTime": { "type": "string", "format": "date-time", "nullable": true }, "sysEndTime": { "type": "string", "format": "date-time", "nullable": true }, "viewRowNumber": { "type": "integer", "format": "int32", "nullable": true }, "positionNumberConcat": { "type": "string", "nullable": true }, "viewRevenue": { "type": "number", "format": "double", "nullable": true }, "viewWarehousingQuantity": { "type": "number", "format": "double", "nullable": true }, "viewNowAvailable": { "type": "number", "format": "double", "nullable": true }, "docNumber": { "type": "string", "nullable": true }, "docCategoryId": { "type": "string", "nullable": true }, "docTypeId": { "type": "string", "nullable": true }, "inventoryStatusId": { "type": "string", "nullable": true }, "docWarehousingEffective": { "type": "integer", "format": "int32", "nullable": true }, "docRevenueEffective": { "type": "integer", "format": "int32", "nullable": true }, "docStatusId": { "type": "string", "nullable": true }, "partnerId": { "type": "integer", "format": "int32", "nullable": true }, "docDate": { "type": "string", "format": "date-time" }, "postingDate": { "type": "string", "format": "date-time", "nullable": true }, "stock": { "type": "number", "format": "double", "nullable": true }, "confirmed": { "type": "number", "format": "double", "nullable": true }, "packed": { "type": "number", "format": "double", "nullable": true }, "ordered": { "type": "number", "format": "double", "nullable": true }, "announced": { "type": "number", "format": "double", "nullable": true }, "nowAvailable": { "type": "number", "format": "double", "nullable": true }, "laterAvailable": { "type": "number", "format": "double", "nullable": true }, "minimumStock": { "type": "number", "format": "double", "nullable": true }, "maximumStock": { "type": "number", "format": "double", "nullable": true }, "decimalPlacesQuantitiesId": { "type": "integer", "format": "int32", "nullable": true }, "minimumQuantity": { "type": "number", "format": "double", "nullable": true }, "deliveryTime": { "type": "integer", "format": "int32", "nullable": true }, "lotSize": { "type": "number", "format": "double", "nullable": true }, "procurementPrice": { "type": "number", "format": "double", "nullable": true }, "warehouseCost": { "type": "number", "format": "double", "nullable": true }, "overheadCost": { "type": "number", "format": "double", "nullable": true }, "otherCost": { "type": "number", "format": "double", "nullable": true }, "changeInValue": { "type": "number", "format": "double", "nullable": true }, "factor": { "type": "number", "format": "double", "nullable": true }, "costPrice": { "type": "number", "format": "double", "nullable": true }, "infoText": { "type": "string", "nullable": true }, "orderText": { "type": "string", "nullable": true }, "dimensionText": { "type": "string", "nullable": true }, "matchcode": { "type": "string", "nullable": true }, "uoMName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.StickyNote": { "required": [ "text" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "text": { "maxLength": 1000, "minLength": 0, "type": "string" }, "done": { "type": "boolean" } }, "additionalProperties": false }, "XERP.Shared.Models.SupportSetting": { "required": [ "consultant" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "consultant": { "maxLength": 50, "minLength": 0, "type": "string" }, "name1": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "name2": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "name3": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "title": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "position": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "salutation": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "firstName": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "lastName": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "street": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "extension": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "zip": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "city": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "countryId": { "maxLength": 2, "minLength": 0, "type": "string", "nullable": true }, "tel1": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "tel2": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "mobile": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "fax": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "supportEmail": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "homepage": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "remark": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "senderEmail": { "maxLength": 256, "minLength": 0, "type": "string", "nullable": true }, "smtpServer": { "maxLength": 256, "minLength": 0, "type": "string", "nullable": true }, "smtpPort": { "type": "integer", "format": "int32", "nullable": true }, "ssl": { "type": "boolean" }, "password": { "maxLength": 256, "minLength": 0, "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "country": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCountry" } }, "additionalProperties": false }, "XERP.Shared.Models.SystemDataType": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "name": { "maxLength": 20, "minLength": 0, "type": "string" }, "characterLimit": { "type": "integer", "format": "int32" }, "isExtraFieldType": { "type": "boolean" }, "extraFields": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraField" }, "nullable": true }, "systemTableFields": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemTableField" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.SystemDatabaseChangeLog": { "required": [ "appVersion", "changeText", "changeType", "name", "objectName", "objectSchema", "objectType", "updateScript" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 255, "minLength": 0, "type": "string" }, "objectType": { "maxLength": 50, "minLength": 0, "type": "string" }, "objectSchema": { "maxLength": 50, "minLength": 0, "type": "string" }, "objectName": { "maxLength": 50, "minLength": 0, "type": "string" }, "changeType": { "maxLength": 50, "minLength": 0, "type": "string" }, "changeText": { "minLength": 1, "type": "string" }, "updateScript": { "minLength": 1, "type": "string" }, "appVersion": { "maxLength": 50, "minLength": 0, "type": "string" }, "appliedOn": { "type": "string", "format": "date-time" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.SystemDatabaseLanguage": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.SystemDesktop": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "name": { "maxLength": 50, "minLength": 0, "type": "string" }, "workspaceRoleDesktops": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceRoleDesktop" }, "nullable": true }, "workspaceRoleMenus": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceRoleMenu" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.SystemDesktopColumn": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.SystemKeyCombination": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "pageName": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "keyCombination": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.SystemMapping": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "formatNameId": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "sourceTag": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "systemColumnId": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "dataType": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "transformationRule": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "formatName": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemMappingFormatName" }, "systemColumn": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemMappingSystemColumn" } }, "additionalProperties": false }, "XERP.Shared.Models.SystemMappingFileType": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "name": { "maxLength": 30, "minLength": 0, "type": "string" }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "systemMappingFormatNames": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemMappingFormatName" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.SystemMappingFormatName": { "required": [ "typeId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "typeId": { "maxLength": 20, "minLength": 0, "type": "string" }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "type": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemMappingFileType" }, "financeCompanyBankAccounts": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceCompanyBankAccount" }, "nullable": true }, "financeTransfers": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceTransfer" }, "nullable": true }, "systemMappings": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemMapping" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.SystemMappingSystemColumn": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "systemMappings": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemMapping" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.SystemTable": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "extraField": { "type": "boolean" }, "extraApiEntities": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraApiEntity" }, "nullable": true }, "extraFieldForeignKeyTables": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraField" }, "nullable": true }, "extraFieldSystemTables": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ExtraField" }, "nullable": true }, "formattedSearches": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FormattedSearch" }, "nullable": true }, "systemTableFields": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemTableField" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.SystemTableField": { "required": [ "name", "systemDataTypeId", "systemTableId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "systemTableId": { "maxLength": 50, "minLength": 0, "type": "string" }, "name": { "maxLength": 50, "minLength": 0, "type": "string" }, "systemDataTypeId": { "maxLength": 20, "minLength": 0, "type": "string" }, "fieldLength": { "type": "integer", "format": "int32", "nullable": true }, "defaultValue": { "maxLength": 200, "minLength": 0, "type": "string", "nullable": true }, "systemDataType": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemDataType" }, "systemTable": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemTable" }, "formattedSearchTargetSystemTableFields": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FormattedSearch" }, "nullable": true }, "formattedSearchUpdateTriggerFields": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.FormattedSearch" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.SystemVersion": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "dbVersion": { "type": "integer", "format": "int32" }, "isDbUpdateInProgress": { "type": "boolean" }, "lastDbUpdateDate": { "type": "string", "format": "date-time" }, "lastDbUpdatedBy": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.SystemView": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.TaxKeyIdResult": { "type": "object", "properties": { "taxPercent": { "type": "number", "format": "double", "nullable": true }, "tax": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.TextBlock": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "textBlockGroupId": { "type": "integer", "format": "int32" }, "textContent": { "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "textBlockGroup": { "$ref": "#/components/schemas/XERP.Shared.Models.TextBlockGroup" } }, "additionalProperties": false }, "XERP.Shared.Models.TextBlockGroup": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 50, "minLength": 0, "type": "string" }, "parentId": { "type": "integer", "format": "int32", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "parent": { "$ref": "#/components/schemas/XERP.Shared.Models.TextBlockGroup" }, "inverseParent": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.TextBlockGroup" }, "nullable": true }, "textBlocks": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.TextBlock" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.TextVariable": { "required": [ "name", "textContent" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "name": { "maxLength": 100, "minLength": 0, "type": "string" }, "textContent": { "maxLength": 100, "minLength": 0, "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.TimeTracking": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "employeeId": { "type": "integer", "format": "int32" }, "docId": { "type": "integer", "format": "int32", "nullable": true }, "docPositionId": { "type": "integer", "format": "int32", "nullable": true }, "articleId": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "helpdeskId": { "type": "integer", "format": "int32", "nullable": true }, "partnerId": { "type": "integer", "format": "int32", "nullable": true }, "productionId": { "type": "integer", "format": "int32", "nullable": true }, "productionPositionId": { "type": "integer", "format": "int32", "nullable": true }, "info": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "trackingStart": { "type": "string", "format": "date-time" }, "trackingEnd": { "type": "string", "format": "date-time", "nullable": true }, "durationHour": { "type": "number", "format": "double", "nullable": true }, "description": { "type": "string", "nullable": true }, "billable": { "type": "boolean" }, "billed": { "type": "boolean" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "article": { "$ref": "#/components/schemas/XERP.Shared.Models.Article" }, "doc": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc" }, "docPosition": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPosition" }, "employee": { "$ref": "#/components/schemas/XERP.Shared.Models.Employee" }, "helpdesk": { "$ref": "#/components/schemas/XERP.Shared.Models.Helpdesk" }, "partner": { "$ref": "#/components/schemas/XERP.Shared.Models.Partner" }, "production": { "$ref": "#/components/schemas/XERP.Shared.Models.Production" }, "productionPosition": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPosition" } }, "additionalProperties": false }, "XERP.Shared.Models.TimeTrackingSetting": { "required": [ "docTypeId", "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 50, "minLength": 0, "type": "string" }, "description": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "legalNotice": { "type": "string", "nullable": true }, "privacyPolicy": { "type": "string", "nullable": true }, "logo": { "type": "string", "format": "byte", "nullable": true }, "url": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "templateId": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "docTypeId": { "maxLength": 35, "minLength": 0, "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "docType": { "$ref": "#/components/schemas/XERP.Shared.Models.DocType" } }, "additionalProperties": false }, "XERP.Shared.Models.ToolboxButton": { "required": [ "backgroundColor", "caption", "fontColor", "iconCssClass", "placement", "targetPageId", "uriScheme", "urlTemplate" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "targetPageId": { "maxLength": 100, "minLength": 0, "type": "string" }, "caption": { "maxLength": 100, "minLength": 0, "type": "string" }, "description": { "maxLength": 500, "minLength": 0, "type": "string", "nullable": true }, "iconCssClass": { "maxLength": 100, "minLength": 0, "type": "string" }, "backgroundColor": { "maxLength": 9, "minLength": 0, "type": "string" }, "fontColor": { "maxLength": 9, "minLength": 0, "type": "string" }, "uriScheme": { "maxLength": 20, "minLength": 0, "type": "string" }, "urlTemplate": { "maxLength": 2000, "minLength": 0, "type": "string" }, "position": { "type": "integer", "format": "int32" }, "active": { "type": "boolean" }, "openInNewWindow": { "type": "boolean" }, "requireConfirmation": { "type": "boolean" }, "confirmationText": { "maxLength": 500, "minLength": 0, "type": "string", "nullable": true }, "tooltip": { "maxLength": 500, "minLength": 0, "type": "string", "nullable": true }, "successMessage": { "maxLength": 500, "minLength": 0, "type": "string", "nullable": true }, "visibleWhenFieldName": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "visibleWhenBooleanValue": { "type": "boolean", "nullable": true }, "placement": { "maxLength": 20, "minLength": 0, "type": "string" }, "registerId": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "targetFieldName": { "maxLength": 200, "minLength": 0, "type": "string", "nullable": true }, "fieldPosition": { "maxLength": 10, "minLength": 0, "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "targetPage": { "$ref": "#/components/schemas/XERP.Shared.Models.AuthorizationPage" } }, "additionalProperties": false }, "XERP.Shared.Models.ToolboxField": { "required": [ "caption", "fieldType", "name", "targetPageId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "targetPageId": { "maxLength": 100, "minLength": 0, "type": "string" }, "name": { "maxLength": 100, "minLength": 0, "type": "string" }, "caption": { "maxLength": 100, "minLength": 0, "type": "string" }, "description": { "maxLength": 500, "minLength": 0, "type": "string", "nullable": true }, "fieldType": { "maxLength": 30, "minLength": 0, "type": "string" }, "position": { "type": "integer", "format": "int32" }, "active": { "type": "boolean" }, "mandatory": { "type": "boolean" }, "requiredWhenFieldName": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "textDefault": { "maxLength": 500, "minLength": 0, "type": "string", "nullable": true }, "booleanDefault": { "type": "boolean", "nullable": true }, "validationRegex": { "maxLength": 1000, "minLength": 0, "type": "string", "nullable": true }, "validationMessage": { "maxLength": 500, "minLength": 0, "type": "string", "nullable": true }, "integerDefault": { "type": "integer", "format": "int32", "nullable": true }, "decimalDefault": { "type": "number", "format": "double", "nullable": true }, "dateDefault": { "type": "string", "format": "date-time", "nullable": true }, "dateTimeDefault": { "type": "string", "format": "date-time", "nullable": true }, "minimumLength": { "type": "integer", "format": "int32", "nullable": true }, "maximumLength": { "type": "integer", "format": "int32", "nullable": true }, "minimumNumericValue": { "type": "number", "format": "double", "nullable": true }, "maximumNumericValue": { "type": "number", "format": "double", "nullable": true }, "minimumDateValue": { "type": "string", "format": "date-time", "nullable": true }, "maximumDateValue": { "type": "string", "format": "date-time", "nullable": true }, "visibleWhenFieldName": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "visibleWhenBooleanValue": { "type": "boolean", "nullable": true }, "readOnly": { "type": "boolean" }, "readOnlyWhenFieldName": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "readOnlyWhenBooleanValue": { "type": "boolean", "nullable": true }, "requiredWhenBooleanValue": { "type": "boolean", "nullable": true }, "appearance": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "appearanceWhenFieldName": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "appearanceWhenBooleanValue": { "type": "boolean", "nullable": true }, "placement": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "registerId": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "targetFieldName": { "maxLength": 200, "minLength": 0, "type": "string", "nullable": true }, "fieldPosition": { "maxLength": 10, "minLength": 0, "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "formulaExpression": { "maxLength": 1000, "minLength": 0, "type": "string", "nullable": true }, "sourceTableName": { "maxLength": 128, "minLength": 0, "type": "string", "nullable": true }, "sourceIdFieldName": { "maxLength": 128, "minLength": 0, "type": "string", "nullable": true }, "sourceNameFieldName": { "maxLength": 128, "minLength": 0, "type": "string", "nullable": true }, "targetPage": { "$ref": "#/components/schemas/XERP.Shared.Models.AuthorizationPage" }, "toolboxFieldOptions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldOption" }, "nullable": true }, "toolboxFieldValues": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldValue" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.ToolboxFieldOption": { "required": [ "caption", "value" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "toolboxFieldId": { "type": "integer", "format": "int32" }, "value": { "maxLength": 500, "minLength": 0, "type": "string" }, "caption": { "maxLength": 100, "minLength": 0, "type": "string" }, "position": { "type": "integer", "format": "int32" }, "enabled": { "type": "boolean" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "toolboxField": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxField" } }, "additionalProperties": false }, "XERP.Shared.Models.ToolboxFieldOptionDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "value": { "type": "string", "nullable": true }, "caption": { "type": "string", "nullable": true }, "position": { "type": "integer", "format": "int32" }, "enabled": { "type": "boolean" } }, "additionalProperties": false }, "XERP.Shared.Models.ToolboxFieldRuntimeSaveRequest": { "type": "object", "properties": { "targetPageId": { "type": "string", "nullable": true }, "recordId": { "type": "string", "nullable": true }, "values": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldRuntimeValue" }, "nullable": true }, "hostBooleanValues": { "type": "object", "additionalProperties": { "type": "boolean", "nullable": true }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.ToolboxFieldRuntimeValue": { "type": "object", "properties": { "toolboxFieldId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "caption": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "fieldType": { "type": "string", "nullable": true }, "placement": { "type": "string", "nullable": true }, "registerId": { "type": "string", "nullable": true }, "targetFieldName": { "type": "string", "nullable": true }, "fieldPosition": { "type": "string", "nullable": true }, "position": { "type": "integer", "format": "int32" }, "mandatory": { "type": "boolean" }, "requiredWhenFieldName": { "type": "string", "nullable": true }, "requiredWhenBooleanValue": { "type": "boolean", "nullable": true }, "validationRegex": { "type": "string", "nullable": true }, "validationMessage": { "type": "string", "nullable": true }, "minimumLength": { "type": "integer", "format": "int32", "nullable": true }, "maximumLength": { "type": "integer", "format": "int32", "nullable": true }, "minimumNumericValue": { "type": "number", "format": "double", "nullable": true }, "maximumNumericValue": { "type": "number", "format": "double", "nullable": true }, "minimumDateValue": { "type": "string", "format": "date-time", "nullable": true }, "maximumDateValue": { "type": "string", "format": "date-time", "nullable": true }, "visibleWhenFieldName": { "type": "string", "nullable": true }, "visibleWhenBooleanValue": { "type": "boolean", "nullable": true }, "readOnly": { "type": "boolean" }, "readOnlyWhenFieldName": { "type": "string", "nullable": true }, "readOnlyWhenBooleanValue": { "type": "boolean", "nullable": true }, "appearance": { "type": "string", "nullable": true }, "appearanceWhenFieldName": { "type": "string", "nullable": true }, "appearanceWhenBooleanValue": { "type": "boolean", "nullable": true }, "options": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxFieldOptionDto" }, "nullable": true }, "sourceTableName": { "type": "string", "nullable": true }, "sourceIdFieldName": { "type": "string", "nullable": true }, "sourceNameFieldName": { "type": "string", "nullable": true }, "textValue": { "type": "string", "nullable": true }, "booleanValue": { "type": "boolean", "nullable": true }, "integerValue": { "type": "integer", "format": "int32", "nullable": true }, "decimalValue": { "type": "number", "format": "double", "nullable": true }, "dateValue": { "type": "string", "format": "date-time", "nullable": true }, "dateTimeValue": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.ToolboxFieldValue": { "required": [ "recordId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int64" }, "toolboxFieldId": { "type": "integer", "format": "int32" }, "recordId": { "maxLength": 100, "minLength": 0, "type": "string" }, "textValue": { "maxLength": 2000, "minLength": 0, "type": "string", "nullable": true }, "booleanValue": { "type": "boolean", "nullable": true }, "integerValue": { "type": "integer", "format": "int32", "nullable": true }, "decimalValue": { "type": "number", "format": "double", "nullable": true }, "dateValue": { "type": "string", "format": "date-time", "nullable": true }, "dateTimeValue": { "type": "string", "format": "date-time", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "toolboxField": { "$ref": "#/components/schemas/XERP.Shared.Models.ToolboxField" } }, "additionalProperties": false }, "XERP.Shared.Models.TransferDocXmlToDocErrorMessages": { "type": "object", "properties": { "positionNumber": { "type": "integer", "format": "int32", "nullable": true }, "text": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.TranslationArticleInfoText": { "required": [ "articleId", "articleInfoTextFL", "languageId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "articleId": { "maxLength": 50, "minLength": 0, "type": "string" }, "languageId": { "maxLength": 5, "minLength": 0, "type": "string" }, "articleInfoTextFL": { "minLength": 1, "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "article": { "$ref": "#/components/schemas/XERP.Shared.Models.Article" }, "language": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminLanguage" } }, "additionalProperties": false }, "XERP.Shared.Models.TranslationArticleName1": { "required": [ "articleId", "articleName1FL", "languageId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "articleId": { "maxLength": 50, "minLength": 0, "type": "string" }, "languageId": { "maxLength": 5, "minLength": 0, "type": "string" }, "articleName1FL": { "maxLength": 100, "minLength": 0, "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "article": { "$ref": "#/components/schemas/XERP.Shared.Models.Article" }, "language": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminLanguage" } }, "additionalProperties": false }, "XERP.Shared.Models.TranslationArticleName2": { "required": [ "articleId", "articleName2FL", "languageId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "articleId": { "maxLength": 50, "minLength": 0, "type": "string" }, "languageId": { "maxLength": 5, "minLength": 0, "type": "string" }, "articleName2FL": { "maxLength": 100, "minLength": 0, "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "article": { "$ref": "#/components/schemas/XERP.Shared.Models.Article" }, "language": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminLanguage" } }, "additionalProperties": false }, "XERP.Shared.Models.TranslationArticleOrderText": { "required": [ "articleId", "articleOrderTextFL", "languageId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "articleId": { "maxLength": 50, "minLength": 0, "type": "string" }, "languageId": { "maxLength": 5, "minLength": 0, "type": "string" }, "articleOrderTextFL": { "minLength": 1, "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "article": { "$ref": "#/components/schemas/XERP.Shared.Models.Article" }, "language": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminLanguage" } }, "additionalProperties": false }, "XERP.Shared.Models.TranslationArticleUoM": { "required": [ "languageId", "uoMFL" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "uoMId": { "type": "integer", "format": "int32" }, "languageId": { "maxLength": 5, "minLength": 0, "type": "string" }, "uoMFL": { "maxLength": 20, "minLength": 0, "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "language": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminLanguage" }, "uoM": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleUoM" } }, "additionalProperties": false }, "XERP.Shared.Models.TranslationDocType": { "required": [ "docTypeFL", "docTypeId", "languageId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "docTypeId": { "maxLength": 35, "minLength": 0, "type": "string" }, "languageId": { "maxLength": 5, "minLength": 0, "type": "string" }, "docTypeFL": { "minLength": 1, "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "docType": { "$ref": "#/components/schemas/XERP.Shared.Models.DocType" }, "language": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminLanguage" } }, "additionalProperties": false }, "XERP.Shared.Models.UpdateXXFieldsDataRequest": { "type": "object", "properties": { "tableName": { "type": "string", "nullable": true }, "filterProperty": { "type": "string", "nullable": true }, "filterValue": { "type": "string", "nullable": true }, "listXXFieldWithValue": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.XXFieldWithValue" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.Warehouse": { "required": [ "warehouseName" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "warehouseName": { "maxLength": 30, "minLength": 0, "type": "string" }, "locationId": { "type": "integer", "format": "int32" }, "typeId": { "type": "integer", "format": "int32" }, "binLocation": { "type": "boolean" }, "incomingBlock": { "type": "boolean" }, "outgoingBlock": { "type": "boolean" }, "countingList": { "type": "integer", "format": "int32" }, "active": { "type": "boolean" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "location": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminLocation" }, "type": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseType" }, "adminCompanySettings": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCompanySetting" }, "nullable": true }, "articleIndividualizationQuantities": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleIndividualizationQuantity" }, "nullable": true }, "articles": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Article" }, "nullable": true }, "docPositionWarehousings": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionWarehousing" }, "nullable": true }, "docXmls": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocXml" }, "nullable": true }, "docs": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Doc" }, "nullable": true }, "procurements": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Procurement" }, "nullable": true }, "productionPositionWarehousings": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionWarehousing" }, "nullable": true }, "productions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Production" }, "nullable": true }, "warehouseBinLocations": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseBinLocation" }, "nullable": true }, "warehouseInventoryCountings": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryCounting" }, "nullable": true }, "warehouseQuantities": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseQuantity" }, "nullable": true }, "warehouseTransferDestinationWarehouses": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseTransfer" }, "nullable": true }, "warehouseTransferPositionDestinationWarehouses": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseTransferPosition" }, "nullable": true }, "warehouseTransferPositionSourceWarehouses": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseTransferPosition" }, "nullable": true }, "warehouseTransferSourceWarehouses": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseTransfer" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.WarehouseBinLocation": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "hierarchyNode": { "$ref": "#/components/schemas/Microsoft.EntityFrameworkCore.HierarchyId" }, "children": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseBinLocation" }, "nullable": true }, "hasChildren": { "type": "boolean" }, "id": { "type": "integer", "format": "int32" }, "warehouseId": { "type": "integer", "format": "int32" }, "name": { "maxLength": 50, "minLength": 0, "type": "string" }, "parentId": { "type": "integer", "format": "int32", "nullable": true }, "hierarchyLevel": { "type": "integer", "format": "int32", "nullable": true }, "warehouse": { "$ref": "#/components/schemas/XERP.Shared.Models.Warehouse" }, "warehouseBinLocationNavigation": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseBinLocation" }, "docPositionWarehousings": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionWarehousing" }, "nullable": true }, "inverseWarehouseBinLocationNavigation": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseBinLocation" }, "nullable": true }, "procurements": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Procurement" }, "nullable": true }, "productionPositionWarehousings": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionWarehousing" }, "nullable": true }, "warehouseInventoryCountingPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryCountingPosition" }, "nullable": true }, "warehouseQuantities": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseQuantity" }, "nullable": true }, "warehouseTransferDestinationBinLocations": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseTransfer" }, "nullable": true }, "warehouseTransferPositionDestinationBinLocations": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseTransferPosition" }, "nullable": true }, "warehouseTransferPositionSourceBinLocations": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseTransferPosition" }, "nullable": true }, "warehouseTransferSourceBinLocations": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseTransfer" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.WarehouseBinLocation_RunWizardDimension": { "type": "object", "properties": { "position": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "from": { "type": "integer", "format": "int32" }, "to": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.WarehouseBinLocation_RunWizardRequest": { "type": "object", "properties": { "warehouseId": { "type": "integer", "format": "int32" }, "dimensions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseBinLocation_RunWizardDimension" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.WarehouseInfo": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "nameAndInfo": { "type": "string", "nullable": true, "readOnly": true }, "hierarchyNode": { "$ref": "#/components/schemas/Microsoft.EntityFrameworkCore.HierarchyId" }, "children": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInfo" }, "nullable": true }, "hasChildren": { "type": "boolean" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 50, "minLength": 0, "type": "string" }, "info": { "maxLength": 200, "minLength": 0, "type": "string", "nullable": true }, "parentId": { "type": "integer", "format": "int32", "nullable": true }, "hierarchyLevel": { "type": "integer", "format": "int32", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "parent": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInfo" }, "articleIndividualizations": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleIndividualization" }, "nullable": true }, "articles": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Article" }, "nullable": true }, "inverseParent": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInfo" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.WarehouseInventoryCounting": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "info": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "inventoryManagerId": { "type": "integer", "format": "int32" }, "warehouseId": { "type": "integer", "format": "int32" }, "draft": { "type": "boolean" }, "sumCalculatedQuantity": { "type": "number", "format": "double" }, "sumCountedQuantity": { "type": "number", "format": "double" }, "sumDifferenceQuantity": { "type": "number", "format": "double" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "inventoryManager": { "$ref": "#/components/schemas/XERP.Shared.Models.Employee" }, "warehouse": { "$ref": "#/components/schemas/XERP.Shared.Models.Warehouse" }, "warehouseInventoryCountingPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryCountingPosition" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.WarehouseInventoryCountingPosition": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "warehouseInventoryCountingId": { "type": "integer", "format": "int32" }, "articleId": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "binLocationId": { "type": "integer", "format": "int32", "nullable": true }, "individualizationNumberId": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "warehouseMediumId": { "type": "integer", "format": "int32", "nullable": true }, "calculatedQuantity": { "type": "number", "format": "double" }, "countedQuantity": { "type": "number", "format": "double" }, "differenceQuantity": { "type": "number", "format": "double" }, "pending": { "type": "boolean" }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "article": { "$ref": "#/components/schemas/XERP.Shared.Models.Article" }, "binLocation": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseBinLocation" }, "individualizationNumber": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleIndividualization" }, "warehouseInventoryCounting": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryCounting" }, "warehouseMedium": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseMedium" } }, "additionalProperties": false }, "XERP.Shared.Models.WarehouseInventoryCountingPosition_DeleteRequest": { "type": "object", "properties": { "warehouseInventoryCountingPositionId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.WarehouseInventoryCountingPosition_GetAllFromViewByValueRequest": { "type": "object", "properties": { "propertyName": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.WarehouseInventoryCountingPosition_InsertFromWarehouseRequest": { "type": "object", "properties": { "warehouseInventoryCountingId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.WarehouseInventoryCountingPosition_InsertRequest": { "type": "object", "properties": { "warehouseInventoryCountingId": { "type": "integer", "format": "int32" }, "articleId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.WarehouseInventoryCountingPosition_SaveDraftRequest": { "type": "object", "properties": { "warehouseInventoryCountingId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.WarehouseInventoryCountingPosition_UpdateBinLocationIdRequest": { "type": "object", "properties": { "warehouseInventoryCountingPositionId": { "type": "integer", "format": "int32" }, "binLocationId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.WarehouseInventoryCountingPosition_UpdateCountedQuantityRequest": { "type": "object", "properties": { "warehouseInventoryCountingPositionId": { "type": "integer", "format": "int32" }, "countedQuantity": { "type": "number", "format": "double" } }, "additionalProperties": false }, "XERP.Shared.Models.WarehouseInventoryCountingPosition_UpdateIndividualizationNumberIdRequest": { "type": "object", "properties": { "warehouseInventoryCountingPositionId": { "type": "integer", "format": "int32" }, "individualizationNumberId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.WarehouseInventoryCounting_CreateNewRequest": { "type": "object", "properties": { "employeeId": { "type": "integer", "format": "int32" }, "warehouseId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.WarehouseInventoryCounting_IdRequest": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.WarehouseInventoryCounting_UpdateInfoRequest": { "type": "object", "properties": { "productionId": { "type": "integer", "format": "int32" }, "info": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.WarehouseInventoryRevaluation": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "info": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "inventoryManagerId": { "type": "integer", "format": "int32" }, "draft": { "type": "boolean" }, "sumOldValue": { "type": "number", "format": "double" }, "sumNewValue": { "type": "number", "format": "double" }, "sumDifferenceValue": { "type": "number", "format": "double" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "inventoryManager": { "$ref": "#/components/schemas/XERP.Shared.Models.Employee" }, "warehouseInventoryRevaluationPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryRevaluationPosition" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.WarehouseInventoryRevaluationPosition": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "inventoryRevaluationId": { "type": "integer", "format": "int32" }, "articleId": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "oldValue": { "type": "number", "format": "double" }, "newValue": { "type": "number", "format": "double" }, "differenceValue": { "type": "number", "format": "double" }, "pending": { "type": "boolean" }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "article": { "$ref": "#/components/schemas/XERP.Shared.Models.Article" }, "inventoryRevaluation": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryRevaluation" } }, "additionalProperties": false }, "XERP.Shared.Models.WarehouseInventoryRevaluationPosition_DeleteRequest": { "type": "object", "properties": { "warehouseInventoryRevaluationPositionId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.WarehouseInventoryRevaluationPosition_GetAllFromViewByValueRequest": { "type": "object", "properties": { "propertyName": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.WarehouseInventoryRevaluationPosition_InsertAllRequest": { "type": "object", "properties": { "warehouseInventoryRevaluationId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.WarehouseInventoryRevaluationPosition_InsertRequest": { "type": "object", "properties": { "warehouseInventoryRevaluationId": { "type": "integer", "format": "int32" }, "articleId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.WarehouseInventoryRevaluationPosition_SaveDraftRequest": { "type": "object", "properties": { "warehouseInventoryRevaluationId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.WarehouseInventoryRevaluationPosition_UpdateNewValueRequest": { "type": "object", "properties": { "warehouseInventoryRevaluationPositionId": { "type": "integer", "format": "int32" }, "newValue": { "type": "number", "format": "double" } }, "additionalProperties": false }, "XERP.Shared.Models.WarehouseInventoryRevaluation_CreateNewRequest": { "type": "object", "properties": { "employeeId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.WarehouseInventoryRevaluation_Sproc_UpdateField": { "type": "object", "properties": { "docId": { "type": "integer", "format": "int32" }, "fieldName": { "type": "string", "nullable": true }, "fieldValue": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.WarehouseMedium": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 20, "minLength": 0, "type": "string" }, "length": { "type": "integer", "format": "int32", "nullable": true }, "width": { "type": "integer", "format": "int32", "nullable": true }, "height": { "type": "integer", "format": "int32", "nullable": true }, "volume": { "type": "number", "format": "double", "nullable": true }, "maximumWeight": { "type": "number", "format": "double", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "articleIndividualizationQuantities": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleIndividualizationQuantity" }, "nullable": true }, "docPositionWarehousings": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.DocPositionWarehousing" }, "nullable": true }, "productionPositionWarehousings": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.ProductionPositionWarehousing" }, "nullable": true }, "warehouseInventoryCountingPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseInventoryCountingPosition" }, "nullable": true }, "warehouseTransferPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseTransferPosition" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.WarehouseQuantity": { "required": [ "articleId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "warehouseId": { "type": "integer", "format": "int32" }, "binLocationId": { "type": "integer", "format": "int32", "nullable": true }, "articleId": { "maxLength": 50, "minLength": 0, "type": "string" }, "stock": { "type": "number", "format": "double", "nullable": true }, "packed": { "type": "number", "format": "double", "nullable": true }, "nowAvailable": { "type": "number", "format": "double", "nullable": true }, "minimumStock": { "type": "number", "format": "double", "nullable": true }, "messageThreshold": { "type": "number", "format": "double", "nullable": true }, "maximumStock": { "type": "number", "format": "double", "nullable": true }, "inventoryCountingPosition": { "type": "integer", "format": "int32", "nullable": true }, "docPosition": { "type": "integer", "format": "int32", "nullable": true }, "productionPosition": { "type": "integer", "format": "int32", "nullable": true }, "transferPosition": { "type": "integer", "format": "int32", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "article": { "$ref": "#/components/schemas/XERP.Shared.Models.Article" }, "binLocation": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseBinLocation" }, "warehouse": { "$ref": "#/components/schemas/XERP.Shared.Models.Warehouse" } }, "additionalProperties": false }, "XERP.Shared.Models.WarehouseTransfer": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "info": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "employeeId": { "type": "integer", "format": "int32", "nullable": true }, "sourceWarehouseId": { "type": "integer", "format": "int32", "nullable": true }, "sourceBinLocationId": { "type": "integer", "format": "int32", "nullable": true }, "destinationWarehouseId": { "type": "integer", "format": "int32", "nullable": true }, "destinationBinLocationId": { "type": "integer", "format": "int32", "nullable": true }, "draft": { "type": "boolean" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "destinationBinLocation": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseBinLocation" }, "destinationWarehouse": { "$ref": "#/components/schemas/XERP.Shared.Models.Warehouse" }, "employee": { "$ref": "#/components/schemas/XERP.Shared.Models.Employee" }, "sourceBinLocation": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseBinLocation" }, "sourceWarehouse": { "$ref": "#/components/schemas/XERP.Shared.Models.Warehouse" }, "warehouseTransferPositions": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseTransferPosition" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.WarehouseTransferPosition": { "required": [ "individualizationTypeId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "warehouseTransferId": { "type": "integer", "format": "int32" }, "positionNumber": { "type": "integer", "format": "int32" }, "articleId": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "quantity": { "type": "number", "format": "double" }, "sourceWarehouseId": { "type": "integer", "format": "int32", "nullable": true }, "sourceBinLocationId": { "type": "integer", "format": "int32", "nullable": true }, "destinationWarehouseId": { "type": "integer", "format": "int32", "nullable": true }, "destinationBinLocationId": { "type": "integer", "format": "int32", "nullable": true }, "individualizationTypeId": { "maxLength": 6, "minLength": 0, "type": "string" }, "individualizationNumberId": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "warehouseMediumId": { "type": "integer", "format": "int32", "nullable": true }, "pending": { "type": "boolean" }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "article": { "$ref": "#/components/schemas/XERP.Shared.Models.Article" }, "destinationBinLocation": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseBinLocation" }, "destinationWarehouse": { "$ref": "#/components/schemas/XERP.Shared.Models.Warehouse" }, "individualizationNumber": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleIndividualization" }, "individualizationType": { "$ref": "#/components/schemas/XERP.Shared.Models.ArticleIndividualizationType" }, "sourceBinLocation": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseBinLocation" }, "sourceWarehouse": { "$ref": "#/components/schemas/XERP.Shared.Models.Warehouse" }, "warehouseMedium": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseMedium" }, "warehouseTransfer": { "$ref": "#/components/schemas/XERP.Shared.Models.WarehouseTransfer" } }, "additionalProperties": false }, "XERP.Shared.Models.WarehouseTransferPosition_DeleteRequest": { "type": "object", "properties": { "warehouseTransferPositionId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.WarehouseTransferPosition_GetAllFromViewByValueRequest": { "type": "object", "properties": { "propertyName": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.WarehouseTransferPosition_InsertRequest": { "type": "object", "properties": { "warehouseTransferId": { "type": "integer", "format": "int32" }, "articleId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.WarehouseTransferPosition_SaveDraftRequest": { "type": "object", "properties": { "warehouseTransferId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.WarehouseTransferPosition_UpdateIndividualizationNumberIdRequest": { "type": "object", "properties": { "warehouseTransferPositionId": { "type": "integer", "format": "int32" }, "individualizationNumberId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.WarehouseTransferPosition_UpdateQuantityRequest": { "type": "object", "properties": { "warehouseTransferPositionId": { "type": "integer", "format": "int32" }, "quantity": { "type": "number", "format": "double" } }, "additionalProperties": false }, "XERP.Shared.Models.WarehouseTransfer_CreateNewRequest": { "type": "object", "properties": { "selectedEmployeeId": { "type": "integer", "format": "int32" }, "selectedSourceWarehouseId": { "type": "integer", "format": "int32" }, "selectedSourceBinLocationId": { "type": "integer", "format": "int32" }, "selectedDestinationWarehouseId": { "type": "integer", "format": "int32" }, "selectedDestinationBinLocationId": { "type": "integer", "format": "int32" }, "createdBy": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.WarehouseTransfer_Sproc_UpdateField": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "fieldName": { "type": "string", "nullable": true }, "fieldValue": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.WarehouseType": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 20, "minLength": 0, "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "warehouses": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Warehouse" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.WebshopActivityLog": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "webshopSettingId": { "type": "integer", "format": "int32" }, "partnerId": { "type": "integer", "format": "int32", "nullable": true }, "action": { "maxLength": 200, "minLength": 0, "type": "string", "nullable": true }, "details": { "maxLength": 4000, "minLength": 0, "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "partner": { "$ref": "#/components/schemas/XERP.Shared.Models.Partner" }, "webshopSetting": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopSetting" } }, "additionalProperties": false }, "XERP.Shared.Models.WebshopArticleReview": { "required": [ "articleId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "partnerId": { "type": "integer", "format": "int32" }, "articleId": { "maxLength": 50, "minLength": 0, "type": "string" }, "rating": { "type": "integer", "format": "int32" }, "comment": { "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "article": { "$ref": "#/components/schemas/XERP.Shared.Models.Article" }, "partner": { "$ref": "#/components/schemas/XERP.Shared.Models.Partner" } }, "additionalProperties": false }, "XERP.Shared.Models.WebshopCartArticle": { "required": [ "articleId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "cartId": { "type": "integer", "format": "int32", "nullable": true }, "articleId": { "maxLength": 50, "minLength": 0, "type": "string" }, "quantity": { "type": "number", "format": "double" }, "subject": { "maxLength": 200, "minLength": 0, "type": "string", "nullable": true }, "targetDocTypeId": { "maxLength": 35, "minLength": 0, "type": "string", "nullable": true }, "startDate": { "type": "string", "format": "date-time", "nullable": true }, "cyclePeriodId": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "nextAppointment": { "type": "string", "format": "date-time", "nullable": true }, "endDate": { "type": "string", "format": "date-time", "nullable": true }, "useContract": { "type": "boolean" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "article": { "$ref": "#/components/schemas/XERP.Shared.Models.Article" }, "cart": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopUserCart" }, "cyclePeriod": { "$ref": "#/components/schemas/XERP.Shared.Models.DocContractCyclePeriod" }, "targetDocType": { "$ref": "#/components/schemas/XERP.Shared.Models.DocType" } }, "additionalProperties": false }, "XERP.Shared.Models.WebshopCss": { "required": [ "customCss", "themeName" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "themeName": { "maxLength": 100, "minLength": 0, "type": "string" }, "customCss": { "minLength": 1, "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.WebshopIcon": { "required": [ "name", "svgContent" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 100, "minLength": 0, "type": "string" }, "svgContent": { "minLength": 1, "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.WebshopPasskey": { "required": [ "passkeyId", "publicKey" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "partnerId": { "type": "integer", "format": "int32" }, "passkeyId": { "minLength": 1, "type": "string" }, "publicKey": { "type": "string", "format": "byte" }, "counter": { "type": "integer", "format": "int32" }, "dateCreated": { "type": "string", "format": "date-time" }, "dateModified": { "type": "string", "format": "date-time" }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "partner": { "$ref": "#/components/schemas/XERP.Shared.Models.Partner" } }, "additionalProperties": false }, "XERP.Shared.Models.WebshopRating": { "required": [ "articleId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "articleId": { "maxLength": 50, "minLength": 0, "type": "string" }, "partnerId": { "type": "integer", "format": "int32" }, "partnerDetailId": { "type": "integer", "format": "int32" }, "like": { "type": "boolean" }, "stars": { "type": "integer", "format": "int32" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "article": { "$ref": "#/components/schemas/XERP.Shared.Models.Article" }, "partner": { "$ref": "#/components/schemas/XERP.Shared.Models.Partner" }, "partnerDetail": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerDetail" } }, "additionalProperties": false }, "XERP.Shared.Models.WebshopSetting": { "required": [ "defaultBillingAddressMatchcode", "defaultCity", "defaultCountryId", "defaultLanguageId", "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 50, "minLength": 0, "type": "string" }, "keyName": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "contactEmail": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "phoneNumber": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "legalNotice": { "type": "string", "nullable": true }, "privacyPolicy": { "type": "string", "nullable": true }, "logo": { "type": "string", "format": "byte", "nullable": true }, "defaultCity": { "maxLength": 50, "minLength": 0, "type": "string" }, "defaultCountryId": { "maxLength": 2, "minLength": 0, "type": "string" }, "defaultPartnerGroupId": { "type": "integer", "format": "int32" }, "defaultLanguageId": { "maxLength": 5, "minLength": 0, "type": "string" }, "defaultLocationId": { "type": "integer", "format": "int32" }, "defaultBillingAddressMatchcode": { "maxLength": 100, "minLength": 0, "type": "string" }, "defaultTermsOfPaymentId": { "type": "integer", "format": "int32" }, "defaultTermsOfDeliveryId": { "type": "integer", "format": "int32" }, "defaultFinanceGroupPartnerDetailId": { "type": "integer", "format": "int32" }, "url": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "templateId": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "enableAccountCreation": { "type": "boolean" }, "accountCreationEmailText": { "type": "string", "nullable": true }, "enableUserReviews": { "type": "boolean" }, "enableGuestMode": { "type": "boolean" }, "orderEmailAccountId": { "type": "integer", "format": "int32", "nullable": true }, "recentOrderNotification": { "type": "boolean" }, "orderEmailText": { "type": "string", "nullable": true }, "calendarNameId": { "type": "integer", "format": "int32", "nullable": true }, "shippingCostArticleId": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "showStock": { "type": "boolean" }, "reportTemplateId": { "type": "integer", "format": "int32" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "calendarName": { "$ref": "#/components/schemas/XERP.Shared.Models.CalendarName" }, "defaultCountry": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminCountry" }, "defaultFinanceGroupPartnerDetail": { "$ref": "#/components/schemas/XERP.Shared.Models.FinanceGroupPartner" }, "defaultLanguage": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminLanguage" }, "defaultLocation": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminLocation" }, "defaultPartnerGroup": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerGroup" }, "defaultTermsOfDelivery": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerTermsOfDelivery" }, "defaultTermsOfPayment": { "$ref": "#/components/schemas/XERP.Shared.Models.PartnerTermsOfPayment" }, "orderEmailAccount": { "$ref": "#/components/schemas/XERP.Shared.Models.EmailAccount" }, "reportTemplate": { "$ref": "#/components/schemas/XERP.Shared.Models.ReportTemplate" }, "shippingCostArticle": { "$ref": "#/components/schemas/XERP.Shared.Models.Article" }, "webshopActivityLogs": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopActivityLog" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.WebshopUserCart": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "partnerId": { "type": "integer", "format": "int32" }, "reminderEmailCounter": { "type": "integer", "format": "int32", "nullable": true }, "lastReminderEmail": { "type": "string", "format": "date-time", "nullable": true }, "activeSessionId": { "maxLength": 36, "minLength": 0, "type": "string", "nullable": true }, "lockTimestamp": { "type": "string", "format": "date-time", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "partner": { "$ref": "#/components/schemas/XERP.Shared.Models.Partner" }, "webshopCartArticles": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WebshopCartArticle" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.Wiki": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "wikiCategoryId": { "type": "integer", "format": "int32" }, "subject": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "content": { "type": "string", "nullable": true }, "wikiStatusId": { "type": "integer", "format": "int32" }, "wikiAuthorId": { "type": "integer", "format": "int32", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "wikiAuthor": { "$ref": "#/components/schemas/XERP.Shared.Models.Employee" }, "wikiCategory": { "$ref": "#/components/schemas/XERP.Shared.Models.WikiCategory" }, "wikiStatus": { "$ref": "#/components/schemas/XERP.Shared.Models.WikiStatus" } }, "additionalProperties": false }, "XERP.Shared.Models.WikiCategory": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 50, "minLength": 0, "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "wikis": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Wiki" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.WikiStatus": { "required": [ "status" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "status": { "maxLength": 10, "minLength": 0, "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "wikis": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.Wiki" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.WorkspaceRoleDesktop": { "required": [ "backgroundColor", "roleId", "systemDesktopId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "roleId": { "minLength": 1, "type": "string" }, "systemDesktopId": { "maxLength": 50, "minLength": 0, "type": "string" }, "showIcons": { "type": "boolean" }, "showText": { "type": "boolean" }, "fontSize": { "type": "integer", "format": "int32" }, "backgroundColor": { "maxLength": 9, "minLength": 0, "type": "string" }, "buttonHeight": { "type": "integer", "format": "int32" }, "showNotes": { "type": "boolean" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "systemDesktop": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemDesktop" }, "workspaceRoleDesktopButtons": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceRoleDesktopButton" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.WorkspaceRoleDesktopButton": { "required": [ "adminRouteId", "adminSvgId", "backgroundColor", "displayText", "fontColor", "frameColor", "workspaceRoleDesktopId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "workspaceRoleDesktopId": { "maxLength": 50, "minLength": 0, "type": "string" }, "rowIndex": { "type": "integer", "format": "int32" }, "columnIndex": { "type": "integer", "format": "int32" }, "adminRouteId": { "maxLength": 200, "minLength": 0, "type": "string" }, "displayText": { "maxLength": 50, "minLength": 0, "type": "string" }, "adminSvgId": { "maxLength": 50, "minLength": 0, "type": "string" }, "fontColor": { "maxLength": 9, "minLength": 0, "type": "string" }, "backgroundColor": { "maxLength": 9, "minLength": 0, "type": "string" }, "frameColor": { "maxLength": 9, "minLength": 0, "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "adminRoute": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminRoute" }, "adminSvg": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminSvg" }, "workspaceRoleDesktop": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceRoleDesktop" } }, "additionalProperties": false }, "XERP.Shared.Models.WorkspaceRoleMenu": { "required": [ "roleId", "systemDesktopId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "roleId": { "minLength": 1, "type": "string" }, "systemDesktopId": { "maxLength": 50, "minLength": 0, "type": "string" }, "gridRowCount": { "type": "integer", "format": "int32" }, "gridColumnCount": { "type": "integer", "format": "int32" }, "showIcons": { "type": "boolean" }, "showText": { "type": "boolean" }, "fontSize": { "type": "integer", "format": "int32" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "systemDesktop": { "$ref": "#/components/schemas/XERP.Shared.Models.SystemDesktop" }, "workspaceRoleMenuButtons": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceRoleMenuButton" }, "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.WorkspaceRoleMenuButton": { "required": [ "adminRouteId", "adminSvgId", "backgroundColor", "displayText", "fontColor", "frameColor", "workspaceRoleMenuId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "workspaceRoleMenuId": { "maxLength": 50, "minLength": 0, "type": "string" }, "rowIndex": { "type": "integer", "format": "int32" }, "columnIndex": { "type": "integer", "format": "int32" }, "adminRouteId": { "maxLength": 200, "minLength": 0, "type": "string" }, "displayText": { "maxLength": 50, "minLength": 0, "type": "string" }, "adminSvgId": { "maxLength": 50, "minLength": 0, "type": "string" }, "fontColor": { "maxLength": 9, "minLength": 0, "type": "string" }, "backgroundColor": { "maxLength": 9, "minLength": 0, "type": "string" }, "frameColor": { "maxLength": 9, "minLength": 0, "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "adminRoute": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminRoute" }, "adminSvg": { "$ref": "#/components/schemas/XERP.Shared.Models.AdminSvg" }, "workspaceRoleMenu": { "$ref": "#/components/schemas/XERP.Shared.Models.WorkspaceRoleMenu" } }, "additionalProperties": false }, "XERP.Shared.Models.WorkspaceUserColumnSetting": { "required": [ "gridKey", "gridLayout", "userId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "userId": { "minLength": 1, "type": "string" }, "gridKey": { "maxLength": 50, "minLength": 0, "type": "string" }, "gridLayout": { "maxLength": 4000, "minLength": 0, "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.WorkspaceUserFieldSetting": { "required": [ "fieldKey", "pageKey", "userId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "userId": { "minLength": 1, "type": "string" }, "pageKey": { "maxLength": 200, "minLength": 0, "type": "string" }, "fieldKey": { "maxLength": 200, "minLength": 0, "type": "string" }, "isVisible": { "type": "boolean" }, "displayOrder": { "type": "integer", "format": "int32", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.XXFieldLookupRequest": { "type": "object", "properties": { "tableName": { "type": "string", "nullable": true }, "idFieldName": { "type": "string", "nullable": true }, "nameFieldName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.XXFieldWithValue": { "type": "object", "properties": { "caption": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "isMandatory": { "type": "boolean" }, "length": { "type": "integer", "format": "int32", "nullable": true }, "position": { "type": "integer", "format": "int32", "nullable": true }, "leftSide": { "type": "boolean" }, "foreignKeyTableId": { "type": "string", "nullable": true }, "foreignKeyIdField": { "type": "string", "nullable": true }, "foreignKeyNameField": { "type": "string", "nullable": true }, "dbValue": { "type": "string", "nullable": true }, "stringValue": { "type": "string", "nullable": true }, "integerValue": { "type": "integer", "format": "int32", "nullable": true }, "decimalValue": { "type": "number", "format": "double", "nullable": true }, "dateTimeValue": { "type": "string", "format": "date-time", "nullable": true }, "dateValue": { "type": "string", "format": "date", "nullable": true }, "dateTimeOffsetValue": { "type": "string", "format": "date-time", "nullable": true }, "booleanValue": { "type": "boolean", "nullable": true }, "byteArrayValue": { "type": "string", "format": "byte", "nullable": true }, "isModified": { "type": "boolean" }, "isReadOnly": { "type": "boolean" } }, "additionalProperties": false }, "XERP.Shared.Models.XXTable": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "propertyBag": { "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.xPROC229I_DocPositionWarehousingResult": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "docPositionId": { "type": "integer", "format": "int32" }, "warehouseId": { "type": "integer", "format": "int32", "nullable": true }, "binLocationId": { "type": "integer", "format": "int32", "nullable": true }, "quantity": { "type": "number", "format": "double" }, "individualizationTypeId": { "maxLength": 6, "minLength": 0, "type": "string", "nullable": true }, "individualizationNumberId": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "warehousingEffective": { "type": "integer", "format": "int32" }, "warehousingQuantity": { "type": "number", "format": "double", "nullable": true }, "warehouseMediumId": { "type": "integer", "format": "int32", "nullable": true }, "hasBinLocation": { "type": "boolean" }, "binLocationName": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "stock": { "type": "number", "format": "double", "nullable": true }, "nowAvailable": { "type": "number", "format": "double", "nullable": true }, "docCategoryId": { "maxLength": 17, "minLength": 0, "type": "string", "nullable": true }, "articleId": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "isBatch": { "type": "boolean", "nullable": true }, "individualizationStock": { "type": "number", "format": "double", "nullable": true }, "individualizationPacked": { "type": "number", "format": "double", "nullable": true }, "individualizationNowAvailable": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.xPROC229U_DocPositionWarehousing_BinLocationIdResult": { "type": "object", "properties": { "nowAvailable": { "type": "number", "format": "double", "nullable": true }, "stock": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.xPROC229U_DocPositionWarehousing_WarehouseIdResult": { "type": "object", "properties": { "nowAvailable": { "type": "number", "format": "double", "nullable": true }, "stock": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.xPROC263_DocXml_Positions_SaveResult": { "type": "object", "properties": { "positionNumber": { "type": "integer", "format": "int32", "nullable": true }, "articleId": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "eInvoiceUoMIdInArticle": { "maxLength": 3, "minLength": 0, "type": "string", "nullable": true }, "xmlArticle": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "eInvoiceUoMIdInXml": { "maxLength": 3, "minLength": 0, "type": "string", "nullable": true }, "text": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "conflictType": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "existingCatalogNumber": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.xPROC418U_Production_Calculate_QuantityPickResult": { "type": "object", "properties": { "quantityToPick": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.xPROC418U_Production_PackResult": { "type": "object", "properties": { "warehousingId": { "type": "integer", "format": "int32", "nullable": true }, "positionNumber": { "type": "integer", "format": "int32", "nullable": true }, "productionPositionId": { "type": "integer", "format": "int32", "nullable": true }, "articleId": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "text": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.xPROC429I_ProductionPositionWarehousingResult": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "productionPositionId": { "type": "integer", "format": "int32" }, "warehouseId": { "type": "integer", "format": "int32", "nullable": true }, "binLocationId": { "type": "integer", "format": "int32", "nullable": true }, "quantity": { "type": "number", "format": "double" }, "individualizationTypeId": { "maxLength": 6, "minLength": 0, "type": "string", "nullable": true }, "individualizationNumberId": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "warehousingEffective": { "type": "integer", "format": "int32" }, "warehousingQuantity": { "type": "number", "format": "double", "nullable": true }, "warehouseMediumId": { "type": "integer", "format": "int32", "nullable": true }, "hasBinLocation": { "type": "boolean" }, "binLocationName": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "stock": { "type": "number", "format": "double", "nullable": true }, "nowAvailable": { "type": "number", "format": "double", "nullable": true }, "articleId": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "isBatch": { "type": "boolean", "nullable": true }, "individualizationStock": { "type": "number", "format": "double", "nullable": true }, "individualizationPacked": { "type": "number", "format": "double", "nullable": true }, "individualizationNowAvailable": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.xPROC429U_ProductionPositionWarehousing_BinLocationIdResult": { "type": "object", "properties": { "nowAvailable": { "type": "number", "format": "double", "nullable": true }, "stock": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.xPROC429U_ProductionPositionWarehousing_WarehouseIdResult": { "type": "object", "properties": { "nowAvailable": { "type": "number", "format": "double", "nullable": true }, "stock": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.xPROC520I_WarehouseInventoryCountingPosition_NewArticleResult": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "warehouseInventoryCountingId": { "type": "integer", "format": "int32" }, "articleId": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "binLocationId": { "type": "integer", "format": "int32", "nullable": true }, "individualizationNumberId": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "warehouseMediumId": { "type": "integer", "format": "int32", "nullable": true }, "calculatedQuantity": { "type": "number", "format": "double" }, "countedQuantity": { "type": "number", "format": "double" }, "differenceQuantity": { "type": "number", "format": "double", "nullable": true }, "pending": { "type": "boolean" }, "rowVersion": { "type": "string", "format": "byte", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.xPROC521I_WarehouseInventoryRevaluationPosition_ArticleResult": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "inventoryRevaluationId": { "type": "integer", "format": "int32" }, "articleId": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "oldValue": { "type": "number", "format": "double" }, "newValue": { "type": "number", "format": "double" }, "differenceValue": { "type": "number", "format": "double", "nullable": true }, "pending": { "type": "boolean" }, "rowVersion": { "type": "string", "format": "byte", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.xPROC521U_WarehouseInventoryRevaluationPosition_NewValueResult": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "inventoryRevaluationId": { "type": "integer", "format": "int32" }, "draft": { "type": "boolean" }, "articleId": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "oldValue": { "type": "number", "format": "double" }, "newValue": { "type": "number", "format": "double" }, "differenceValue": { "type": "number", "format": "double", "nullable": true }, "name1": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "name2": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "uoMId": { "type": "integer", "format": "int32" }, "individualizationTypeId": { "maxLength": 6, "minLength": 0, "type": "string", "nullable": true }, "uoMName": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.xPROC522I_WarehouseTransferPosition_ArticleResult": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "warehouseTransferId": { "type": "integer", "format": "int32" }, "articleId": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "positionNumber": { "type": "integer", "format": "int32" }, "quantity": { "type": "number", "format": "double" }, "individualizationNumberId": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "sourceWarehouseId": { "type": "integer", "format": "int32", "nullable": true }, "sourceBinLocationId": { "type": "integer", "format": "int32", "nullable": true }, "destinationWarehouseId": { "type": "integer", "format": "int32", "nullable": true }, "destinationBinLocationId": { "type": "integer", "format": "int32", "nullable": true }, "warehouseMediumId": { "type": "integer", "format": "int32", "nullable": true }, "pending": { "type": "boolean" }, "name1": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "name2": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "uoMId": { "type": "integer", "format": "int32" }, "individualizationTypeId": { "maxLength": 6, "minLength": 0, "type": "string", "nullable": true }, "decimalPlacesQuantitiesId": { "type": "integer", "format": "int32" }, "warehousing": { "type": "boolean" }, "uoMName": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "stock": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.xPROC550_ProcurementWizard_QuantityUsedResult": { "type": "object", "properties": { "procurementId": { "type": "integer", "format": "int32", "nullable": true }, "articleId": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "text": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.xPROC609_FinanceTransfer_PostingResult": { "type": "object", "properties": { "positionNumber": { "type": "integer", "format": "int32" }, "text": { "type": "string", "nullable": true }, "isError": { "type": "boolean" }, "assignmentId": { "nullable": true }, "postingId": { "type": "integer", "format": "int32", "nullable": true }, "sourceOpenItemId": { "nullable": true }, "openItemId": { "type": "integer", "format": "int32", "nullable": true }, "direction": { "nullable": true }, "contraAccountId": { "nullable": true }, "discountAmount": { "nullable": true }, "foreignDiscountAmount": { "nullable": true }, "originalPostingId": { "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.xPROC635I_FinanceOpeningBalancePosition_SingleResult": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "openingBalanceId": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "partnerDetailId": { "type": "integer", "format": "int32", "nullable": true }, "amount": { "type": "number", "format": "double" }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "name": { "maxLength": 200, "minLength": 0, "type": "string", "nullable": true }, "businessPartnerNumber": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.xPROC696_FinanceFixedAssetWizard_PostingResult": { "type": "object", "properties": { "positionNumber": { "type": "integer", "format": "int32", "nullable": true }, "text": { "maxLength": 500, "minLength": 0, "type": "string", "nullable": true }, "isError": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.xVIEW124_ArticlePositionQuantityOpenSum": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "articleId": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "matchcode": { "maxLength": 153, "minLength": 0, "type": "string", "nullable": true }, "warehousing": { "type": "boolean", "nullable": true }, "articleGroupName": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "confirmed": { "type": "number", "format": "double", "nullable": true }, "packed": { "type": "number", "format": "double", "nullable": true }, "ordered": { "type": "number", "format": "double", "nullable": true }, "announced": { "type": "number", "format": "double", "nullable": true }, "stock": { "type": "number", "format": "double", "nullable": true }, "minimumStock": { "type": "number", "format": "double", "nullable": true }, "messageThreshold": { "type": "number", "format": "double", "nullable": true }, "maximumStock": { "type": "number", "format": "double", "nullable": true }, "nowAvailable": { "type": "number", "format": "double", "nullable": true }, "availableToPromise": { "type": "number", "format": "double", "nullable": true }, "laterAvailable": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.xVIEW124_ArticleProductionPositionQuantityOpenSum": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "articleId": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "matchcode": { "maxLength": 153, "minLength": 0, "type": "string", "nullable": true }, "warehousing": { "type": "boolean", "nullable": true }, "articleGroupName": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "confirmed": { "type": "number", "format": "double", "nullable": true }, "packed": { "type": "number", "format": "double" }, "ordered": { "type": "number", "format": "double" }, "announced": { "type": "number", "format": "double" }, "stock": { "type": "number", "format": "double", "nullable": true }, "nowAvailable": { "type": "number", "format": "double", "nullable": true }, "laterAvailable": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.xVIEW124_ArticleQuantityInventorySum": { "required": [ "articleId", "matchcode" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "articleId": { "maxLength": 50, "minLength": 0, "type": "string" }, "matchcode": { "maxLength": 153, "minLength": 0, "type": "string" }, "warehousing": { "type": "boolean" }, "articleGroupName": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "confirmed": { "type": "number", "format": "double", "nullable": true }, "packed": { "type": "number", "format": "double", "nullable": true }, "ordered": { "type": "number", "format": "double", "nullable": true }, "announced": { "type": "number", "format": "double", "nullable": true }, "stock": { "type": "number", "format": "double", "nullable": true }, "minimumStock": { "type": "number", "format": "double" }, "messageThreshold": { "type": "number", "format": "double" }, "maximumStock": { "type": "number", "format": "double" }, "nowAvailable": { "type": "number", "format": "double", "nullable": true }, "availableToPromise": { "type": "number", "format": "double", "nullable": true }, "laterAvailable": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.xVIEW125_ArticleHistoryTable": { "required": [ "articleGroupName", "articleIndividualizationTypeName", "articleUoMName", "id", "individualizationTypeId", "matchcode", "name1", "procurementFinanceGroupName", "procurementTypeId", "procurementTypeName", "salesFinanceGroupName" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "changedFields": { "type": "object", "additionalProperties": { "type": "boolean" }, "nullable": true }, "historyId": { "type": "integer", "format": "int32", "nullable": true }, "id": { "maxLength": 50, "minLength": 0, "type": "string" }, "articleTypeId": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "name1": { "maxLength": 100, "minLength": 0, "type": "string" }, "name2": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "matchcode": { "maxLength": 153, "minLength": 0, "type": "string" }, "articleGroupId": { "type": "integer", "format": "int32" }, "uoMId": { "type": "integer", "format": "int32" }, "decimalPlacesQuantitiesId": { "type": "integer", "format": "int32" }, "warehousing": { "type": "boolean" }, "active": { "type": "boolean" }, "favorite": { "type": "boolean" }, "priceUnitId": { "type": "integer", "format": "int32" }, "manufacturerId": { "type": "integer", "format": "int32", "nullable": true }, "manufacturerOrderNumber": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "warehouseInfoId": { "type": "integer", "format": "int32", "nullable": true }, "shop": { "type": "boolean" }, "printing": { "type": "boolean" }, "weight": { "type": "number", "format": "double", "nullable": true }, "length": { "type": "number", "format": "double", "nullable": true }, "width": { "type": "number", "format": "double", "nullable": true }, "height": { "type": "number", "format": "double", "nullable": true }, "volume": { "type": "number", "format": "double", "nullable": true }, "content": { "type": "number", "format": "double", "nullable": true }, "contentUoMId": { "type": "integer", "format": "int32", "nullable": true }, "gtin": { "maxLength": 18, "minLength": 0, "type": "string", "nullable": true }, "salesArticle": { "type": "boolean" }, "salesFinanceGroupId": { "type": "integer", "format": "int32" }, "lotSize": { "type": "number", "format": "double" }, "minimumQuantity": { "type": "number", "format": "double" }, "deliveryTime": { "type": "integer", "format": "int32" }, "purchaseArticle": { "type": "boolean" }, "transferToPurchase": { "type": "boolean" }, "procurementFinanceGroupId": { "type": "integer", "format": "int32" }, "procurementTypeId": { "maxLength": 4, "minLength": 0, "type": "string" }, "procurementTime": { "type": "integer", "format": "int32" }, "standardSupplierId": { "type": "integer", "format": "int32", "nullable": true }, "standardWarehouseId": { "type": "integer", "format": "int32", "nullable": true }, "negativeInventoryAllowed": { "type": "boolean" }, "individualizationTypeId": { "maxLength": 6, "minLength": 0, "type": "string" }, "withMacro": { "type": "boolean" }, "withSet": { "type": "boolean" }, "withAccessory": { "type": "boolean" }, "isEndProduct": { "type": "boolean" }, "isProductionStep": { "type": "boolean" }, "isProductionTime": { "type": "boolean" }, "isPrepayment": { "type": "boolean" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "sysStartTime": { "type": "string", "format": "date-time" }, "sysEndTime": { "type": "string", "format": "date-time" }, "articleGroupName": { "maxLength": 50, "minLength": 0, "type": "string" }, "articleUoMName": { "maxLength": 20, "minLength": 0, "type": "string" }, "manufacturerName": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "warehouseInfoName": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "contentUoMName": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "createdByName": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "modifiedByName": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "salesFinanceGroupName": { "maxLength": 50, "minLength": 0, "type": "string" }, "procurementFinanceGroupName": { "maxLength": 50, "minLength": 0, "type": "string" }, "procurementTypeName": { "maxLength": 10, "minLength": 0, "type": "string" }, "standardSupplierName": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "standardWarehouseName": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "articleIndividualizationTypeName": { "maxLength": 6, "minLength": 0, "type": "string" } }, "additionalProperties": false }, "XERP.Shared.Models.xVIEW139_ArticleIndividualizationQuantityHistory": { "required": [ "articleIndividualizationId", "dataStatus" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "historyId": { "type": "integer", "format": "int32", "nullable": true }, "warehouseId": { "type": "integer", "format": "int32", "nullable": true }, "binLocationId": { "type": "integer", "format": "int32", "nullable": true }, "articleIndividualizationId": { "maxLength": 30, "minLength": 0, "type": "string" }, "stock": { "type": "number", "format": "double", "nullable": true }, "packed": { "type": "number", "format": "double", "nullable": true }, "nowAvailable": { "type": "number", "format": "double", "nullable": true }, "inventoryCountingPosition": { "type": "integer", "format": "int32", "nullable": true }, "docPosition": { "type": "integer", "format": "int32", "nullable": true }, "productionPosition": { "type": "integer", "format": "int32", "nullable": true }, "transferPosition": { "type": "integer", "format": "int32", "nullable": true }, "sysStartTime": { "type": "string", "format": "date-time" }, "sysEndTime": { "type": "string", "format": "date-time" }, "docPositionId": { "type": "integer", "format": "int32", "nullable": true }, "docNumber": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "dataStatus": { "maxLength": 10, "minLength": 0, "type": "string" }, "warehouseInventoryCountingId": { "type": "integer", "format": "int32", "nullable": true }, "productionId": { "type": "integer", "format": "int32", "nullable": true }, "transferId": { "type": "integer", "format": "int32", "nullable": true }, "decimalPlacesQuantitiesId": { "type": "integer", "format": "int32" }, "warehousing": { "type": "boolean" } }, "additionalProperties": false }, "XERP.Shared.Models.xVIEW140_ArticleQuantityHistoryTable": { "required": [ "articleId", "dataStatus" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "historyId": { "type": "integer", "format": "int32", "nullable": true }, "articleId": { "maxLength": 50, "minLength": 0, "type": "string" }, "confirmed": { "type": "number", "format": "double", "nullable": true }, "packed": { "type": "number", "format": "double", "nullable": true }, "ordered": { "type": "number", "format": "double", "nullable": true }, "announced": { "type": "number", "format": "double", "nullable": true }, "nowAvailable": { "type": "number", "format": "double", "nullable": true }, "laterAvailable": { "type": "number", "format": "double", "nullable": true }, "stock": { "type": "number", "format": "double", "nullable": true }, "inventoryCountingPosition": { "type": "integer", "format": "int32", "nullable": true }, "docPosition": { "type": "integer", "format": "int32", "nullable": true }, "productionPosition": { "type": "integer", "format": "int32", "nullable": true }, "sysStartTime": { "type": "string", "format": "date-time" }, "sysEndTime": { "type": "string", "format": "date-time" }, "docPositionId": { "type": "integer", "format": "int32", "nullable": true }, "docNumber": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "dataStatus": { "maxLength": 10, "minLength": 0, "type": "string" }, "warehouseInventoryCountingId": { "type": "integer", "format": "int32", "nullable": true }, "productionId": { "type": "integer", "format": "int32", "nullable": true }, "productionNumber": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "decimalPlacesQuantitiesId": { "type": "integer", "format": "int32" }, "warehousing": { "type": "boolean" } }, "additionalProperties": false }, "XERP.Shared.Models.xVIEW150_PartnerJoinCustomer": { "required": [ "city", "email", "languageId", "matchcode", "name1", "partnerTypeId", "street", "zip" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "numberAndMatchcode": { "type": "string", "nullable": true, "readOnly": true }, "id": { "type": "integer", "format": "int32" }, "partnerTypeId": { "maxLength": 10, "minLength": 0, "type": "string" }, "partnerId": { "type": "integer", "format": "int32" }, "businessPartnerNumber": { "type": "integer", "format": "int32" }, "ownNumber": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "termsOfPaymentId": { "type": "integer", "format": "int32" }, "financeGroupPartnerDetailId": { "type": "integer", "format": "int32" }, "costCenterId": { "type": "integer", "format": "int32", "nullable": true }, "standardContactPersonId": { "type": "integer", "format": "int32", "nullable": true }, "creditLimit": { "type": "number", "format": "double", "nullable": true }, "dunningLock": { "type": "boolean" }, "eDocTypeId": { "type": "integer", "format": "int32" }, "invoiceEmail": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "divergentInvoiceRecipientId": { "type": "integer", "format": "int32", "nullable": true }, "datevAccount": { "type": "integer", "format": "int32", "nullable": true }, "matchcode": { "maxLength": 100, "minLength": 0, "type": "string" }, "partnerGroupId": { "type": "integer", "format": "int32" }, "name1": { "maxLength": 100, "minLength": 0, "type": "string" }, "street": { "maxLength": 100, "minLength": 0, "type": "string" }, "zip": { "maxLength": 20, "minLength": 0, "type": "string" }, "city": { "maxLength": 50, "minLength": 0, "type": "string" }, "tel1": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "email": { "maxLength": 256, "minLength": 0, "type": "string" }, "languageId": { "maxLength": 5, "minLength": 0, "type": "string" }, "privatePerson": { "type": "boolean" } }, "additionalProperties": false }, "XERP.Shared.Models.xVIEW150_PartnerJoinPartnerDetail": { "required": [ "city", "email", "languageId", "matchcode", "name1", "partnerTypeId", "street", "zip" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "numberAndMatchcode": { "type": "string", "nullable": true, "readOnly": true }, "id": { "type": "integer", "format": "int32" }, "partnerTypeId": { "maxLength": 10, "minLength": 0, "type": "string" }, "partnerId": { "type": "integer", "format": "int32" }, "businessPartnerNumber": { "type": "integer", "format": "int32" }, "ownNumber": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "termsOfPaymentId": { "type": "integer", "format": "int32" }, "financeGroupPartnerDetailId": { "type": "integer", "format": "int32" }, "costCenterId": { "type": "integer", "format": "int32", "nullable": true }, "standardContactPersonId": { "type": "integer", "format": "int32", "nullable": true }, "creditLimit": { "type": "number", "format": "double", "nullable": true }, "dunningLock": { "type": "boolean" }, "eDocTypeId": { "type": "integer", "format": "int32" }, "invoiceEmail": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "divergentInvoiceRecipientId": { "type": "integer", "format": "int32", "nullable": true }, "datevAccount": { "type": "integer", "format": "int32", "nullable": true }, "matchcode": { "maxLength": 100, "minLength": 0, "type": "string" }, "partnerGroupId": { "type": "integer", "format": "int32" }, "name1": { "maxLength": 100, "minLength": 0, "type": "string" }, "street": { "maxLength": 100, "minLength": 0, "type": "string" }, "zip": { "maxLength": 20, "minLength": 0, "type": "string" }, "city": { "maxLength": 50, "minLength": 0, "type": "string" }, "tel1": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "email": { "maxLength": 256, "minLength": 0, "type": "string" }, "languageId": { "maxLength": 5, "minLength": 0, "type": "string" }, "privatePerson": { "type": "boolean" }, "datevAccountAndMatchcode": { "maxLength": 133, "minLength": 0, "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.xVIEW150_PartnerJoinSupplier": { "required": [ "city", "email", "languageId", "matchcode", "name1", "partnerTypeId", "street", "zip" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "numberAndMatchcode": { "type": "string", "nullable": true, "readOnly": true }, "id": { "type": "integer", "format": "int32" }, "partnerTypeId": { "maxLength": 10, "minLength": 0, "type": "string" }, "partnerId": { "type": "integer", "format": "int32" }, "businessPartnerNumber": { "type": "integer", "format": "int32" }, "ownNumber": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "termsOfPaymentId": { "type": "integer", "format": "int32" }, "financeGroupPartnerDetailId": { "type": "integer", "format": "int32" }, "costCenterId": { "type": "integer", "format": "int32", "nullable": true }, "standardContactPersonId": { "type": "integer", "format": "int32", "nullable": true }, "creditLimit": { "type": "number", "format": "double", "nullable": true }, "dunningLock": { "type": "boolean" }, "eDocTypeId": { "type": "integer", "format": "int32" }, "invoiceEmail": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "divergentInvoiceRecipientId": { "type": "integer", "format": "int32", "nullable": true }, "datevAccount": { "type": "integer", "format": "int32", "nullable": true }, "discountGroupNameId": { "type": "integer", "format": "int32", "nullable": true }, "matchcode": { "maxLength": 100, "minLength": 0, "type": "string" }, "partnerGroupId": { "type": "integer", "format": "int32" }, "name1": { "maxLength": 100, "minLength": 0, "type": "string" }, "street": { "maxLength": 100, "minLength": 0, "type": "string" }, "zip": { "maxLength": 20, "minLength": 0, "type": "string" }, "city": { "maxLength": 50, "minLength": 0, "type": "string" }, "tel1": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "email": { "maxLength": 256, "minLength": 0, "type": "string" }, "languageId": { "maxLength": 5, "minLength": 0, "type": "string" }, "privatePerson": { "type": "boolean" } }, "additionalProperties": false }, "XERP.Shared.Models.xVIEW150_PartnerPurchasePriceListHistoryTable": { "required": [ "articleId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "historyId": { "type": "integer", "format": "int32", "nullable": true }, "id": { "type": "integer", "format": "int32" }, "partnerId": { "type": "integer", "format": "int32" }, "articleId": { "maxLength": 50, "minLength": 0, "type": "string" }, "deliveryTime": { "type": "integer", "format": "int32" }, "minimumQuantity": { "type": "number", "format": "double" }, "lotSize": { "type": "number", "format": "double" }, "discountGroupAssigned": { "type": "boolean" }, "purchasePrice": { "type": "number", "format": "double" }, "discountPercent": { "type": "number", "format": "double" }, "logisticCost": { "type": "number", "format": "double" }, "customsCost": { "type": "number", "format": "double" }, "riskCost": { "type": "number", "format": "double" }, "landedCost": { "type": "number", "format": "double", "nullable": true }, "priceUnitId": { "type": "integer", "format": "int32" }, "unitPrice": { "type": "number", "format": "double", "nullable": true }, "comment": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "sysStartTime": { "type": "string", "format": "date-time" }, "sysEndTime": { "type": "string", "format": "date-time" }, "decimalPlacesQuantitiesId": { "type": "integer", "format": "int32", "nullable": true }, "articleMatchcode": { "maxLength": 153, "minLength": 0, "type": "string", "nullable": true }, "partnerMatchcode": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.xVIEW180_EmployeeVacationEntitlementHistoryTable": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "historyId": { "type": "integer", "format": "int32", "nullable": true }, "id": { "type": "integer", "format": "int32" }, "yearId": { "type": "integer", "format": "int32" }, "employeeId": { "type": "integer", "format": "int32" }, "entitlement": { "type": "number", "format": "double" }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "sysStartTime": { "type": "string", "format": "date-time" }, "sysEndTime": { "type": "string", "format": "date-time" }, "used": { "type": "number", "format": "double" }, "remaining": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.xVIEW181_EmployeeVacationEntitlement": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "yearId": { "type": "integer", "format": "int32" }, "employeeId": { "type": "integer", "format": "int32" }, "entitlement": { "type": "number", "format": "double" }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "sysStartTime": { "type": "string", "format": "date-time" }, "sysEndTime": { "type": "string", "format": "date-time" }, "used": { "type": "number", "format": "double" }, "remaining": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.xVIEW192_WarehouseWarehouseBinLocationHierarchy": { "required": [ "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "children": { "type": "array", "items": { "$ref": "#/components/schemas/XERP.Shared.Models.xVIEW192_WarehouseWarehouseBinLocationHierarchy" }, "nullable": true }, "hasChildren": { "type": "boolean" }, "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "maxLength": 50, "minLength": 0, "type": "string" }, "parentId": { "type": "integer", "format": "int32", "nullable": true }, "warehouseId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "XERP.Shared.Models.xVIEW193_WarehouseQuantityHistoryTable": { "required": [ "articleId", "dataStatus" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "historyId": { "type": "integer", "format": "int32", "nullable": true }, "warehouseId": { "type": "integer", "format": "int32" }, "binLocationId": { "type": "integer", "format": "int32", "nullable": true }, "articleId": { "maxLength": 50, "minLength": 0, "type": "string" }, "stock": { "type": "number", "format": "double", "nullable": true }, "packed": { "type": "number", "format": "double", "nullable": true }, "nowAvailable": { "type": "number", "format": "double", "nullable": true }, "minimumStock": { "type": "number", "format": "double", "nullable": true }, "messageThreshold": { "type": "number", "format": "double", "nullable": true }, "maximumStock": { "type": "number", "format": "double", "nullable": true }, "inventoryCountingPosition": { "type": "integer", "format": "int32", "nullable": true }, "docPosition": { "type": "integer", "format": "int32", "nullable": true }, "productionPosition": { "type": "integer", "format": "int32", "nullable": true }, "transferPosition": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "sysStartTime": { "type": "string", "format": "date-time" }, "sysEndTime": { "type": "string", "format": "date-time" }, "docPositionId": { "type": "integer", "format": "int32", "nullable": true }, "docNumber": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "dataStatus": { "maxLength": 10, "minLength": 0, "type": "string" }, "warehouseInventoryCountingId": { "type": "integer", "format": "int32", "nullable": true }, "productionNumber": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "transferId": { "type": "integer", "format": "int32", "nullable": true }, "decimalPlacesQuantitiesId": { "type": "integer", "format": "int32" }, "warehousing": { "type": "boolean" } }, "additionalProperties": false }, "XERP.Shared.Models.xVIEW200_DocTypeSequence": { "required": [ "docCategoryId", "docNumberPrefix", "id", "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "maxLength": 35, "minLength": 0, "type": "string" }, "name": { "maxLength": 50, "minLength": 0, "type": "string" }, "array": { "type": "integer", "format": "int32" }, "docCategoryId": { "maxLength": 17, "minLength": 0, "type": "string" }, "docNumberPrefix": { "maxLength": 3, "minLength": 0, "type": "string" }, "inventoryStatusId": { "maxLength": 10, "minLength": 0, "type": "string", "nullable": true }, "warehousingEffective": { "type": "integer", "format": "int32" }, "prepaymentFalseArticleFactor": { "type": "integer", "format": "int32" }, "prepaymentTrueArticleFactor": { "type": "integer", "format": "int32" }, "revenueEffective": { "type": "integer", "format": "int32" }, "lastNumber": { "type": "integer", "format": "int32" }, "nextNumber": { "type": "integer", "format": "int32" }, "projectMandatory": { "type": "boolean" }, "quantityDiscountRecalculation": { "type": "boolean" }, "isOrderConfirmation": { "type": "boolean" }, "isDelivery": { "type": "boolean" }, "draft": { "type": "boolean" }, "defaultOutputControlFormatId": { "type": "integer", "format": "int32" }, "defaultReportTemplateId": { "type": "integer", "format": "int32" }, "defaultEmailTemplateId": { "type": "integer", "format": "int32" }, "active": { "type": "boolean" }, "isContract": { "type": "boolean" }, "isFieldService": { "type": "boolean" }, "defaultSuccessorId": { "maxLength": 35, "minLength": 0, "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "currentSequenceValue": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.xVIEW216_Doc_DeviceService": { "required": [ "docCategoryId", "docNumber", "docType", "docTypeId", "matchcode", "statusId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "docCategoryId": { "maxLength": 17, "minLength": 0, "type": "string" }, "docTypeId": { "maxLength": 35, "minLength": 0, "type": "string" }, "docNumber": { "maxLength": 20, "minLength": 0, "type": "string" }, "partnerId": { "type": "integer", "format": "int32", "nullable": true }, "partnerDetailId": { "type": "integer", "format": "int32", "nullable": true }, "statusId": { "maxLength": 12, "minLength": 0, "type": "string" }, "docDate": { "type": "string", "format": "date-time" }, "yourDoc": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "subject": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "totalPriceSum": { "type": "number", "format": "double" }, "totalPriceSumGross": { "type": "number", "format": "double" }, "revenueEffective": { "type": "integer", "format": "int32" }, "postingDate": { "type": "string", "format": "date-time", "nullable": true }, "docContractId": { "type": "integer", "format": "int32", "nullable": true }, "projectId": { "type": "integer", "format": "int32", "nullable": true }, "deliveryDate": { "type": "string", "format": "date-time" }, "serviceManagerId": { "type": "integer", "format": "int32", "nullable": true }, "deviceSerialNumberId": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "matchcode": { "maxLength": 100, "minLength": 0, "type": "string" }, "businessPartnerNumber": { "type": "integer", "format": "int32" }, "docType": { "maxLength": 50, "minLength": 0, "type": "string" } }, "additionalProperties": false }, "XERP.Shared.Models.xVIEW220_DocPosition": { "required": [ "docCategoryId", "docNumber", "docStatusId", "docTypeId", "positionTypeId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "docId": { "type": "integer", "format": "int32" }, "rowNumber": { "type": "integer", "format": "int32" }, "positionTypeId": { "maxLength": 15, "minLength": 0, "type": "string" }, "positionNumber": { "type": "integer", "format": "int32" }, "parentPositionId": { "type": "integer", "format": "int32", "nullable": true }, "childPositionNumber": { "type": "integer", "format": "int32", "nullable": true }, "statusId": { "maxLength": 12, "minLength": 0, "type": "string", "nullable": true }, "articleId": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "name1": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "name2": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "quantity": { "type": "number", "format": "double" }, "quantityOpen": { "type": "number", "format": "double" }, "uoMId": { "type": "integer", "format": "int32", "nullable": true }, "shippingDate": { "type": "string", "format": "date-time" }, "deliveryDate": { "type": "string", "format": "date-time" }, "price": { "type": "number", "format": "double" }, "priceUnitId": { "type": "integer", "format": "int32" }, "predecessorId": { "type": "integer", "format": "int32", "nullable": true }, "quantityTransferred": { "type": "number", "format": "double", "nullable": true }, "level": { "type": "integer", "format": "int32", "nullable": true }, "positionLabel": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "catalogNumberId": { "type": "integer", "format": "int32", "nullable": true }, "dissolve": { "type": "boolean" }, "positionWeight": { "type": "number", "format": "double", "nullable": true }, "relatedPositionId": { "type": "integer", "format": "int32", "nullable": true }, "projectId": { "type": "integer", "format": "int32", "nullable": true }, "start": { "type": "string", "format": "date-time", "nullable": true }, "stop": { "type": "string", "format": "date-time", "nullable": true }, "articleCostPrice": { "type": "number", "format": "double" }, "costPriceFactor": { "type": "integer", "format": "int32" }, "costPriceTotal": { "type": "number", "format": "double" }, "discountPercent": { "type": "number", "format": "double" }, "quantityDiscountPercent": { "type": "number", "format": "double" }, "docDiscountPercent": { "type": "number", "format": "double" }, "discountedPrice": { "type": "number", "format": "double" }, "prepaymentFactor": { "type": "integer", "format": "int32" }, "totalPrice": { "type": "number", "format": "double" }, "revenueEffective": { "type": "integer", "format": "int32", "nullable": true }, "revenue": { "type": "number", "format": "double" }, "salesPersonId": { "type": "integer", "format": "int32", "nullable": true }, "commissionPercent": { "type": "number", "format": "double" }, "commissionAmount": { "type": "number", "format": "double" }, "profitFactor": { "type": "integer", "format": "int32" }, "profitAmount": { "type": "number", "format": "double", "nullable": true }, "profitPercent": { "type": "number", "format": "double" }, "financeGroupArticleId": { "type": "integer", "format": "int32", "nullable": true }, "financeGroupPartnerDetailId": { "type": "integer", "format": "int32", "nullable": true }, "taxKeyId": { "maxLength": 3, "minLength": 0, "type": "string", "nullable": true }, "taxFactor": { "type": "integer", "format": "int32" }, "taxPercent": { "type": "number", "format": "double" }, "tax": { "type": "number", "format": "double" }, "accountId": { "type": "integer", "format": "int32", "nullable": true }, "costCenterId": { "type": "integer", "format": "int32", "nullable": true }, "costBearerId": { "type": "integer", "format": "int32", "nullable": true }, "foreignCurrencyPrice": { "type": "number", "format": "double", "nullable": true }, "warehousing": { "type": "boolean" }, "warehousingEffective": { "type": "integer", "format": "int32", "nullable": true }, "warehousingQuantity": { "type": "number", "format": "double" }, "pending": { "type": "boolean" }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "viewRowNumber": { "type": "integer", "format": "int32" }, "formattedQuantity": { "maxLength": 4000, "minLength": 0, "type": "string", "nullable": true }, "positionNumberConcat": { "maxLength": 21, "minLength": 0, "type": "string", "nullable": true }, "viewRevenue": { "type": "number", "format": "double", "nullable": true }, "viewWarehousingQuantity": { "type": "number", "format": "double", "nullable": true }, "viewNowAvailable": { "type": "number", "format": "double", "nullable": true }, "docNumber": { "maxLength": 20, "minLength": 0, "type": "string" }, "docCategoryId": { "maxLength": 17, "minLength": 0, "type": "string" }, "docTypeId": { "maxLength": 35, "minLength": 0, "type": "string" }, "inventoryStatusId": { "maxLength": 10, "minLength": 0, "type": "string", "nullable": true }, "docWarehousingEffective": { "type": "integer", "format": "int32" }, "docRevenueEffective": { "type": "integer", "format": "int32" }, "docStatusId": { "maxLength": 12, "minLength": 0, "type": "string" }, "partnerId": { "type": "integer", "format": "int32", "nullable": true }, "docDate": { "type": "string", "format": "date-time" }, "postingDate": { "type": "string", "format": "date-time", "nullable": true }, "draft": { "type": "boolean" }, "docXmlId": { "type": "integer", "format": "int32", "nullable": true }, "positionTypeName": { "maxLength": 15, "minLength": 0, "type": "string", "nullable": true }, "stock": { "type": "number", "format": "double", "nullable": true }, "confirmed": { "type": "number", "format": "double", "nullable": true }, "packed": { "type": "number", "format": "double", "nullable": true }, "ordered": { "type": "number", "format": "double", "nullable": true }, "announced": { "type": "number", "format": "double", "nullable": true }, "nowAvailable": { "type": "number", "format": "double", "nullable": true }, "laterAvailable": { "type": "number", "format": "double", "nullable": true }, "minimumStock": { "type": "number", "format": "double", "nullable": true }, "maximumStock": { "type": "number", "format": "double", "nullable": true }, "individualizationTypeId": { "maxLength": 6, "minLength": 0, "type": "string", "nullable": true }, "decimalPlacesQuantitiesId": { "type": "integer", "format": "int32", "nullable": true }, "minimumQuantity": { "type": "number", "format": "double", "nullable": true }, "deliveryTime": { "type": "integer", "format": "int32", "nullable": true }, "lotSize": { "type": "number", "format": "double", "nullable": true }, "percentageMarkup1": { "type": "number", "format": "double", "nullable": true }, "fixedMarkup1": { "type": "number", "format": "double", "nullable": true }, "intermediateCalculatedSalesPrice": { "type": "number", "format": "double", "nullable": true }, "percentageMarkup2": { "type": "number", "format": "double", "nullable": true }, "fixedMarkup2": { "type": "number", "format": "double", "nullable": true }, "calculatedSalesPrice": { "type": "number", "format": "double", "nullable": true }, "procurementPrice": { "type": "number", "format": "double", "nullable": true }, "factor": { "type": "number", "format": "double", "nullable": true }, "warehouseCost": { "type": "number", "format": "double", "nullable": true }, "overheadCost": { "type": "number", "format": "double", "nullable": true }, "otherCost": { "type": "number", "format": "double", "nullable": true }, "changeInValue": { "type": "number", "format": "double", "nullable": true }, "costPrice": { "type": "number", "format": "double", "nullable": true }, "infoText": { "type": "string", "nullable": true }, "orderText": { "type": "string", "nullable": true }, "dimensionText": { "type": "string", "nullable": true }, "matchcode": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "businessPartnerNumber": { "type": "integer", "format": "int32", "nullable": true }, "uoMName": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "parentWithSet": { "type": "boolean", "nullable": true }, "parentWithMacro": { "type": "boolean", "nullable": true }, "parentWithAccessory": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.xVIEW225_DocPositionWarehousing": { "required": [ "docCategoryId", "individualizationTypeId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "docPositionId": { "type": "integer", "format": "int32" }, "warehouseId": { "type": "integer", "format": "int32", "nullable": true }, "binLocationId": { "type": "integer", "format": "int32", "nullable": true }, "quantity": { "type": "number", "format": "double" }, "individualizationTypeId": { "maxLength": 6, "minLength": 0, "type": "string" }, "individualizationNumberId": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "warehousingEffective": { "type": "integer", "format": "int32" }, "warehousingQuantity": { "type": "number", "format": "double", "nullable": true }, "warehouseMediumId": { "type": "integer", "format": "int32", "nullable": true }, "hasBinLocation": { "type": "boolean" }, "binLocationName": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "stock": { "type": "number", "format": "double", "nullable": true }, "nowAvailable": { "type": "number", "format": "double", "nullable": true }, "docCategoryId": { "maxLength": 17, "minLength": 0, "type": "string" }, "articleId": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "isBatch": { "type": "boolean", "nullable": true }, "individualizationStock": { "type": "number", "format": "double", "nullable": true }, "individualizationPacked": { "type": "number", "format": "double", "nullable": true }, "individualizationNowAvailable": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.xVIEW265_DocXmlPosition": { "required": [ "docCategoryId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "docXmlId": { "type": "integer", "format": "int32" }, "rowNumber": { "type": "integer", "format": "int32" }, "positionTypeId": { "maxLength": 15, "minLength": 0, "type": "string", "nullable": true }, "positionNumber": { "type": "integer", "format": "int32", "nullable": true }, "parentPositionId": { "type": "integer", "format": "int32", "nullable": true }, "childPositionNumber": { "type": "integer", "format": "int32", "nullable": true }, "statusId": { "maxLength": 12, "minLength": 0, "type": "string", "nullable": true }, "articleId": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "name1": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "name2": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "quantity": { "type": "number", "format": "double" }, "quantityOpen": { "type": "number", "format": "double" }, "uoMId": { "type": "integer", "format": "int32", "nullable": true }, "shippingDate": { "type": "string", "format": "date-time" }, "deliveryDate": { "type": "string", "format": "date-time" }, "price": { "type": "number", "format": "double" }, "totalPrice": { "type": "number", "format": "double" }, "predecessorId": { "type": "integer", "format": "int32", "nullable": true }, "quantityTransferred": { "type": "number", "format": "double", "nullable": true }, "level": { "type": "integer", "format": "int32", "nullable": true }, "positionLabel": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "catalogNumberId": { "type": "integer", "format": "int32", "nullable": true }, "dissolve": { "type": "boolean" }, "positionWeight": { "type": "number", "format": "double", "nullable": true }, "relatedPositionId": { "type": "integer", "format": "int32", "nullable": true }, "projectId": { "type": "integer", "format": "int32", "nullable": true }, "start": { "type": "string", "format": "date-time", "nullable": true }, "stop": { "type": "string", "format": "date-time", "nullable": true }, "priceUnitId": { "type": "integer", "format": "int32" }, "costPriceTotal": { "type": "number", "format": "double" }, "discountPercent": { "type": "number", "format": "double" }, "quantityDiscountPercent": { "type": "number", "format": "double" }, "docDiscountPercent": { "type": "number", "format": "double" }, "discountedPrice": { "type": "number", "format": "double" }, "revenueEffective": { "type": "integer", "format": "int32", "nullable": true }, "revenue": { "type": "number", "format": "double" }, "salesPersonId": { "type": "integer", "format": "int32", "nullable": true }, "commissionPercent": { "type": "number", "format": "double" }, "commissionAmount": { "type": "number", "format": "double" }, "profitAmount": { "type": "number", "format": "double" }, "profitPercent": { "type": "number", "format": "double", "nullable": true }, "financeGroupArticleId": { "type": "integer", "format": "int32", "nullable": true }, "financeGroupPartnerDetailId": { "type": "integer", "format": "int32", "nullable": true }, "taxKeyId": { "maxLength": 3, "minLength": 0, "type": "string", "nullable": true }, "taxPercent": { "type": "number", "format": "double" }, "tax": { "type": "number", "format": "double" }, "accountId": { "type": "integer", "format": "int32", "nullable": true }, "costCenterId": { "type": "integer", "format": "int32", "nullable": true }, "costBearerId": { "type": "integer", "format": "int32", "nullable": true }, "warehousing": { "type": "boolean" }, "warehousingEffective": { "type": "integer", "format": "int32", "nullable": true }, "warehousingQuantity": { "type": "number", "format": "double", "nullable": true }, "pending": { "type": "boolean" }, "xmlArticle": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "xmlUoM": { "maxLength": 10, "minLength": 0, "type": "string", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "viewRowNumber": { "type": "integer", "format": "int32" }, "formattedQuantity": { "maxLength": 4000, "minLength": 0, "type": "string", "nullable": true }, "positionNumberConcat": { "maxLength": 21, "minLength": 0, "type": "string", "nullable": true }, "viewRevenue": { "type": "number", "format": "double", "nullable": true }, "viewWarehousingQuantity": { "type": "number", "format": "double", "nullable": true }, "viewNowAvailable": { "type": "number", "format": "double", "nullable": true }, "docNumber": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "docCategoryId": { "maxLength": 17, "minLength": 0, "type": "string" }, "docTypeId": { "maxLength": 35, "minLength": 0, "type": "string", "nullable": true }, "docDate": { "type": "string", "format": "date-time", "nullable": true }, "postingDate": { "type": "string", "format": "date-time", "nullable": true }, "draft": { "type": "boolean" }, "stock": { "type": "number", "format": "double", "nullable": true }, "confirmed": { "type": "number", "format": "double", "nullable": true }, "packed": { "type": "number", "format": "double", "nullable": true }, "ordered": { "type": "number", "format": "double", "nullable": true }, "announced": { "type": "number", "format": "double", "nullable": true }, "nowAvailable": { "type": "number", "format": "double", "nullable": true }, "laterAvailable": { "type": "number", "format": "double", "nullable": true }, "minimumStock": { "type": "number", "format": "double", "nullable": true }, "maximumStock": { "type": "number", "format": "double", "nullable": true }, "articleMatchcode": { "maxLength": 153, "minLength": 0, "type": "string", "nullable": true }, "individualizationTypeId": { "maxLength": 6, "minLength": 0, "type": "string", "nullable": true }, "decimalPlacesQuantitiesId": { "type": "integer", "format": "int32", "nullable": true }, "minimumQuantity": { "type": "number", "format": "double", "nullable": true }, "deliveryTime": { "type": "integer", "format": "int32", "nullable": true }, "lotSize": { "type": "number", "format": "double", "nullable": true }, "percentageMarkup1": { "type": "number", "format": "double", "nullable": true }, "fixedMarkup1": { "type": "number", "format": "double", "nullable": true }, "intermediateCalculatedSalesPrice": { "type": "number", "format": "double", "nullable": true }, "percentageMarkup2": { "type": "number", "format": "double", "nullable": true }, "fixedMarkup2": { "type": "number", "format": "double", "nullable": true }, "calculatedSalesPrice": { "type": "number", "format": "double", "nullable": true }, "procurementPrice": { "type": "number", "format": "double", "nullable": true }, "factor": { "type": "number", "format": "double", "nullable": true }, "warehouseCost": { "type": "number", "format": "double", "nullable": true }, "overheadCost": { "type": "number", "format": "double", "nullable": true }, "otherCost": { "type": "number", "format": "double", "nullable": true }, "changeInValue": { "type": "number", "format": "double", "nullable": true }, "costPrice": { "type": "number", "format": "double", "nullable": true }, "matchcode": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "businessPartnerNumber": { "type": "integer", "format": "int32", "nullable": true }, "uoMName": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "parentWithSet": { "type": "boolean", "nullable": true }, "parentWithMacro": { "type": "boolean", "nullable": true }, "parentWithAccessory": { "type": "boolean", "nullable": true }, "articleMatched": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.xVIEW360_MarketplaceSellerPosition": { "required": [ "sellerArticleNumber" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "salesPositionId": { "type": "integer", "format": "int32" }, "partnerId": { "type": "integer", "format": "int32", "nullable": true }, "sellerArticleNumber": { "maxLength": 100, "minLength": 0, "type": "string" }, "purchasePositionId": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "salesStatusId": { "maxLength": 12, "minLength": 0, "type": "string", "nullable": true }, "salesArticleId": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "salesName1": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "salesName2": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "salesQuantity": { "type": "number", "format": "double", "nullable": true }, "salesQuantityOpen": { "type": "number", "format": "double", "nullable": true }, "salesUoMId": { "type": "integer", "format": "int32", "nullable": true }, "salesShippingDate": { "type": "string", "format": "date-time", "nullable": true }, "salesDeliveryDate": { "type": "string", "format": "date-time", "nullable": true }, "salesPrice": { "type": "number", "format": "double", "nullable": true }, "salesPriceUnitId": { "type": "integer", "format": "int32", "nullable": true }, "salesCatalogNumberId": { "type": "integer", "format": "int32", "nullable": true }, "salesDiscountPercent": { "type": "number", "format": "double", "nullable": true }, "salesQuantityDiscountPercent": { "type": "number", "format": "double", "nullable": true }, "salesDocDiscountPercent": { "type": "number", "format": "double", "nullable": true }, "salesDiscountedPrice": { "type": "number", "format": "double", "nullable": true }, "salesRevenueEffective": { "type": "integer", "format": "int32", "nullable": true }, "salesRevenue": { "type": "number", "format": "double", "nullable": true }, "salesSalesPersonId": { "type": "integer", "format": "int32", "nullable": true }, "salesCommissionPercent": { "type": "number", "format": "double", "nullable": true }, "salesWarehousing": { "type": "boolean", "nullable": true }, "salesWarehousingEffective": { "type": "integer", "format": "int32", "nullable": true }, "salesWarehousingQuantity": { "type": "number", "format": "double", "nullable": true }, "purchaseStatusId": { "maxLength": 12, "minLength": 0, "type": "string", "nullable": true }, "purchaseArticleId": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "purchaseName1": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "purchaseName2": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "purchaseQuantity": { "type": "number", "format": "double", "nullable": true }, "purchaseQuantityOpen": { "type": "number", "format": "double", "nullable": true }, "purchaseUoMId": { "type": "integer", "format": "int32", "nullable": true }, "purchaseShippingDate": { "type": "string", "format": "date-time", "nullable": true }, "purchaseDeliveryDate": { "type": "string", "format": "date-time", "nullable": true }, "purchasePrice": { "type": "number", "format": "double", "nullable": true }, "purchasePriceUnitId": { "type": "integer", "format": "int32", "nullable": true }, "purchaseCatalogNumberId": { "type": "integer", "format": "int32", "nullable": true }, "purchaseDiscountPercent": { "type": "number", "format": "double", "nullable": true }, "purchaseQuantityDiscountPercent": { "type": "number", "format": "double", "nullable": true }, "purchaseDocDiscountPercent": { "type": "number", "format": "double", "nullable": true }, "purchaseDiscountedPrice": { "type": "number", "format": "double", "nullable": true }, "purchaseRevenueEffective": { "type": "integer", "format": "int32", "nullable": true }, "purchaseRevenue": { "type": "number", "format": "double", "nullable": true }, "purchaseSalesPersonId": { "type": "integer", "format": "int32", "nullable": true }, "purchaseCommissionPercent": { "type": "number", "format": "double", "nullable": true }, "purchaseWarehousing": { "type": "boolean", "nullable": true }, "purchaseWarehousingEffective": { "type": "integer", "format": "int32", "nullable": true }, "purchaseWarehousingQuantity": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.xVIEW420_ProductionPosition": { "required": [ "positionTypeId", "taskMode" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "productionId": { "type": "integer", "format": "int32" }, "rowNumber": { "type": "integer", "format": "int32" }, "positionTypeId": { "maxLength": 15, "minLength": 0, "type": "string" }, "articleProductionStepComponentTypeId": { "type": "integer", "format": "int32" }, "positionNumber": { "type": "integer", "format": "int32" }, "parentPositionId": { "type": "integer", "format": "int32", "nullable": true }, "childPositionNumber": { "type": "integer", "format": "int32", "nullable": true }, "productionStatusId": { "maxLength": 12, "minLength": 0, "type": "string", "nullable": true }, "articleId": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "name1": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "name2": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "quantityFactor": { "type": "number", "format": "double" }, "uoMId": { "type": "integer", "format": "int32", "nullable": true }, "positionQuantityPlanned": { "type": "number", "format": "double" }, "positionQuantityOpen": { "type": "number", "format": "double" }, "positionQuantityConfirmed": { "type": "number", "format": "double" }, "positionQuantityPick": { "type": "number", "format": "double" }, "positionQuantityPacked": { "type": "number", "format": "double" }, "positionQuantityIssued": { "type": "number", "format": "double" }, "positionQuantityConsumed": { "type": "number", "format": "double" }, "positionQuantityOrdered": { "type": "number", "format": "double" }, "positionQuantityAnnounced": { "type": "number", "format": "double" }, "positionQuantityCompleted": { "type": "number", "format": "double" }, "positionQuantityScrap": { "type": "number", "format": "double" }, "positionPlannedStart": { "type": "string", "format": "date-time", "nullable": true }, "positionPlannedEnd": { "type": "string", "format": "date-time", "nullable": true }, "positionActualStart": { "type": "string", "format": "date-time", "nullable": true }, "positionActualEnd": { "type": "string", "format": "date-time", "nullable": true }, "positionSetupSeconds": { "type": "integer", "format": "int32", "nullable": true }, "positionRunSeconds": { "type": "integer", "format": "int32", "nullable": true }, "positionDowntimeSeconds": { "type": "integer", "format": "int32", "nullable": true }, "positionPauseSeconds": { "type": "integer", "format": "int32", "nullable": true }, "lastBdeState": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "lastBdeStateAt": { "type": "string", "format": "date-time", "nullable": true }, "costPricePerUnit": { "type": "number", "format": "double" }, "costPriceTotal": { "type": "number", "format": "double" }, "level": { "type": "integer", "format": "int32", "nullable": true }, "positionLabel": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "dissolve": { "type": "boolean" }, "relatedPositionId": { "type": "integer", "format": "int32", "nullable": true }, "subTaskId": { "type": "integer", "format": "int32", "nullable": true }, "progress": { "type": "integer", "format": "int32", "nullable": true }, "predecessorTask": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "taskMode": { "maxLength": 6, "minLength": 0, "type": "string" }, "secondsOffset": { "type": "integer", "format": "int32", "nullable": true }, "warehousingEffectiveId": { "type": "integer", "format": "int32", "nullable": true }, "pending": { "type": "boolean" }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "viewRowNumber": { "type": "integer", "format": "int32" }, "formattedQuantity": { "maxLength": 4000, "minLength": 0, "type": "string", "nullable": true }, "positionNumberConcat": { "maxLength": 21, "minLength": 0, "type": "string", "nullable": true }, "viewNowAvailable": { "type": "number", "format": "double", "nullable": true }, "productionNumber": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "positionTypeName": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "stock": { "type": "number", "format": "double", "nullable": true }, "confirmed": { "type": "number", "format": "double", "nullable": true }, "packed": { "type": "number", "format": "double", "nullable": true }, "ordered": { "type": "number", "format": "double", "nullable": true }, "announced": { "type": "number", "format": "double", "nullable": true }, "nowAvailable": { "type": "number", "format": "double", "nullable": true }, "laterAvailable": { "type": "number", "format": "double", "nullable": true }, "minimumStock": { "type": "number", "format": "double", "nullable": true }, "maximumStock": { "type": "number", "format": "double", "nullable": true }, "individualizationTypeId": { "maxLength": 6, "minLength": 0, "type": "string", "nullable": true }, "decimalPlacesQuantitiesId": { "type": "integer", "format": "int32", "nullable": true }, "minimumQuantity": { "type": "number", "format": "double", "nullable": true }, "deliveryTime": { "type": "integer", "format": "int32", "nullable": true }, "lotSize": { "type": "number", "format": "double", "nullable": true }, "percentageMarkup1": { "type": "number", "format": "double", "nullable": true }, "fixedMarkup1": { "type": "number", "format": "double", "nullable": true }, "intermediateCalculatedSalesPrice": { "type": "number", "format": "double", "nullable": true }, "percentageMarkup2": { "type": "number", "format": "double", "nullable": true }, "fixedMarkup2": { "type": "number", "format": "double", "nullable": true }, "calculatedSalesPrice": { "type": "number", "format": "double", "nullable": true }, "procurementPrice": { "type": "number", "format": "double", "nullable": true }, "factor": { "type": "number", "format": "double", "nullable": true }, "warehouseCost": { "type": "number", "format": "double", "nullable": true }, "overheadCost": { "type": "number", "format": "double", "nullable": true }, "otherCost": { "type": "number", "format": "double", "nullable": true }, "changeInValue": { "type": "number", "format": "double", "nullable": true }, "costPrice": { "type": "number", "format": "double", "nullable": true }, "uoMName": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "productionDurationUnitId": { "maxLength": 1, "minLength": 0, "type": "string", "nullable": true }, "parentWithSet": { "type": "boolean", "nullable": true }, "parentWithMacro": { "type": "boolean", "nullable": true }, "parentWithAccessory": { "type": "boolean", "nullable": true }, "articleMatchcode": { "maxLength": 153, "minLength": 0, "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.xVIEW425_ProductionPositionWarehousing": { "required": [ "individualizationTypeId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "productionPositionId": { "type": "integer", "format": "int32" }, "warehouseId": { "type": "integer", "format": "int32", "nullable": true }, "binLocationId": { "type": "integer", "format": "int32", "nullable": true }, "quantity": { "type": "number", "format": "double" }, "individualizationTypeId": { "maxLength": 6, "minLength": 0, "type": "string" }, "individualizationNumberId": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "warehousingEffective": { "type": "integer", "format": "int32" }, "warehousingQuantity": { "type": "number", "format": "double", "nullable": true }, "warehouseMediumId": { "type": "integer", "format": "int32", "nullable": true }, "hasBinLocation": { "type": "boolean" }, "binLocationName": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "stock": { "type": "number", "format": "double", "nullable": true }, "nowAvailable": { "type": "number", "format": "double", "nullable": true }, "articleId": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "isBatch": { "type": "boolean", "nullable": true }, "individualizationStock": { "type": "number", "format": "double", "nullable": true }, "individualizationPacked": { "type": "number", "format": "double", "nullable": true }, "individualizationNowAvailable": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.xVIEW450_ProductionDataAcquisition": { "required": [ "action", "statusId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "rowNumber": { "type": "integer", "format": "int32" }, "productionPositionId": { "type": "integer", "format": "int32" }, "employeeId": { "type": "integer", "format": "int32" }, "employeeSessionId": { "type": "integer", "format": "int32", "nullable": true }, "workplaceId": { "type": "integer", "format": "int32", "nullable": true }, "shiftId": { "type": "integer", "format": "int32", "nullable": true }, "resourceId": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "statusId": { "maxLength": 20, "minLength": 0, "type": "string" }, "info": { "type": "string", "nullable": true }, "quantity": { "type": "number", "format": "double", "nullable": true }, "quantityType": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "goodQuantity": { "type": "number", "format": "double", "nullable": true }, "scrapQuantity": { "type": "number", "format": "double", "nullable": true }, "reasonCodeId": { "maxLength": 40, "minLength": 0, "type": "string", "nullable": true }, "progress": { "type": "integer", "format": "int32", "nullable": true }, "productionDataAcquisitionPlannedStart": { "type": "string", "format": "date-time", "nullable": true }, "productionDataAcquisitionPlannedEnd": { "type": "string", "format": "date-time", "nullable": true }, "productionDataAcquisitionActualStart": { "type": "string", "format": "date-time", "nullable": true }, "productionDataAcquisitionActualEnd": { "type": "string", "format": "date-time", "nullable": true }, "productionDataAcquisitionDurationSeconds": { "type": "integer", "format": "int32", "nullable": true }, "action": { "maxLength": 20, "minLength": 0, "type": "string" }, "sessionId": { "type": "string", "format": "uuid", "nullable": true }, "previousEventId": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "clientTimestamp": { "type": "string", "format": "date-time", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "productionNumber": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "productionId": { "type": "integer", "format": "int32" }, "positionNumberConcat": { "maxLength": 21, "minLength": 0, "type": "string", "nullable": true }, "articleMatchcode": { "maxLength": 153, "minLength": 0, "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.xVIEW500_WarehouseInventoryList": { "required": [ "articleNumber", "name1" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32", "nullable": true }, "articleNumber": { "maxLength": 50, "minLength": 0, "type": "string" }, "name1": { "maxLength": 100, "minLength": 0, "type": "string" }, "name2": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "decimalPlacesQuantitiesId": { "type": "integer", "format": "int32" }, "stock": { "type": "number", "format": "double", "nullable": true }, "packed": { "type": "number", "format": "double", "nullable": true }, "uoM": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "warehouseName": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "binLocationName": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.xVIEW501_WarehouseInventoryIndividualized": { "required": [ "articleNumber", "name1" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int64", "nullable": true }, "articleNumber": { "maxLength": 50, "minLength": 0, "type": "string" }, "name1": { "maxLength": 100, "minLength": 0, "type": "string" }, "name2": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "decimalPlacesQuantitiesId": { "type": "integer", "format": "int32" }, "articleIndividualizationId": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "stock": { "type": "number", "format": "double", "nullable": true }, "packed": { "type": "number", "format": "double", "nullable": true }, "uoM": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "warehouseName": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "binLocationName": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "individualizationType": { "maxLength": 6, "minLength": 0, "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.xVIEW520_WarehouseInventoryCountingPosition": { "required": [ "individualizationTypeId", "matchcode", "name1", "uoMName" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "warehouseInventoryCountingId": { "type": "integer", "format": "int32" }, "draft": { "type": "boolean" }, "warehouseId": { "type": "integer", "format": "int32" }, "articleId": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "binLocationId": { "type": "integer", "format": "int32", "nullable": true }, "binLocationName": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "individualizationNumberId": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "warehouseMediumId": { "type": "integer", "format": "int32", "nullable": true }, "calculatedQuantity": { "type": "number", "format": "double" }, "countedQuantity": { "type": "number", "format": "double" }, "differenceQuantity": { "type": "number", "format": "double", "nullable": true }, "matchcode": { "maxLength": 153, "minLength": 0, "type": "string" }, "name1": { "maxLength": 100, "minLength": 0, "type": "string" }, "name2": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "uoMId": { "type": "integer", "format": "int32" }, "individualizationTypeId": { "maxLength": 6, "minLength": 0, "type": "string" }, "decimalPlacesQuantitiesId": { "type": "integer", "format": "int32" }, "uoMName": { "maxLength": 20, "minLength": 0, "type": "string" } }, "additionalProperties": false }, "XERP.Shared.Models.xVIEW521_WarehouseInventoryRevaluationPosition": { "required": [ "individualizationTypeId", "name1", "uoMName" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "inventoryRevaluationId": { "type": "integer", "format": "int32" }, "draft": { "type": "boolean" }, "articleId": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "oldValue": { "type": "number", "format": "double" }, "newValue": { "type": "number", "format": "double" }, "differenceValue": { "type": "number", "format": "double", "nullable": true }, "name1": { "maxLength": 100, "minLength": 0, "type": "string" }, "name2": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "uoMId": { "type": "integer", "format": "int32" }, "individualizationTypeId": { "maxLength": 6, "minLength": 0, "type": "string" }, "uoMName": { "maxLength": 20, "minLength": 0, "type": "string" } }, "additionalProperties": false }, "XERP.Shared.Models.xVIEW522_WarehouseTransferPosition": { "required": [ "individualizationTypeId", "name1", "uoMName" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "warehouseTransferId": { "type": "integer", "format": "int32" }, "articleId": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "positionNumber": { "type": "integer", "format": "int32" }, "quantity": { "type": "number", "format": "double" }, "individualizationNumberId": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "sourceWarehouseId": { "type": "integer", "format": "int32", "nullable": true }, "sourceBinLocationId": { "type": "integer", "format": "int32", "nullable": true }, "destinationWarehouseId": { "type": "integer", "format": "int32", "nullable": true }, "destinationBinLocationId": { "type": "integer", "format": "int32", "nullable": true }, "warehouseMediumId": { "type": "integer", "format": "int32", "nullable": true }, "pending": { "type": "boolean" }, "name1": { "maxLength": 100, "minLength": 0, "type": "string" }, "name2": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "uoMId": { "type": "integer", "format": "int32" }, "individualizationTypeId": { "maxLength": 6, "minLength": 0, "type": "string" }, "decimalPlacesQuantitiesId": { "type": "integer", "format": "int32" }, "warehousing": { "type": "boolean" }, "uoMName": { "maxLength": 20, "minLength": 0, "type": "string" }, "stock": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.xVIEW552_ProcurementPurchase": { "required": [ "articleId", "procurementTypeId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "articleId": { "maxLength": 50, "minLength": 0, "type": "string" }, "procurementTypeId": { "maxLength": 4, "minLength": 0, "type": "string" }, "orderConfirmationPositionId": { "type": "integer", "format": "int32", "nullable": true }, "productionPositionId": { "type": "integer", "format": "int32", "nullable": true }, "confirmedQuantityOpen": { "type": "number", "format": "double" }, "warehouseId": { "type": "integer", "format": "int32", "nullable": true }, "binLocationId": { "type": "integer", "format": "int32", "nullable": true }, "thresholdQuantity": { "type": "number", "format": "double" }, "stockQuantityUsed": { "type": "number", "format": "double" }, "orderedQuantityUsed": { "type": "number", "format": "double" }, "announcedQuantityUsed": { "type": "number", "format": "double" }, "suggestedQuantity": { "type": "number", "format": "double" }, "supplierId": { "type": "integer", "format": "int32", "nullable": true }, "purchaseOrderPosId": { "type": "integer", "format": "int32", "nullable": true }, "productionId": { "type": "integer", "format": "int32", "nullable": true }, "info": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "articleMatchcode": { "maxLength": 153, "minLength": 0, "type": "string", "nullable": true }, "decimalPlacesQuantitiesId": { "type": "integer", "format": "int32", "nullable": true }, "warehousing": { "type": "boolean", "nullable": true }, "uoMName": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "customerMatchcode": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "supplierMatchcode": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "orderConfirmationDocNumber": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "purchaseOrderDocNumber": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "purchaseOrderDocId": { "type": "integer", "format": "int32", "nullable": true }, "orderConfirmationPositionNumber": { "type": "integer", "format": "int32", "nullable": true }, "purchaseOrderPositionNumber": { "type": "integer", "format": "int32", "nullable": true }, "orderConfirmationShippingDate": { "type": "string", "format": "date-time", "nullable": true }, "purchaseOrderDeliveryDate": { "type": "string", "format": "date-time", "nullable": true }, "nowAvailable": { "type": "number", "format": "double", "nullable": true }, "laterAvailable": { "type": "number", "format": "double", "nullable": true }, "minimumStock": { "type": "number", "format": "double", "nullable": true }, "messageThreshold": { "type": "number", "format": "double", "nullable": true }, "maximumStock": { "type": "number", "format": "double", "nullable": true }, "orderedQuantityOpen": { "type": "number", "format": "double", "nullable": true }, "announcedQuantityOpen": { "type": "number", "format": "double", "nullable": true }, "receivedQuantity": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.xVIEW554_ProcurementProduction": { "required": [ "articleId", "procurementTypeId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "articleId": { "maxLength": 50, "minLength": 0, "type": "string" }, "procurementTypeId": { "maxLength": 4, "minLength": 0, "type": "string" }, "orderConfirmationPositionId": { "type": "integer", "format": "int32", "nullable": true }, "productionPositionId": { "type": "integer", "format": "int32", "nullable": true }, "confirmedQuantityOpen": { "type": "number", "format": "double" }, "warehouseId": { "type": "integer", "format": "int32", "nullable": true }, "binLocationId": { "type": "integer", "format": "int32", "nullable": true }, "thresholdQuantity": { "type": "number", "format": "double" }, "stockQuantityUsed": { "type": "number", "format": "double" }, "orderedQuantityUsed": { "type": "number", "format": "double" }, "announcedQuantityUsed": { "type": "number", "format": "double" }, "suggestedQuantity": { "type": "number", "format": "double" }, "supplierId": { "type": "integer", "format": "int32", "nullable": true }, "purchaseOrderPosId": { "type": "integer", "format": "int32", "nullable": true }, "productionId": { "type": "integer", "format": "int32", "nullable": true }, "info": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "articleMatchcode": { "maxLength": 153, "minLength": 0, "type": "string", "nullable": true }, "decimalPlacesQuantitiesId": { "type": "integer", "format": "int32", "nullable": true }, "customerMatchcode": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "customerId": { "type": "integer", "format": "int32", "nullable": true }, "orderConfirmationDocNumber": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "orderConfirmationDocId": { "type": "integer", "format": "int32", "nullable": true }, "productionNumber": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "orderConfirmationPositionNumber": { "type": "integer", "format": "int32", "nullable": true }, "orderConfirmationShippingDate": { "type": "string", "format": "date-time", "nullable": true }, "productionPlannedEnd": { "type": "string", "format": "date-time", "nullable": true }, "nowAvailable": { "type": "number", "format": "double", "nullable": true }, "laterAvailable": { "type": "number", "format": "double", "nullable": true }, "minimumStock": { "type": "number", "format": "double", "nullable": true }, "messageThreshold": { "type": "number", "format": "double", "nullable": true }, "maximumStock": { "type": "number", "format": "double", "nullable": true }, "productionQuantityPlanned": { "type": "number", "format": "double", "nullable": true }, "productionQuantityConfirmed": { "type": "number", "format": "double", "nullable": true }, "productionQuantityOrdered": { "type": "number", "format": "double", "nullable": true }, "productionQuantityPick": { "type": "number", "format": "double", "nullable": true }, "productionQuantityPacked": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.xVIEW600_FinancePostingDraft": { "required": [ "postingStatusId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "rowNumber": { "type": "integer", "format": "int64", "nullable": true }, "id": { "type": "integer", "format": "int32" }, "postingName": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "docNumber": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "postingStatusId": { "maxLength": 12, "minLength": 0, "type": "string" }, "reversalReferenceId": { "type": "integer", "format": "int32", "nullable": true }, "postingTemplateId": { "type": "integer", "format": "int32", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "dateCreatedDATETIME": { "type": "string", "format": "date-time", "nullable": true }, "receiptNumber": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "receiptDate": { "type": "string", "format": "date-time" }, "receiptDateDATETIME": { "type": "string", "format": "date-time", "nullable": true }, "postingPeriodId": { "type": "integer", "format": "int32", "nullable": true }, "subject": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "batchNumber": { "maxLength": 10, "minLength": 0, "type": "string", "nullable": true }, "sourceId": { "maxLength": 8, "minLength": 0, "type": "string", "nullable": true }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "foreignCurrencyId": { "maxLength": 3, "minLength": 0, "type": "string", "nullable": true }, "rate": { "type": "number", "format": "double", "nullable": true }, "showForeignCurrency": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.xVIEW600_FinancePostingList": { "required": [ "accountName", "docNumber", "positionStatusId", "postingStatusId", "receiptNumber", "subject" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "financePostingPositionId": { "type": "integer", "format": "int32" }, "id": { "type": "integer", "format": "int32" }, "postingName": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "docNumber": { "maxLength": 50, "minLength": 0, "type": "string" }, "postingStatusId": { "maxLength": 12, "minLength": 0, "type": "string" }, "reversalReferenceId": { "type": "integer", "format": "int32", "nullable": true }, "postingTemplateId": { "type": "integer", "format": "int32", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "dateCreatedDATETIME": { "type": "string", "format": "date-time", "nullable": true }, "receiptNumber": { "maxLength": 50, "minLength": 0, "type": "string" }, "receiptDate": { "type": "string", "format": "date-time" }, "receiptDateDATETIME": { "type": "string", "format": "date-time", "nullable": true }, "postingPeriodId": { "type": "integer", "format": "int32" }, "subject": { "maxLength": 255, "minLength": 0, "type": "string" }, "batchNumber": { "maxLength": 10, "minLength": 0, "type": "string", "nullable": true }, "sourceId": { "maxLength": 8, "minLength": 0, "type": "string", "nullable": true }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "fixedAssetId": { "type": "integer", "format": "int32", "nullable": true }, "position": { "type": "integer", "format": "int32" }, "parentPosition": { "type": "integer", "format": "int32", "nullable": true }, "positionStatusId": { "maxLength": 12, "minLength": 0, "type": "string" }, "reversalReferencePositionId": { "type": "integer", "format": "int32", "nullable": true }, "businessPartnerNumber": { "type": "integer", "format": "int32", "nullable": true }, "accountId": { "type": "integer", "format": "int32" }, "postingPositionAccountTypeId": { "type": "integer", "format": "int32" }, "accountName": { "maxLength": 200, "minLength": 0, "type": "string" }, "openItemId": { "type": "integer", "format": "int32", "nullable": true }, "debit": { "type": "number", "format": "double" }, "credit": { "type": "number", "format": "double" }, "contraAccountId": { "type": "integer", "format": "int32", "nullable": true }, "grossValue": { "type": "number", "format": "double" }, "divergentPerformanceDate": { "type": "string", "format": "date-time", "nullable": true }, "taxKeyId": { "maxLength": 3, "minLength": 0, "type": "string", "nullable": true }, "taxPercent": { "type": "number", "format": "double", "nullable": true }, "taxAmount": { "type": "number", "format": "double" }, "costCenterId": { "type": "integer", "format": "int32", "nullable": true }, "costBearerId": { "type": "integer", "format": "int32", "nullable": true }, "openAmount": { "type": "number", "format": "double" }, "vatNumber": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "projectId": { "type": "integer", "format": "int32", "nullable": true }, "foreignCurrencyId": { "maxLength": 3, "minLength": 0, "type": "string", "nullable": true }, "rate": { "type": "number", "format": "double", "nullable": true }, "foreignCurrencyDebit": { "type": "number", "format": "double", "nullable": true }, "foreignCurrencyCredit": { "type": "number", "format": "double", "nullable": true }, "foreignCurrencyGrossValue": { "type": "number", "format": "double", "nullable": true }, "foreignCurrencyOpenAmount": { "type": "number", "format": "double", "nullable": true }, "foreignCurrencyTaxAmount": { "type": "number", "format": "double", "nullable": true }, "archived": { "type": "boolean" }, "partnerId": { "type": "integer", "format": "int32", "nullable": true }, "partnerTypeId": { "maxLength": 10, "minLength": 0, "type": "string", "nullable": true }, "costTypeId": { "type": "integer", "format": "int32", "nullable": true }, "runningBalanceAccount": { "type": "number", "format": "double", "nullable": true }, "runningBalancePartnerDetail": { "type": "number", "format": "double", "nullable": true }, "runningBalanceCostCenter": { "type": "number", "format": "double", "nullable": true }, "runningBalanceCostBearer": { "type": "number", "format": "double", "nullable": true }, "runningBalanceCostTypeId": { "type": "number", "format": "double", "nullable": true }, "runningBalanceFixedAsset": { "type": "number", "format": "double", "nullable": true }, "postingPositionAccountTypeName": { "maxLength": 15, "minLength": 0, "type": "string", "nullable": true }, "postingPeriodName": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "statusName": { "maxLength": 12, "minLength": 0, "type": "string", "nullable": true }, "calendarYearId": { "type": "integer", "format": "int32", "nullable": true }, "calendarMonthId": { "type": "integer", "format": "int32", "nullable": true }, "fiscalYearId": { "type": "integer", "format": "int32", "nullable": true }, "fiscalPeriodId": { "type": "integer", "format": "int32", "nullable": true }, "accountNameAndNumber": { "maxLength": 220, "minLength": 0, "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.xVIEW600_FinancePostingPositionDraft": { "required": [ "accountName", "accountNameAndNumber", "positionStatusId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "accountPlanTaxCodeFix": { "type": "boolean" }, "isValid": { "type": "boolean" }, "rowNumber": { "type": "integer", "format": "int64", "nullable": true }, "id": { "type": "integer", "format": "int32" }, "postingId": { "type": "integer", "format": "int32" }, "position": { "type": "integer", "format": "int32" }, "parentPosition": { "type": "integer", "format": "int32", "nullable": true }, "positionStatusId": { "maxLength": 12, "minLength": 0, "type": "string" }, "reversalReferencePositionId": { "type": "integer", "format": "int32", "nullable": true }, "partnerDetailId": { "type": "integer", "format": "int32", "nullable": true }, "businessPartnerNumber": { "type": "integer", "format": "int32", "nullable": true }, "accountId": { "type": "integer", "format": "int32" }, "postingPositionAccountTypeId": { "type": "integer", "format": "int32" }, "accountName": { "maxLength": 200, "minLength": 0, "type": "string" }, "openItemId": { "type": "integer", "format": "int32", "nullable": true }, "debit": { "type": "number", "format": "double" }, "credit": { "type": "number", "format": "double" }, "contraAccountId": { "type": "integer", "format": "int32", "nullable": true }, "grossValue": { "type": "number", "format": "double" }, "divergentPerformanceDate": { "type": "string", "format": "date-time", "nullable": true }, "taxKeyId": { "maxLength": 3, "minLength": 0, "type": "string", "nullable": true }, "taxPercent": { "type": "number", "format": "double", "nullable": true }, "taxAmount": { "type": "number", "format": "double" }, "costCenterId": { "type": "integer", "format": "int32", "nullable": true }, "costBearerId": { "type": "integer", "format": "int32", "nullable": true }, "openAmount": { "type": "number", "format": "double" }, "vatNumber": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "projectId": { "type": "integer", "format": "int32", "nullable": true }, "foreignCurrencyDebit": { "type": "number", "format": "double", "nullable": true }, "foreignCurrencyCredit": { "type": "number", "format": "double", "nullable": true }, "foreignCurrencyGrossValue": { "type": "number", "format": "double", "nullable": true }, "foreignCurrencyOpenAmount": { "type": "number", "format": "double", "nullable": true }, "foreignCurrencyTaxAmount": { "type": "number", "format": "double", "nullable": true }, "postingName": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "docNumber": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "postingStatusId": { "maxLength": 12, "minLength": 0, "type": "string", "nullable": true }, "reversalReferenceId": { "type": "integer", "format": "int32", "nullable": true }, "postingTemplateId": { "type": "integer", "format": "int32", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time", "nullable": true }, "dateCreatedDATETIME": { "type": "string", "format": "date-time", "nullable": true }, "receiptNumber": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "receiptDate": { "type": "string", "format": "date-time", "nullable": true }, "receiptDateDATETIME": { "type": "string", "format": "date-time", "nullable": true }, "postingPeriodId": { "type": "integer", "format": "int32", "nullable": true }, "subject": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "batchNumber": { "maxLength": 10, "minLength": 0, "type": "string", "nullable": true }, "sourceId": { "maxLength": 8, "minLength": 0, "type": "string", "nullable": true }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "foreignCurrencyId": { "maxLength": 3, "minLength": 0, "type": "string", "nullable": true }, "rate": { "type": "number", "format": "double", "nullable": true }, "archived": { "type": "boolean" }, "partnerId": { "type": "integer", "format": "int32", "nullable": true }, "partnerTypeId": { "maxLength": 10, "minLength": 0, "type": "string", "nullable": true }, "costTypeId": { "type": "integer", "format": "int32", "nullable": true }, "accountForeignCurrencyId": { "maxLength": 3, "minLength": 0, "type": "string", "nullable": true }, "runningBalanceAccount": { "type": "number", "format": "double", "nullable": true }, "runningBalancePartnerDetail": { "type": "number", "format": "double", "nullable": true }, "runningBalanceCostCenter": { "type": "number", "format": "double", "nullable": true }, "runningBalanceCostBearer": { "type": "number", "format": "double", "nullable": true }, "runningBalanceCostTypeId": { "type": "number", "format": "double", "nullable": true }, "postingPositionAccountTypeName": { "maxLength": 15, "minLength": 0, "type": "string", "nullable": true }, "postingPeriodName": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "statusName": { "maxLength": 12, "minLength": 0, "type": "string", "nullable": true }, "calendarYearId": { "type": "integer", "format": "int32", "nullable": true }, "calendarMonthId": { "type": "integer", "format": "int32", "nullable": true }, "fiscalPeriodId": { "type": "integer", "format": "int32", "nullable": true }, "accountNameAndNumber": { "maxLength": 223, "minLength": 0, "type": "string" } }, "additionalProperties": false }, "XERP.Shared.Models.xVIEW603_FinanceOpenItemReconciliationPosition": { "required": [ "docNumber", "openItemTypeId", "openItemTypeName" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "reconciliationId": { "type": "integer", "format": "int32" }, "reconciliationPosition": { "type": "integer", "format": "int32" }, "openItemId": { "type": "integer", "format": "int32" }, "partnerId": { "type": "integer", "format": "int32", "nullable": true }, "partnerDetailId": { "type": "integer", "format": "int32", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time", "nullable": true }, "matchcode": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "businessPartnerNumber": { "type": "integer", "format": "int32", "nullable": true }, "partnerTypeId": { "maxLength": 10, "minLength": 0, "type": "string", "nullable": true }, "openItemTypeId": { "maxLength": 2, "minLength": 0, "type": "string" }, "openItemTypeName": { "maxLength": 30, "minLength": 0, "type": "string" }, "amount": { "type": "number", "format": "double" }, "docDate": { "type": "string", "format": "date-time" }, "docNumber": { "maxLength": 50, "minLength": 0, "type": "string" }, "referenceDoc": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.xVIEW605_FinanceAccountPlan": { "required": [ "accountNumber", "matchcode", "name" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "accountNumber": { "maxLength": 20, "minLength": 0, "type": "string" }, "name": { "maxLength": 200, "minLength": 0, "type": "string" }, "matchcode": { "maxLength": 220, "minLength": 0, "type": "string" }, "accountGroupId": { "type": "integer", "format": "int32" }, "taxKeyId": { "maxLength": 3, "minLength": 0, "type": "string", "nullable": true }, "accountTypeId": { "type": "integer", "format": "int32" }, "purposeId": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "assignmentId": { "type": "integer", "format": "int32" }, "foreignCurrencyId": { "maxLength": 3, "minLength": 0, "type": "string", "nullable": true }, "balance": { "type": "number", "format": "double" }, "foreignCurrencyBalance": { "type": "number", "format": "double", "nullable": true }, "balanceTransfer": { "type": "boolean" }, "taxCodeFix": { "type": "boolean" }, "assetAccount": { "type": "boolean" }, "indirect": { "type": "boolean" }, "costing": { "type": "boolean" }, "costTypeId": { "type": "integer", "format": "int32", "nullable": true }, "accountCategoryId": { "type": "integer", "format": "int32", "nullable": true }, "costCenterId": { "type": "integer", "format": "int32", "nullable": true }, "costBearerId": { "type": "integer", "format": "int32", "nullable": true }, "debitSide": { "type": "boolean" }, "active": { "type": "boolean" }, "favorite": { "type": "boolean" }, "parentId": { "type": "integer", "format": "int32", "nullable": true }, "balanceGroupId": { "type": "integer", "format": "int32", "nullable": true }, "profitLossGroupId": { "type": "integer", "format": "int32", "nullable": true }, "businessAssessmentGroupId": { "type": "integer", "format": "int32", "nullable": true }, "datevAccount": { "type": "integer", "format": "int32", "nullable": true }, "datevAutomaticAccount": { "type": "boolean" }, "assetClassId": { "type": "integer", "format": "int32", "nullable": true }, "warnOnNegativeBalance": { "type": "boolean" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "sysStartTime": { "type": "string", "format": "date-time" }, "sysEndTime": { "type": "string", "format": "date-time" }, "financeTaxKeyName": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "accountAssignment": { "maxLength": 10, "minLength": 0, "type": "string", "nullable": true }, "category": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "accountType": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "costBearer": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "costCenter": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "costType": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "accountPurpose": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.xVIEW621_FinanceAccountReconciliationPosition": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "reconciliationId": { "type": "integer", "format": "int32" }, "reconciliationPosition": { "type": "integer", "format": "int32" }, "postingPositionId": { "type": "integer", "format": "int32" }, "amount": { "type": "number", "format": "double" }, "dateCreated": { "type": "string", "format": "date-time", "nullable": true }, "postingId": { "type": "integer", "format": "int32" }, "position": { "type": "integer", "format": "int32" }, "debit": { "type": "number", "format": "double" }, "credit": { "type": "number", "format": "double" }, "openAmount": { "type": "number", "format": "double" }, "accountId": { "type": "integer", "format": "int32" }, "businessPartnerNumber": { "type": "integer", "format": "int32", "nullable": true }, "subject": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "receiptDate": { "type": "string", "format": "date-time", "nullable": true }, "totalPositiveReconciliationPositionAmount": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.xVIEW635_FinanceOpeningBalancePosition": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "openingBalanceId": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "partnerDetailId": { "type": "integer", "format": "int32", "nullable": true }, "amount": { "type": "number", "format": "double" }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "name": { "maxLength": 200, "minLength": 0, "type": "string", "nullable": true }, "businessPartnerNumber": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.xVIEW640_FinancePaymentPosition": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "financePaymentId": { "type": "integer", "format": "int32", "nullable": true }, "position": { "type": "integer", "format": "int32" }, "openItemId": { "type": "integer", "format": "int32" }, "amount": { "type": "number", "format": "double" }, "cashDiscountAmount": { "type": "number", "format": "double" }, "purpose": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "bankAccountId": { "type": "integer", "format": "int32", "nullable": true }, "bankNumberId": { "maxLength": 40, "minLength": 0, "type": "string", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "openItemTypeName": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "docDate": { "type": "string", "format": "date-time", "nullable": true }, "referenceDoc": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "openAmount": { "type": "number", "format": "double", "nullable": true }, "partnerId": { "type": "integer", "format": "int32", "nullable": true }, "partnerDetailId": { "type": "integer", "format": "int32", "nullable": true }, "dueDate": { "type": "string", "format": "date-time", "nullable": true }, "cashDiscountDate1": { "type": "string", "format": "date-time", "nullable": true }, "cashDiscountPercentage1": { "type": "number", "format": "double", "nullable": true }, "cashDiscountDate2": { "type": "string", "format": "date-time", "nullable": true }, "cashDiscountPercentage2": { "type": "number", "format": "double", "nullable": true }, "matchcode": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "businessPartnerNumber": { "type": "integer", "format": "int32", "nullable": true }, "bankAccountNumber": { "maxLength": 34, "minLength": 0, "type": "string", "nullable": true }, "accountOwner": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "bankId": { "maxLength": 40, "minLength": 0, "type": "string", "nullable": true }, "totalAmountPerPartner": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.xVIEW645_FinanceClosingPostingPosition": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "closingPostingId": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "amount": { "type": "number", "format": "double" }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "matchcode": { "maxLength": 220, "minLength": 0, "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.xVIEW660_FinanceTransferPosition": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "transferId": { "type": "integer", "format": "int32" }, "statementID": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "position": { "type": "integer", "format": "int32" }, "postingPeriodId": { "type": "integer", "format": "int32", "nullable": true }, "entryReference": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "messageID": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "amount": { "type": "number", "format": "double", "nullable": true }, "foreignCurrencyAmount": { "type": "number", "format": "double", "nullable": true }, "rate": { "type": "number", "format": "double", "nullable": true }, "balance": { "type": "number", "format": "double", "nullable": true }, "charge": { "type": "number", "format": "double", "nullable": true }, "interest": { "type": "number", "format": "double", "nullable": true }, "accountId": { "type": "integer", "format": "int32", "nullable": true }, "debitSide": { "type": "boolean" }, "statementDate": { "type": "string", "format": "date-time", "nullable": true }, "valueDate": { "type": "string", "format": "date-time", "nullable": true }, "categoryName": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "transferCategoryId": { "type": "integer", "format": "int32", "nullable": true }, "transactionType": { "maxLength": 10, "minLength": 0, "type": "string", "nullable": true }, "textKeyId": { "type": "integer", "format": "int32", "nullable": true }, "memo1": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "memo2": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "memo3": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "memo4": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "memo5": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "memo6": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "memo7": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "memo8": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "memo9": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "memo10": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "memo11": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "memo12": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "memo13": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "memo14": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "mandateReference": { "maxLength": 35, "minLength": 0, "type": "string", "nullable": true }, "name": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "customerPartnerDetailId": { "type": "integer", "format": "int32", "nullable": true }, "supplierPartnerDetailId": { "type": "integer", "format": "int32", "nullable": true }, "openItemReference": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "openItemId": { "type": "integer", "format": "int32", "nullable": true }, "email": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "payPalArt": { "maxLength": 80, "minLength": 0, "type": "string", "nullable": true }, "payPalStatus": { "maxLength": 80, "minLength": 0, "type": "string", "nullable": true }, "reference": { "maxLength": 40, "minLength": 0, "type": "string", "nullable": true }, "bankTransactionCode": { "maxLength": 40, "minLength": 0, "type": "string", "nullable": true }, "xmlLevel": { "type": "integer", "format": "int32", "nullable": true }, "msgId": { "maxLength": 35, "minLength": 0, "type": "string", "nullable": true }, "endToEndId": { "maxLength": 35, "minLength": 0, "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "subject": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "draft": { "type": "boolean", "nullable": true }, "companyBankAccountId": { "maxLength": 34, "minLength": 0, "type": "string", "nullable": true }, "receiptNumber": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "receiptDate": { "type": "string", "format": "date-time", "nullable": true }, "customerNumberAndMatchcode": { "maxLength": 133, "minLength": 0, "type": "string", "nullable": true }, "supplierNumberAndMatchcode": { "maxLength": 133, "minLength": 0, "type": "string", "nullable": true }, "sumAssignedAmount": { "type": "number", "format": "double", "nullable": true }, "matchcode": { "maxLength": 220, "minLength": 0, "type": "string", "nullable": true }, "showForeignCurrency": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.xVIEW661_FinanceTransferPositionAccountPlan": { "required": [ "accountName" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "transferPositionId": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "amount": { "type": "number", "format": "double" }, "taxKeyId": { "maxLength": 3, "minLength": 0, "type": "string", "nullable": true }, "accountName": { "maxLength": 200, "minLength": 0, "type": "string" }, "partnerDetailId": { "type": "integer", "format": "int32", "nullable": true }, "costCenterId": { "type": "integer", "format": "int32", "nullable": true }, "costBearerId": { "type": "integer", "format": "int32", "nullable": true }, "projectId": { "type": "integer", "format": "int32", "nullable": true }, "foreignCurrencyAmount": { "type": "number", "format": "double", "nullable": true }, "accountPlanMatchcode": { "maxLength": 220, "minLength": 0, "type": "string", "nullable": true }, "costCenter": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "costBearer": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "businessPartnerNumber": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.xVIEW662_FinanceTransferPositionOpenItem": { "required": [ "docNumber", "financeOpenItemStatusName", "openItemOrigin", "openItemOriginId", "openItemTypeId", "partnerTypeId", "partnerTypeName", "statusId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "transferPositionId": { "type": "integer", "format": "int32" }, "openItemId": { "type": "integer", "format": "int32" }, "paymentAmount": { "type": "number", "format": "double" }, "cashDiscountAmount": { "type": "number", "format": "double" }, "previouslyOpen": { "type": "number", "format": "double" }, "foreignCurrencyPaymentAmount": { "type": "number", "format": "double", "nullable": true }, "foreignCurrencyCashDiscountAmount": { "type": "number", "format": "double", "nullable": true }, "foreignCurrencyPermissibleAmount": { "type": "number", "format": "double", "nullable": true }, "foreignCurrencyRemaining": { "type": "number", "format": "double", "nullable": true }, "currencyDifference": { "type": "number", "format": "double", "nullable": true }, "currencyDifferenceAccountId": { "type": "integer", "format": "int32", "nullable": true }, "currencyDifferenceSubject": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "statusId": { "maxLength": 12, "minLength": 0, "type": "string" }, "openItemOriginId": { "maxLength": 8, "minLength": 0, "type": "string" }, "openItemTypeId": { "maxLength": 2, "minLength": 0, "type": "string" }, "docTypeId": { "maxLength": 35, "minLength": 0, "type": "string", "nullable": true }, "partnerTypeId": { "maxLength": 10, "minLength": 0, "type": "string" }, "partnerId": { "type": "integer", "format": "int32" }, "partnerDetailId": { "type": "integer", "format": "int32" }, "postingId": { "type": "integer", "format": "int32", "nullable": true }, "postingDate": { "type": "string", "format": "date-time" }, "docDate": { "type": "string", "format": "date-time" }, "docNumber": { "maxLength": 50, "minLength": 0, "type": "string" }, "openItemAmount": { "type": "number", "format": "double" }, "foreignCurrencyId": { "maxLength": 3, "minLength": 0, "type": "string", "nullable": true }, "rate": { "type": "number", "format": "double", "nullable": true }, "discountable": { "type": "boolean" }, "dueDate": { "type": "string", "format": "date-time" }, "cashDiscountDate1": { "type": "string", "format": "date-time", "nullable": true }, "cashDiscountPercentage1": { "type": "number", "format": "double", "nullable": true }, "cashDiscountDate2": { "type": "string", "format": "date-time", "nullable": true }, "cashDiscountPercentage2": { "type": "number", "format": "double", "nullable": true }, "openItemCashDiscountAmount": { "type": "number", "format": "double" }, "openAmount": { "type": "number", "format": "double" }, "remaining": { "type": "number", "format": "double" }, "remark1": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "remark2": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "referenceDoc": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "contraAccountId": { "type": "integer", "format": "int32", "nullable": true }, "costCenterId": { "type": "integer", "format": "int32", "nullable": true }, "costBearerId": { "type": "integer", "format": "int32", "nullable": true }, "dunningBlock": { "type": "boolean" }, "paymentBlock": { "type": "boolean" }, "dunningLevelId": { "type": "integer", "format": "int32", "nullable": true }, "dunningDate": { "type": "string", "format": "date-time", "nullable": true }, "newDueDate": { "type": "string", "format": "date-time", "nullable": true }, "taxSplit": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "docSplit": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "termsOfPaymentId": { "type": "integer", "format": "int32", "nullable": true }, "archived": { "type": "boolean" }, "probabilityOfPayment": { "type": "number", "format": "double" }, "foreignCurrencyAmount": { "type": "number", "format": "double", "nullable": true }, "openItemForeignCurrencyCashDiscountAmount": { "type": "number", "format": "double", "nullable": true }, "foreignCurrencyOpenAmount": { "type": "number", "format": "double", "nullable": true }, "financeOpenItemStatusName": { "maxLength": 12, "minLength": 0, "type": "string" }, "openItemOrigin": { "maxLength": 8, "minLength": 0, "type": "string" }, "accountPlanMatchcode": { "maxLength": 220, "minLength": 0, "type": "string", "nullable": true }, "costCenter": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "costBearer": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "partnerTypeName": { "maxLength": 20, "minLength": 0, "type": "string" }, "docTypeName": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "businessPartnerNumberAndMatchcode": { "maxLength": 133, "minLength": 0, "type": "string", "nullable": true }, "financeDunningLevelInfo": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "openItemTypeName": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "applicablePercent": { "type": "number", "format": "double" }, "permissibleAmount": { "type": "number", "format": "double" }, "currencyDifferenceAccountMatchcode": { "maxLength": 220, "minLength": 0, "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.xVIEW670_DueAndOverDue": { "required": [ "subject" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "partnerId": { "type": "integer", "format": "int32" }, "subject": { "maxLength": 100, "minLength": 0, "type": "string" }, "followUp": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.xVIEW821_CountryPackageIntrastatCandidate": { "required": [ "docTypeId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "docPositionId": { "type": "integer", "format": "int32" }, "docId": { "type": "integer", "format": "int32" }, "docTypeId": { "maxLength": 35, "minLength": 0, "type": "string" }, "articleId": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "partnerId": { "type": "integer", "format": "int32", "nullable": true }, "movementDate": { "type": "string", "format": "date-time" }, "referenceYear": { "type": "integer", "format": "int32", "nullable": true }, "referenceMonth": { "type": "integer", "format": "int32", "nullable": true }, "directionId": { "maxLength": 8, "minLength": 0, "type": "string", "nullable": true }, "partnerCountryId": { "maxLength": 2, "minLength": 0, "type": "string", "nullable": true }, "partnerDispatchCountryId": { "maxLength": 2, "minLength": 0, "type": "string", "nullable": true }, "commodityCode": { "maxLength": 8, "minLength": 0, "type": "string", "nullable": true }, "countryOfOriginId": { "maxLength": 2, "minLength": 0, "type": "string", "nullable": true }, "transactionTypeId": { "maxLength": 2, "minLength": 0, "type": "string", "nullable": true }, "transportModeId": { "maxLength": 1, "minLength": 0, "type": "string", "nullable": true }, "regionCode": { "maxLength": 2, "minLength": 0, "type": "string", "nullable": true }, "partnerVatId": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "invoiceValueEur": { "type": "number", "format": "double", "nullable": true }, "statisticalValueEur": { "type": "number", "format": "double", "nullable": true }, "netMassKg": { "type": "number", "format": "double", "nullable": true }, "supplementaryQuantity": { "type": "number", "format": "double", "nullable": true }, "included": { "type": "boolean", "nullable": true }, "isManual": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.xVIEW_Article": { "required": [ "articleGroup", "id", "individualizationTypeId", "matchcode", "name1", "procurementTypeId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "propertyBag": { "type": "string", "nullable": true }, "id": { "maxLength": 50, "minLength": 0, "type": "string" }, "articleTypeId": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "name1": { "maxLength": 100, "minLength": 0, "type": "string" }, "name2": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "matchcode": { "maxLength": 153, "minLength": 0, "type": "string" }, "articleGroupId": { "type": "integer", "format": "int32" }, "uoMId": { "type": "integer", "format": "int32" }, "decimalPlacesQuantitiesId": { "type": "integer", "format": "int32" }, "warehousing": { "type": "boolean" }, "active": { "type": "boolean" }, "favorite": { "type": "boolean" }, "priceUnitId": { "type": "integer", "format": "int32" }, "manufacturerId": { "type": "integer", "format": "int32", "nullable": true }, "manufacturerOrderNumber": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "warehouseInfoId": { "type": "integer", "format": "int32", "nullable": true }, "shop": { "type": "boolean" }, "printing": { "type": "boolean" }, "weight": { "type": "number", "format": "double", "nullable": true }, "length": { "type": "number", "format": "double", "nullable": true }, "width": { "type": "number", "format": "double", "nullable": true }, "height": { "type": "number", "format": "double", "nullable": true }, "volume": { "type": "number", "format": "double", "nullable": true }, "content": { "type": "number", "format": "double", "nullable": true }, "contentUoMId": { "type": "integer", "format": "int32", "nullable": true }, "gtin": { "maxLength": 18, "minLength": 0, "type": "string", "nullable": true }, "salesArticle": { "type": "boolean" }, "salesFinanceGroupId": { "type": "integer", "format": "int32" }, "lotSize": { "type": "number", "format": "double" }, "minimumQuantity": { "type": "number", "format": "double" }, "deliveryTime": { "type": "integer", "format": "int32" }, "purchaseArticle": { "type": "boolean" }, "transferToPurchase": { "type": "boolean" }, "procurementFinanceGroupId": { "type": "integer", "format": "int32" }, "procurementTypeId": { "maxLength": 4, "minLength": 0, "type": "string" }, "procurementTime": { "type": "integer", "format": "int32" }, "standardSupplierId": { "type": "integer", "format": "int32", "nullable": true }, "standardWarehouseId": { "type": "integer", "format": "int32", "nullable": true }, "negativeInventoryAllowed": { "type": "boolean" }, "individualizationTypeId": { "maxLength": 6, "minLength": 0, "type": "string" }, "withMacro": { "type": "boolean" }, "withSet": { "type": "boolean" }, "withAccessory": { "type": "boolean" }, "isEndProduct": { "type": "boolean" }, "isProductionStep": { "type": "boolean" }, "isProductionTime": { "type": "boolean" }, "isPrepayment": { "type": "boolean" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "sysStartTime": { "type": "string", "format": "date-time" }, "sysEndTime": { "type": "string", "format": "date-time" }, "articleGroup": { "maxLength": 50, "minLength": 0, "type": "string" }, "stock": { "type": "number", "format": "double", "nullable": true }, "nowAvailable": { "type": "number", "format": "double", "nullable": true }, "confirmed": { "type": "number", "format": "double", "nullable": true }, "packed": { "type": "number", "format": "double", "nullable": true }, "ordered": { "type": "number", "format": "double", "nullable": true }, "announced": { "type": "number", "format": "double", "nullable": true }, "laterAvailable": { "type": "number", "format": "double", "nullable": true }, "minimumStock": { "type": "number", "format": "double", "nullable": true }, "messageThreshold": { "type": "number", "format": "double", "nullable": true }, "maximumStock": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.xVIEW_Doc": { "required": [ "docCategoryId", "docNumber", "docType", "docTypeId", "matchcode", "statusId" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "propertyBag": { "type": "string", "nullable": true }, "id": { "type": "integer", "format": "int32" }, "docCategoryId": { "maxLength": 17, "minLength": 0, "type": "string" }, "docTypeId": { "maxLength": 35, "minLength": 0, "type": "string" }, "docNumber": { "maxLength": 20, "minLength": 0, "type": "string" }, "inventoryStatusId": { "maxLength": 10, "minLength": 0, "type": "string", "nullable": true }, "warehousingEffective": { "type": "integer", "format": "int32" }, "revenueEffective": { "type": "integer", "format": "int32" }, "partnerId": { "type": "integer", "format": "int32", "nullable": true }, "partnerDetailId": { "type": "integer", "format": "int32", "nullable": true }, "statusId": { "maxLength": 12, "minLength": 0, "type": "string" }, "transferable": { "type": "boolean" }, "draft": { "type": "boolean" }, "docDate": { "type": "string", "format": "date-time" }, "postingDate": { "type": "string", "format": "date-time", "nullable": true }, "postingPeriodId": { "type": "integer", "format": "int32", "nullable": true }, "shippingDate": { "type": "string", "format": "date-time" }, "deliveryDate": { "type": "string", "format": "date-time" }, "partnerContactPersonId": { "type": "integer", "format": "int32", "nullable": true }, "clerkId": { "type": "integer", "format": "int32" }, "salesPersonId": { "type": "integer", "format": "int32", "nullable": true }, "ourReference": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "yourDoc": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "yourDocDate": { "type": "string", "format": "date-time", "nullable": true }, "internalRemark": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "subject": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "version": { "type": "integer", "format": "int32", "nullable": true }, "divergentInvoiceRecipientId": { "type": "integer", "format": "int32", "nullable": true }, "termsOfDeliveryId": { "type": "integer", "format": "int32", "nullable": true }, "euWork": { "type": "boolean" }, "languageId": { "maxLength": 5, "minLength": 0, "type": "string", "nullable": true }, "reportTemplateId": { "type": "integer", "format": "int32" }, "approvalRequired": { "type": "boolean" }, "eDocTypeId": { "type": "integer", "format": "int32" }, "termsOfPaymentId": { "type": "integer", "format": "int32", "nullable": true }, "projectId": { "type": "integer", "format": "int32", "nullable": true }, "priceListId": { "type": "integer", "format": "int32", "nullable": true }, "docDiscountPercent": { "type": "number", "format": "double" }, "downPaymentRequest": { "type": "number", "format": "double" }, "downPaymentSum": { "type": "number", "format": "double" }, "balanceDue": { "type": "number", "format": "double", "nullable": true }, "foreignCurrencyId": { "maxLength": 3, "minLength": 0, "type": "string", "nullable": true }, "rate": { "type": "number", "format": "double", "nullable": true }, "locationId": { "type": "integer", "format": "int32" }, "standardWarehouseId": { "type": "integer", "format": "int32", "nullable": true }, "docContractId": { "type": "integer", "format": "int32", "nullable": true }, "docXmlId": { "type": "integer", "format": "int32", "nullable": true }, "archived": { "type": "boolean" }, "outputControlFormatId": { "type": "integer", "format": "int32" }, "blocked": { "type": "boolean" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "matchcode": { "maxLength": 100, "minLength": 0, "type": "string" }, "businessPartnerNumber": { "type": "integer", "format": "int32" }, "docType": { "maxLength": 50, "minLength": 0, "type": "string" }, "prepaymentTrueArticleFactor": { "type": "integer", "format": "int32" }, "nextAppointment": { "type": "string", "format": "date-time", "nullable": true }, "nextExecutionDate": { "type": "string", "format": "date-time", "nullable": true }, "costPriceSum": { "type": "number", "format": "double" }, "totalPriceSum": { "type": "number", "format": "double" }, "commissionSum": { "type": "number", "format": "double" }, "profitSum": { "type": "number", "format": "double" }, "profitAfterCommissionSum": { "type": "number", "format": "double" }, "taxSum": { "type": "number", "format": "double" }, "totalPriceSumGross": { "type": "number", "format": "double" }, "count": { "type": "integer", "format": "int64" }, "profitPercent": { "type": "number", "format": "double" }, "profitAfterCommissionPercent": { "type": "number", "format": "double" }, "totalPriceSumForeignCurrency": { "type": "number", "format": "double" }, "taxSumForeignCurrency": { "type": "number", "format": "double" }, "totalPriceSumGrossForeignCurrency": { "type": "number", "format": "double" } }, "additionalProperties": false }, "XERP.Shared.Models.xVIEW_Employee": { "required": [ "email", "firstName", "lastName", "matchcode" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "propertyBag": { "type": "string", "nullable": true }, "id": { "type": "integer", "format": "int32" }, "title": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "salutation": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "firstName": { "maxLength": 100, "minLength": 0, "type": "string" }, "lastName": { "maxLength": 100, "minLength": 0, "type": "string" }, "street": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "zip": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "city": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "countryId": { "maxLength": 2, "minLength": 0, "type": "string", "nullable": true }, "position": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "matchcode": { "maxLength": 50, "minLength": 0, "type": "string" }, "tel1": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "tel2": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "mobile": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "fax": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "email": { "maxLength": 100, "minLength": 0, "type": "string" }, "normalizedEmail": { "maxLength": 256, "minLength": 0, "type": "string", "nullable": true }, "emailConfirmed": { "type": "boolean" }, "passwordHash": { "maxLength": 256, "minLength": 0, "type": "string", "nullable": true }, "changePasswordAtNextLogin": { "type": "boolean" }, "securityStamp": { "maxLength": 256, "minLength": 0, "type": "string", "nullable": true }, "concurrencyStamp": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "twoFactorEnabled": { "type": "boolean" }, "lockoutEnd": { "type": "string", "format": "date-time", "nullable": true }, "lockoutEnabled": { "type": "boolean" }, "accessFailedCount": { "type": "integer", "format": "int32", "nullable": true }, "remark": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "info": { "maxLength": 1000, "minLength": 0, "type": "string", "nullable": true }, "active": { "type": "boolean" }, "salesperson": { "type": "boolean" }, "technician": { "type": "boolean" }, "crmEmployee": { "type": "boolean" }, "favorite": { "type": "boolean" }, "commissionGroupId": { "type": "integer", "format": "int32", "nullable": true }, "employeeGroupId": { "type": "integer", "format": "int32" }, "keyword": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "userId": { "maxLength": 450, "minLength": 0, "type": "string", "nullable": true }, "emailSenderXerpId": { "type": "integer", "format": "int32", "nullable": true }, "emailReceiverXerpId": { "type": "integer", "format": "int32", "nullable": true }, "superiorId": { "type": "integer", "format": "int32", "nullable": true }, "locationId": { "type": "integer", "format": "int32" }, "calendarNameId": { "type": "integer", "format": "int32", "nullable": true }, "calendarColor": { "maxLength": 9, "minLength": 0, "type": "string", "nullable": true }, "calendarReminderMinutes": { "type": "integer", "format": "int32", "nullable": true }, "isTimeTracking": { "type": "boolean" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "connectedUserId": { "maxLength": 450, "minLength": 0, "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.xVIEW_Partner": { "required": [ "city", "countryId", "email", "languageId", "matchcode", "name1", "street", "zip" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "propertyBag": { "type": "string", "nullable": true }, "id": { "type": "integer", "format": "int32" }, "partnerNumber": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "name1": { "maxLength": 100, "minLength": 0, "type": "string" }, "name2": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "street": { "maxLength": 100, "minLength": 0, "type": "string" }, "zip": { "maxLength": 20, "minLength": 0, "type": "string" }, "city": { "maxLength": 50, "minLength": 0, "type": "string" }, "countryId": { "maxLength": 2, "minLength": 0, "type": "string" }, "matchcode": { "maxLength": 100, "minLength": 0, "type": "string" }, "partnerGroupId": { "type": "integer", "format": "int32" }, "tel1": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "tel2": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "mobile": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "fax": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "email": { "maxLength": 256, "minLength": 0, "type": "string" }, "normalizedEmail": { "maxLength": 256, "minLength": 0, "type": "string", "nullable": true }, "emailConfirmed": { "type": "boolean" }, "passwordHash": { "maxLength": 256, "minLength": 0, "type": "string", "nullable": true }, "changePasswordAtNextLogin": { "type": "boolean" }, "securityStamp": { "maxLength": 256, "minLength": 0, "type": "string", "nullable": true }, "concurrencyStamp": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "twoFactorEnabled": { "type": "boolean" }, "lockoutEnd": { "type": "string", "format": "date-time", "nullable": true }, "lockoutEnabled": { "type": "boolean" }, "accessFailedCount": { "type": "integer", "format": "int32", "nullable": true }, "homepage": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "privatePerson": { "type": "boolean" }, "languageId": { "maxLength": 5, "minLength": 0, "type": "string" }, "locationId": { "type": "integer", "format": "int32" }, "name3": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "name4": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "name5": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "postboxZip": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "postboxCity": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "postboxCountryId": { "maxLength": 2, "minLength": 0, "type": "string", "nullable": true }, "guest": { "type": "boolean" }, "editor": { "type": "boolean" }, "author": { "type": "boolean" }, "active": { "type": "boolean" }, "favorite": { "type": "boolean" }, "deliveryBlock": { "type": "boolean" }, "callBlock": { "type": "boolean" }, "emailBlock": { "type": "boolean" }, "gln": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "eori": { "maxLength": 17, "minLength": 0, "type": "string", "nullable": true }, "keyword": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "isWebshop": { "type": "boolean" }, "isMarketplace": { "type": "boolean" }, "isHelpdesk": { "type": "boolean" }, "isNews": { "type": "boolean" }, "isWiki": { "type": "boolean" }, "isCrm": { "type": "boolean" }, "duplicateProtection": { "type": "boolean" }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "sysStartTime": { "type": "string", "format": "date-time" }, "sysEndTime": { "type": "string", "format": "date-time" }, "customerSupplierNumberConcatenated": { "maxLength": 8000, "minLength": 0, "type": "string", "nullable": true }, "isCustomer": { "type": "boolean", "nullable": true }, "customerNumber": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "customerPartnerDetailId": { "type": "integer", "format": "int32", "nullable": true }, "isSupplier": { "type": "boolean", "nullable": true }, "supplierNumber": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "supplierPartnerDetailId": { "type": "integer", "format": "int32", "nullable": true }, "country": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "partnerGroupName": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.xVIEW_ProductionPosition": { "required": [ "positionTypeId", "taskMode" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "productionId": { "type": "integer", "format": "int32" }, "rowNumber": { "type": "integer", "format": "int32" }, "positionTypeId": { "maxLength": 15, "minLength": 0, "type": "string" }, "articleProductionStepComponentTypeId": { "type": "integer", "format": "int32" }, "positionNumber": { "type": "integer", "format": "int32" }, "parentPositionId": { "type": "integer", "format": "int32", "nullable": true }, "childPositionNumber": { "type": "integer", "format": "int32", "nullable": true }, "productionStatusId": { "maxLength": 12, "minLength": 0, "type": "string", "nullable": true }, "articleId": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "name1": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "name2": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "quantityFactor": { "type": "number", "format": "double" }, "uoMId": { "type": "integer", "format": "int32", "nullable": true }, "positionQuantityPlanned": { "type": "number", "format": "double" }, "positionQuantityOpen": { "type": "number", "format": "double" }, "positionQuantityConfirmed": { "type": "number", "format": "double" }, "positionQuantityPick": { "type": "number", "format": "double" }, "positionQuantityPacked": { "type": "number", "format": "double" }, "positionQuantityIssued": { "type": "number", "format": "double" }, "positionQuantityConsumed": { "type": "number", "format": "double" }, "positionQuantityOrdered": { "type": "number", "format": "double" }, "positionQuantityAnnounced": { "type": "number", "format": "double" }, "positionQuantityCompleted": { "type": "number", "format": "double" }, "positionQuantityScrap": { "type": "number", "format": "double" }, "positionPlannedStart": { "type": "string", "format": "date-time", "nullable": true }, "positionPlannedEnd": { "type": "string", "format": "date-time", "nullable": true }, "positionActualStart": { "type": "string", "format": "date-time", "nullable": true }, "positionActualEnd": { "type": "string", "format": "date-time", "nullable": true }, "positionSetupSeconds": { "type": "integer", "format": "int32", "nullable": true }, "positionRunSeconds": { "type": "integer", "format": "int32", "nullable": true }, "positionDowntimeSeconds": { "type": "integer", "format": "int32", "nullable": true }, "positionPauseSeconds": { "type": "integer", "format": "int32", "nullable": true }, "lastBdeState": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "lastBdeStateAt": { "type": "string", "format": "date-time", "nullable": true }, "costPricePerUnit": { "type": "number", "format": "double" }, "costPriceTotal": { "type": "number", "format": "double" }, "level": { "type": "integer", "format": "int32", "nullable": true }, "positionLabel": { "maxLength": 30, "minLength": 0, "type": "string", "nullable": true }, "dissolve": { "type": "boolean" }, "relatedPositionId": { "type": "integer", "format": "int32", "nullable": true }, "subTaskId": { "type": "integer", "format": "int32", "nullable": true }, "progress": { "type": "integer", "format": "int32", "nullable": true }, "predecessorTask": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "taskMode": { "maxLength": 6, "minLength": 0, "type": "string" }, "secondsOffset": { "type": "integer", "format": "int32", "nullable": true }, "warehousingEffectiveId": { "type": "integer", "format": "int32", "nullable": true }, "pending": { "type": "boolean" }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "viewRowNumber": { "type": "integer", "format": "int32" }, "formattedQuantity": { "maxLength": 4000, "minLength": 0, "type": "string", "nullable": true }, "positionNumberConcat": { "maxLength": 21, "minLength": 0, "type": "string", "nullable": true }, "viewNowAvailable": { "type": "number", "format": "double", "nullable": true }, "productionNumber": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "positionTypeName": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "stock": { "type": "number", "format": "double", "nullable": true }, "confirmed": { "type": "number", "format": "double", "nullable": true }, "packed": { "type": "number", "format": "double", "nullable": true }, "ordered": { "type": "number", "format": "double", "nullable": true }, "announced": { "type": "number", "format": "double", "nullable": true }, "nowAvailable": { "type": "number", "format": "double", "nullable": true }, "laterAvailable": { "type": "number", "format": "double", "nullable": true }, "minimumStock": { "type": "number", "format": "double", "nullable": true }, "maximumStock": { "type": "number", "format": "double", "nullable": true }, "individualizationTypeId": { "maxLength": 6, "minLength": 0, "type": "string", "nullable": true }, "decimalPlacesQuantitiesId": { "type": "integer", "format": "int32", "nullable": true }, "minimumQuantity": { "type": "number", "format": "double", "nullable": true }, "deliveryTime": { "type": "integer", "format": "int32", "nullable": true }, "lotSize": { "type": "number", "format": "double", "nullable": true }, "percentageMarkup1": { "type": "number", "format": "double", "nullable": true }, "fixedMarkup1": { "type": "number", "format": "double", "nullable": true }, "intermediateCalculatedSalesPrice": { "type": "number", "format": "double", "nullable": true }, "percentageMarkup2": { "type": "number", "format": "double", "nullable": true }, "fixedMarkup2": { "type": "number", "format": "double", "nullable": true }, "calculatedSalesPrice": { "type": "number", "format": "double", "nullable": true }, "procurementPrice": { "type": "number", "format": "double", "nullable": true }, "factor": { "type": "number", "format": "double", "nullable": true }, "warehouseCost": { "type": "number", "format": "double", "nullable": true }, "overheadCost": { "type": "number", "format": "double", "nullable": true }, "otherCost": { "type": "number", "format": "double", "nullable": true }, "changeInValue": { "type": "number", "format": "double", "nullable": true }, "costPrice": { "type": "number", "format": "double", "nullable": true }, "uoMName": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "productionDurationUnitId": { "maxLength": 1, "minLength": 0, "type": "string", "nullable": true }, "parentWithSet": { "type": "boolean", "nullable": true }, "parentWithMacro": { "type": "boolean", "nullable": true }, "parentWithAccessory": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models.xVIEW_SmartPool": { "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "tags": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "fileName": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "fileType": { "maxLength": 75, "minLength": 0, "type": "string", "nullable": true }, "fileDate": { "type": "string", "format": "date-time", "nullable": true }, "fileSizeMb": { "type": "integer", "format": "int64", "nullable": true }, "version": { "type": "integer", "format": "int32" }, "duplicate": { "type": "boolean", "nullable": true }, "ocrProcessing": { "type": "boolean", "nullable": true }, "embeddingProcessing": { "type": "boolean", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32", "nullable": true }, "dateModified": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "integer", "format": "int32", "nullable": true }, "createdByMatchcode": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true } }, "additionalProperties": false }, "XERP.Shared.Models_MasterDb.License": { "required": [ "city", "country", "licenseOwner", "street", "zip" ], "type": "object", "properties": { "recState": { "$ref": "#/components/schemas/X_ERP_Common.RecState" }, "id": { "type": "integer", "format": "int32" }, "licenseOwner": { "maxLength": 100, "minLength": 0, "type": "string" }, "street": { "maxLength": 100, "minLength": 0, "type": "string" }, "zip": { "maxLength": 50, "minLength": 0, "type": "string" }, "city": { "maxLength": 100, "minLength": 0, "type": "string" }, "country": { "maxLength": 100, "minLength": 0, "type": "string" }, "allowedUsers": { "type": "integer", "format": "int32", "nullable": true }, "licenseType": { "maxLength": 10, "minLength": 0, "type": "string", "nullable": true }, "licenseKey": { "type": "string", "nullable": true }, "validFrom": { "type": "string", "format": "date-time", "nullable": true }, "validTo": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "X_ERP_Common.EmailFolderIds": { "enum": [ 1, 2, 3, 4, 5, 6 ], "type": "integer", "format": "int32" }, "X_ERP_Common.PhoneFolderIds": { "enum": [ 1, 2, 3, 4, 5 ], "type": "integer", "format": "int32" }, "X_ERP_Common.RecState": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" } }, "securitySchemes": { "XerpSession": { "type": "apiKey", "description": "Session cookie issued by WebApiLogin. This is not a bearer token. Use a cookie-aware HTTP client; browser tools cannot manually set the Cookie header.", "name": "X-ERPAppAuthCookie", "in": "cookie" } } }, "security": [ { "XerpSession": [ ] } ], "tags": [ { "name": "AdminApiAuthType" }, { "name": "AdminBank" }, { "name": "AdminBankAccountEBankingType" }, { "name": "AdminCompanySetting" }, { "name": "AdminCountry" }, { "name": "AdminCurrency" }, { "name": "AdminCurrencyApi" }, { "name": "AdminCurrencyRate" }, { "name": "AdminDecimalPlace" }, { "name": "AdminEDocType" }, { "name": "AdminFederalState" }, { "name": "AdminFiscalPeriod" }, { "name": "AdminLanguage" }, { "name": "AdminLocation" }, { "name": "AdminMonth" }, { "name": "AdminProgramAiLanguage" }, { "name": "AdminProgramSetting" }, { "name": "AdminRoute" }, { "name": "AdminSvg" }, { "name": "AdminTimeZone" }, { "name": "AdminYear" }, { "name": "AdminZip" }, { "name": "AI" }, { "name": "AiChatInfo" }, { "name": "AiChatSetting" }, { "name": "AiEmailInfo" }, { "name": "AiEmbedding" }, { "name": "AiTextInfo" }, { "name": "AppRole" }, { "name": "AppUser" }, { "name": "Archive" }, { "name": "ArchiveDunning" }, { "name": "Article" }, { "name": "ArticleAccessory" }, { "name": "ArticleCategory" }, { "name": "ArticleCategoryName" }, { "name": "ArticleCost" }, { "name": "ArticleDimensionText" }, { "name": "ArticleEInvoiceUoM" }, { "name": "ArticleGroup" }, { "name": "ArticleIndividualization" }, { "name": "ArticleIndividualizationQuantity" }, { "name": "ArticleIndividualizationType" }, { "name": "ArticleInfoText" }, { "name": "ArticleMacro" }, { "name": "ArticleOrderText" }, { "name": "ArticlePicture" }, { "name": "ArticlePriceCalculation" }, { "name": "ArticlePriceUnit" }, { "name": "ArticleProcurementType" }, { "name": "ArticleProduct" }, { "name": "ArticleProductDependencyType" }, { "name": "ArticleProductionStepComponent" }, { "name": "ArticleProductionStepComponentType" }, { "name": "ArticleProductionStepResource" }, { "name": "ArticleQuantity" }, { "name": "ArticleSalesPriceList" }, { "name": "ArticleSalesPriceListName" }, { "name": "ArticleSet" }, { "name": "ArticleTemplate" }, { "name": "ArticleType" }, { "name": "ArticleUoM" }, { "name": "ArticleUoMConversion" }, { "name": "Attachment" }, { "name": "AttachmentFile" }, { "name": "AttachmentStatus" }, { "name": "AuthorizationPage" }, { "name": "AuthorizationWebApi" }, { "name": "Bulletin" }, { "name": "BulletinCategory" }, { "name": "BulletinRead" }, { "name": "CalendarAppointment" }, { "name": "CalendarAppointmentAttachment" }, { "name": "CalendarAppointmentCategory" }, { "name": "CalendarHoliday" }, { "name": "CalendarName" }, { "name": "CalendarWeekDay" }, { "name": "CalendarWorkingDay" }, { "name": "ClientLog" }, { "name": "CountryPackageDatevExport" }, { "name": "CountryPackageElsterExport" }, { "name": "CountryPackageIntrastatArticle" }, { "name": "CountryPackageIntrastatCommodityCode" }, { "name": "CountryPackageIntrastatDeclaration" }, { "name": "CountryPackageIntrastatDeclarationPosition" }, { "name": "CountryPackageIntrastatDeclarationStatus" }, { "name": "CountryPackageIntrastatDirection" }, { "name": "CountryPackageIntrastatDocPosition" }, { "name": "CountryPackageIntrastatPartner" }, { "name": "CountryPackageIntrastatReportingEntity" }, { "name": "CountryPackageIntrastatTransactionType" }, { "name": "CountryPackageIntrastatTransportMode" }, { "name": "CountryPackagePrivacyProcessingActivity" }, { "name": "CountryPackagePrivacyProcessingActivityObject" }, { "name": "Crm" }, { "name": "CrmActivity" }, { "name": "CrmActivityType" }, { "name": "CrmGroup" }, { "name": "CrmStatus" }, { "name": "CrmType" }, { "name": "CspReport" }, { "name": "Dashboard" }, { "name": "DashboardCashflow" }, { "name": "DeviceService" }, { "name": "Doc" }, { "name": "DocApproval" }, { "name": "DocBillingAddress" }, { "name": "DocCategory" }, { "name": "DocContract" }, { "name": "DocContractCyclePeriod" }, { "name": "DocContractStatus" }, { "name": "DocDeliveryAddress" }, { "name": "DocFooterText" }, { "name": "DocHeaderText" }, { "name": "DocPosition" }, { "name": "DocPositionDimensionText" }, { "name": "DocPositionInfoText" }, { "name": "DocPositionOrderText" }, { "name": "DocPositionStatus" }, { "name": "DocPositionType" }, { "name": "DocPositionWarehousing" }, { "name": "DocStatus" }, { "name": "DocType" }, { "name": "DocTypeInventoryStatus" }, { "name": "DocTypePrepaymentFactor" }, { "name": "DocTypeRevenueEffective" }, { "name": "DocTypeWarehousingEffective" }, { "name": "DocXml" }, { "name": "DocXmlAssignment" }, { "name": "DocXmlPosition" }, { "name": "Email" }, { "name": "EmailAccount" }, { "name": "EmailAttachment" }, { "name": "EmailFolder" }, { "name": "EmailLog" }, { "name": "EmailRuleField" }, { "name": "EmailRuleIn" }, { "name": "EmailRuleOut" }, { "name": "EmailSignature" }, { "name": "EmailSignatureAttachment" }, { "name": "EmailSpamProtectionSender" }, { "name": "EmailSpamProtectionSubject" }, { "name": "EmailSystem" }, { "name": "EmailTemplate" }, { "name": "EmailTemplateAttachment" }, { "name": "EmailTemplateGroup" }, { "name": "Employee" }, { "name": "EmployeeCommissionGroup" }, { "name": "EmployeeCommissionGroupName" }, { "name": "EmployeeGroup" }, { "name": "EmployeeVacationEntitlement" }, { "name": "EmployeeVacationRequest" }, { "name": "EmployeeVacationRequestApproval" }, { "name": "EmployeeVacationType" }, { "name": "EmployeeVacationYear" }, { "name": "ExternalAspNetRole" }, { "name": "ExternalAspNetRoleClaim" }, { "name": "ExternalAspNetUser" }, { "name": "ExternalAspNetUserClaim" }, { "name": "ExternalAspNetUserLogin" }, { "name": "ExternalAspNetUserToken" }, { "name": "ExternalAuthorizationPage" }, { "name": "ExternalAuthorizationRolePagePermission" }, { "name": "ExternalAuthorizationRoleWebApiPermission" }, { "name": "ExternalAuthorizationWebApi" }, { "name": "ExtraApi" }, { "name": "ExtraCode" }, { "name": "ExtraField" }, { "name": "ExtraPage" }, { "name": "ExtraPlugin" }, { "name": "ExtraTable" }, { "name": "ExtraTableIndexType" }, { "name": "FieldService" }, { "name": "FieldServiceResource" }, { "name": "FieldServiceResourceGroup" }, { "name": "FieldServiceResourceSegment" }, { "name": "FieldServiceStatus" }, { "name": "FinanceAccountAssignment" }, { "name": "FinanceAccountCategory" }, { "name": "FinanceAccountDetermination" }, { "name": "FinanceAccountGroup" }, { "name": "FinanceAccountInternalReconciliation" }, { "name": "FinanceAccountInternalReconciliationPosition" }, { "name": "FinanceAccountPlan" }, { "name": "FinanceAccountPurpose" }, { "name": "FinanceAccountType" }, { "name": "FinanceBalanceGroup" }, { "name": "FinanceBusinessAssessmentGroup" }, { "name": "FinanceClosingPosting" }, { "name": "FinanceClosingPostingPosition" }, { "name": "FinanceCompanyBankAccount" }, { "name": "FinanceCostBearer" }, { "name": "FinanceCostCenter" }, { "name": "FinanceCostType" }, { "name": "FinanceDunning" }, { "name": "FinanceDunningLevel" }, { "name": "FinanceDunningPosition" }, { "name": "FinanceEInvoiceTaxKeyCategory" }, { "name": "FinanceFixedAsset" }, { "name": "FinanceFixedAssetClass" }, { "name": "FinanceFixedAssetDepreciationCyclePeriod" }, { "name": "FinanceFixedAssetDepreciationMethod" }, { "name": "FinanceFixedAssetDepreciationPlan" }, { "name": "FinanceFixedAssetDepreciationType" }, { "name": "FinanceFixedAssetDepreciationTypeDetail" }, { "name": "FinanceFixedAssetDetail" }, { "name": "FinanceFixedAssetGroup" }, { "name": "FinanceFixedAssetStatus" }, { "name": "FinanceGroupArticle" }, { "name": "FinanceGroupArticleDetail" }, { "name": "FinanceGroupPartner" }, { "name": "FinanceOpeningBalance" }, { "name": "FinanceOpeningBalancePosition" }, { "name": "FinanceOpenItem" }, { "name": "FinanceOpenItemInternalReconciliation" }, { "name": "FinanceOpenItemInternalReconciliationPosition" }, { "name": "FinanceOpenItemOrigin" }, { "name": "FinanceOpenItemStatus" }, { "name": "FinanceOpenItemType" }, { "name": "FinancePayment" }, { "name": "FinancePaymentPosition" }, { "name": "FinancePosting" }, { "name": "FinancePostingDraft" }, { "name": "FinancePostingPeriod" }, { "name": "FinancePostingPeriodStatus" }, { "name": "FinancePostingPosition" }, { "name": "FinancePostingPositionDraft" }, { "name": "FinancePostingPositionTemplate" }, { "name": "FinancePostingSource" }, { "name": "FinancePostingStatus" }, { "name": "FinancePostingTemplate" }, { "name": "FinanceProfitLossGroup" }, { "name": "FinanceTaxKey" }, { "name": "FinanceTaxKeyDetail" }, { "name": "FinanceTaxKeyKind" }, { "name": "FinanceTransfer" }, { "name": "FinanceTransferBankStatement" }, { "name": "FinanceTransferCategory" }, { "name": "FinanceTransferCategoryAccountType" }, { "name": "FinanceTransferPosition" }, { "name": "FinanceTransferPositionAccountPlan" }, { "name": "FinanceTransferPositionOpenItem" }, { "name": "FinanceTransferPositionTextKey" }, { "name": "FinanceTransferSuggestion" }, { "name": "FinanceTransferSuggestionField" }, { "name": "FormattedSearch" }, { "name": "FormattedSearchFireMode" }, { "name": "Helpdesk" }, { "name": "HelpdeskCategory" }, { "name": "HelpdeskDialog" }, { "name": "HelpdeskDialogProtocol" }, { "name": "HelpdeskNotification" }, { "name": "HelpdeskNotificationEvent" }, { "name": "HelpdeskPrio" }, { "name": "HelpdeskSetting" }, { "name": "HelpdeskStar" }, { "name": "HelpdeskStatusSupporter" }, { "name": "HelpdeskTopic" }, { "name": "Intercom" }, { "name": "IntercomGroup" }, { "name": "IntercomPrio" }, { "name": "IntercomRecipientStatus" }, { "name": "IntercomSenderStatus" }, { "name": "KeepAlive" }, { "name": "License" }, { "name": "Map" }, { "name": "Marketplace" }, { "name": "MarketplaceSellerArticle" }, { "name": "MarketplaceSellerPosition" }, { "name": "MarketplaceSetting" }, { "name": "MassEmail" }, { "name": "MassEmailRecipient" }, { "name": "OutputControlButton" }, { "name": "OutputControlFormat" }, { "name": "OutputControlMedium" }, { "name": "OutputControlPrinterConfiguration" }, { "name": "PackingListBox" }, { "name": "PackingListBoxPosition" }, { "name": "PackingListBoxType" }, { "name": "Partner" }, { "name": "PartnerBankAccount" }, { "name": "PartnerBillingAddress" }, { "name": "PartnerCatalogNumber" }, { "name": "PartnerCategory" }, { "name": "PartnerCategoryName" }, { "name": "PartnerContactPerson" }, { "name": "PartnerContactPersonEmailCategoryContactPerson" }, { "name": "PartnerContactPersonEmailCategoryDocType" }, { "name": "PartnerContactPersonEmailCategoryName" }, { "name": "PartnerDeliveryAddress" }, { "name": "PartnerDetail" }, { "name": "PartnerDetailBanking" }, { "name": "PartnerDetailOutput" }, { "name": "PartnerDirectDebitType" }, { "name": "PartnerDiscountGroup" }, { "name": "PartnerDiscountGroupName" }, { "name": "PartnerGroup" }, { "name": "PartnerInfo" }, { "name": "PartnerPasskey" }, { "name": "PartnerPaymentType" }, { "name": "PartnerPicture" }, { "name": "PartnerPurchasePriceList" }, { "name": "PartnerTermsOfDelivery" }, { "name": "PartnerTermsOfPayment" }, { "name": "PartnerTermsOfPaymentUNTDID" }, { "name": "PartnerToken" }, { "name": "PartnerType" }, { "name": "PhoneCall" }, { "name": "PhoneFolder" }, { "name": "PhoneLine" }, { "name": "PhoneLineEmployee" }, { "name": "PhoneLog" }, { "name": "PluginUpload" }, { "name": "PortalConroller" }, { "name": "Procurement" }, { "name": "Production" }, { "name": "ProductionDataAcquisition" }, { "name": "ProductionDataAcquisitionReasonCode" }, { "name": "ProductionDataAcquisitionStatus" }, { "name": "ProductionDataAcquisitionWorkplace" }, { "name": "ProductionDataAcquisitionWorkplaceStatus" }, { "name": "ProductionDurationUnit" }, { "name": "ProductionPosition" }, { "name": "ProductionPositionResource" }, { "name": "ProductionPositionResourceGroup" }, { "name": "ProductionPositionType" }, { "name": "ProductionPositionWarehousing" }, { "name": "ProductionStatus" }, { "name": "Project" }, { "name": "ProjectDependencyType" }, { "name": "ProjectStatus" }, { "name": "ReportTemplate" }, { "name": "ReportType" }, { "name": "Resource" }, { "name": "ResourceGroup" }, { "name": "ServerInfo" }, { "name": "ShippingCarrier" }, { "name": "ShippingRate" }, { "name": "ShippingType" }, { "name": "ShippingZone" }, { "name": "SmartPool" }, { "name": "SmartPoolApproval" }, { "name": "SmartPoolLinkedEntity" }, { "name": "SmartPoolOcr" }, { "name": "SmartSearch" }, { "name": "StickyNote" }, { "name": "SupportSetting" }, { "name": "SystemDatabaseChangeLog" }, { "name": "SystemDatabaseLanguage" }, { "name": "SystemDataType" }, { "name": "SystemDesktop" }, { "name": "SystemDesktopColumn" }, { "name": "SystemKeyCombination" }, { "name": "SystemMapping" }, { "name": "SystemMappingFileType" }, { "name": "SystemMappingFormatName" }, { "name": "SystemMappingSystemColumn" }, { "name": "SystemTable" }, { "name": "SystemTableField" }, { "name": "SystemVersion" }, { "name": "SystemView" }, { "name": "TextBlock" }, { "name": "TextBlockGroup" }, { "name": "TextVariable" }, { "name": "TimeTracking" }, { "name": "TimeTrackingSetting" }, { "name": "ToolboxButton" }, { "name": "ToolboxField" }, { "name": "TranslationArticleInfoText" }, { "name": "TranslationArticleName1" }, { "name": "TranslationArticleName2" }, { "name": "TranslationArticleOrderText" }, { "name": "TranslationArticleUoM" }, { "name": "TranslationDocType" }, { "name": "Warehouse" }, { "name": "WarehouseBinLocation" }, { "name": "WarehouseInfo" }, { "name": "WarehouseInventoryCounting" }, { "name": "WarehouseInventoryCountingPosition" }, { "name": "WarehouseInventoryRevaluation" }, { "name": "WarehouseInventoryRevaluationPosition" }, { "name": "WarehouseMedium" }, { "name": "WarehouseQuantity" }, { "name": "WarehouseTransfer" }, { "name": "WarehouseTransferPosition" }, { "name": "WarehouseType" }, { "name": "WebApiUser" }, { "name": "Webshop" }, { "name": "WebshopActivityLog" }, { "name": "WebshopCss" }, { "name": "WebshopIcon" }, { "name": "WebshopSetting" }, { "name": "WebshopUserCart" }, { "name": "Wiki" }, { "name": "WikiCategory" }, { "name": "WikiStatus" }, { "name": "WorkspaceRoleDesktop" }, { "name": "WorkspaceRoleDesktopButton" }, { "name": "WorkspaceRoleMenu" }, { "name": "WorkspaceRoleMenuButton" }, { "name": "WorkspaceUserColumnSetting" }, { "name": "WorkspaceUserFieldSetting" }, { "name": "xVIEW_Article" }, { "name": "xVIEW_Doc" }, { "name": "xVIEW_Employee" }, { "name": "xVIEW_Partner" }, { "name": "xVIEW124_ArticlePositionQuantityOpenSum" }, { "name": "xVIEW124_ArticleProductionPositionQuantityOpenSum" }, { "name": "xVIEW124_ArticleQuantityInventorySum" }, { "name": "xVIEW125_ArticleHistoryTable" }, { "name": "xVIEW139_ArticleIndividualizationQuantityHistory" }, { "name": "xVIEW140_ArticleQuantityHistoryTable" }, { "name": "xVIEW150_PartnerJoinCustomer" }, { "name": "xVIEW150_PartnerJoinPartnerDetail" }, { "name": "xVIEW150_PartnerJoinSupplier" }, { "name": "xVIEW150_PartnerPurchasePriceListHistoryTable" }, { "name": "xVIEW180_EmployeeVacationEntitlementHistoryTable" }, { "name": "xVIEW181_EmployeeVacationEntitlement" }, { "name": "xVIEW193_WarehouseQuantityHistoryTable" }, { "name": "xVIEW200_DocTypeSequence" }, { "name": "xVIEW216_Doc_DeviceService" }, { "name": "xVIEW360_MarketplaceSellerPosition" }, { "name": "xVIEW500_WarehouseInventoryList" }, { "name": "xVIEW501_WarehouseInventoryIndividualized" }, { "name": "xVIEW552_ProcurementPurchase" }, { "name": "xVIEW554_ProcurementProduction" }, { "name": "xVIEW600_FinancePostingDraft" }, { "name": "xVIEW600_FinancePostingList" }, { "name": "xVIEW600_FinancePostingPositionDraft" }, { "name": "xVIEW605_FinanceAccountPlan" }, { "name": "xVIEW660_FinanceTransferPosition" }, { "name": "xVIEW670_DueAndOverDue" }, { "name": "xVIEW821_CountryPackageIntrastatCandidate" }, { "name": "XXField" }, { "name": "XXTable" }, { "name": "DatabaseBackup" }, { "name": "Maintenance" } ] }